OneTap icon

OneTap

Manage visitors, check-ins, and attendance with OneTap

Overview

This node interacts with the OneTap API to manage and retrieve passport data related to profiles or participants. Specifically, the "Passport" resource with the "Get Many" operation fetches multiple passport records filtered by profile ID or participant ID, with optional filtering by passport type and pagination controls.

Common scenarios include:

  • Retrieving all passes associated with a specific user profile or event participant.
  • Filtering passes by type (e.g., group passes, punch passes).
  • Paginating through large sets of passes for reporting or synchronization purposes.

Practical example:

  • An event organizer wants to list all valid passes for a particular attendee (profile) to verify access rights.
  • A system needs to sync participant passes in batches, using pagination to handle large datasets efficiently.

Properties

Name Meaning
Profile ID The identifier of the profile to fetch passports for.
Participant ID The identifier of the participant to fetch passports for.
Additional Fields Optional filters and pagination settings:
- Passport Type Filter results by a specific passport type.
- Page Page number for paginated results (zero-based).
- Page Size Number of results per page (limit per request).

Output

The output is an array of JSON objects, each representing a passport record retrieved from the OneTap API. Each item corresponds to one passport and includes all relevant passport details as returned by the API.

If no passports are found, the output may be empty or contain the raw response object.

No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential configured for the OneTap service.
  • The node makes authenticated HTTP requests to the OneTap API endpoint at https://api-beta.onetapcheckin.com/api/passports.
  • Pagination and filtering parameters are passed as query string parameters.

Troubleshooting

  • Empty results: Ensure that the provided Profile ID or Participant ID is correct and that passports exist for that entity.
  • API authentication errors: Verify that the API key credential is correctly set up and has necessary permissions.
  • Pagination issues: If expecting more results, check that the Page and Page Size parameters are set appropriately; use Page starting at 0.
  • Invalid filter values: Confirm that the Passport Type filter matches valid types recognized by the OneTap API.
  • Network or API errors: Check network connectivity and API status; error messages from the API will be surfaced by the node.

Links and References


This summary is based solely on static analysis of the provided source code and property definitions.

Discussion