OneTap icon

OneTap

Manage visitors, check-ins, and attendance with OneTap
Join our community

Actions35

Overview

This node integrates with the OneTap API to manage "lists" within an organization. Specifically, the List - Get Many operation fetches multiple lists based on various filtering, sorting, and pagination options.

Use cases include:

  • Retrieving all or a subset of attendance or visitor lists for reporting or further processing.
  • Filtering lists by type (e.g., recurring, individual), date ranges, or archived status.
  • Sorting lists by date, name, creation time, update time, or size.
  • Paginating through large numbers of lists efficiently.

Practical example: You want to retrieve all active recurring visitor lists created in the last month, sorted by their creation date descending, to generate a report or trigger follow-up workflows.

Properties

Name Meaning
Return All Whether to return all matching lists or limit the number of results.
Limit Maximum number of lists to return if not returning all. Minimum 1.
Skip Number of lists to skip for pagination (offset). Minimum 0.
Additional Fields Collection of optional filters and sorting parameters:
- Sort Field Field to sort by. Options: Date, Name, Created At, Updated At, Size.
- Sort Direction Sort order direction. Options: Ascending, Descending.
- Search Query Text query to search lists by name.
- List Type Filter by list type. Options: All, Recurring, Children, Individual, Root.
- Archived Boolean filter to include only archived or non-archived lists.
- Parent List ID Filter lists that have a specific parent list ID.
- Is Open Registration Enabled Boolean filter to include lists with open registration enabled.
- Start Date Filter lists created after this date/time.
- End Date Filter lists created before this date/time.

Output

The output is an array of JSON objects representing the lists retrieved from the OneTap API. Each object contains the list's details such as its ID, name, date, type, archived status, and other metadata fields as returned by the API.

No binary data output is produced by this operation.

Example output snippet (simplified):

[
  {
    "id": "list123",
    "name": "Weekly Meeting",
    "date": 1685000000,
    "type": "recurring",
    "archived": false,
    "createdAt": 1684000000,
    "updatedAt": 1684500000,
    "size": 25,
    ...
  },
  ...
]

Dependencies

  • Requires an authenticated connection to the OneTap API via an API key credential configured in n8n.
  • The node makes HTTP GET requests to https://api-beta.onetapcheckin.com/api/lists endpoint with appropriate query parameters.
  • No additional external dependencies.

Troubleshooting

  • Common issues:

    • Invalid or missing API credentials will cause authentication failures.
    • Providing invalid date formats in filters may result in errors or no results.
    • Requesting too many items without pagination might lead to timeouts or rate limiting.

  • Error messages:

    • "Failed to execute lists operation from OneTap API: <message>" indicates an error response from the API or network issues.
    • "Authentication failed" suggests incorrect or expired API credentials.

  • Resolutions:

    • Verify and reconfigure the API key credential.
    • Use valid ISO date strings for date filters.
    • Use pagination (Limit and Skip) or enable Return All carefully to avoid performance issues.
    • Enable "Continue On Fail" in the node settings to handle partial failures gracefully.

Links and References

Discussion