OneTap icon

OneTap

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

Actions35

Overview

This node interacts with the OneTap API to manage participants in events or lists. Specifically, the "Participant" resource with the "Get Many" operation fetches multiple participant records based on various filtering, sorting, and pagination options.

Use cases include:

  • Retrieving a list of participants for an event or multiple events.
  • Filtering participants by check-in/check-out status or date ranges.
  • Searching participants by associated list names or IP addresses.
  • Sorting participants by different fields such as check-in date, name, or email.

Practical example:

  • You want to get all participants who have checked in after a certain date and sort them by their last name ascending.
  • Or you want to retrieve only 50 participants starting from the 100th record (pagination) filtered by a specific profile ID.

Properties

Name Meaning
Return All Whether to return all matching participants or limit the number of results.
Limit Maximum number of participants to return (used if Return All is false).
Skip Number of participants to skip for pagination purposes (used if Return All is false).
Additional Fields Collection of optional filters and sorting options:
- List ID Filter participants belonging to a single list ID.
- List IDs Filter participants belonging to multiple comma-separated list IDs.
- Profile ID Filter participants by a single profile ID.
- Profile IDs Filter participants by multiple comma-separated profile IDs.
- Checked In Filter participants by whether they are checked in (boolean).
- Checked Out Filter participants by whether they are checked out (boolean).
- Check-Ins After Date Filter participants who checked in after this date/time.
- Check-Ins Before Date Filter participants who checked in before this date/time.
- Check-Outs After Date Filter participants who checked out after this date/time.
- Check-Outs Before Date Filter participants who checked out before this date/time.
- IP Address Filter participants by IP address.
- Search List Query Search participants by list name.
- Sort Field Field to sort the results by. Options include: Check In Date, Check Out Date, Created At, Updated At, Name, Email, Phone, Check In Code, Last Name, Favorite.
- Sort Order Sort direction: Ascending or Descending.

Output

The output is an array of JSON objects, each representing a participant record retrieved from the OneTap API. Each item contains participant details according to the applied filters and pagination.

The structure corresponds directly to the participant data returned by the OneTap API endpoint /api/participants. It includes fields such as participant ID, associated list/profile IDs, check-in/out status and timestamps, contact information, and any other metadata provided by the API.

No binary data output is produced by this operation.

Dependencies

  • Requires an authenticated connection to the OneTap API using an API key credential configured in n8n.
  • The node makes HTTP requests to https://api-beta.onetapcheckin.com/api/participants with appropriate query parameters.
  • Proper timezone handling is expected when providing date/time filters (dates are converted to Unix timestamps).

Troubleshooting

  • Empty results: Ensure that your filter criteria (e.g., list IDs, profile IDs, date ranges) match existing participants. Also verify that pagination parameters (limit, skip) are set correctly.
  • Invalid date formats: Date/time fields must be valid ISO date strings; otherwise, the node may fail or return no results.
  • API authentication errors: Confirm that the API key credential is valid and has sufficient permissions.
  • Rate limiting or network errors: The OneTap API may throttle requests; handle errors gracefully or enable retry logic.
  • Incorrect parameter types: For example, boolean filters like "Checked In" must be true/false, not strings.

Common error message example:

  • "Failed to execute participants operation from OneTap API: <error message>" indicates an issue with the API call or parameters. Review the error message and adjust inputs accordingly.

Links and References

Discussion