Actions35
- Profile Actions
- Passport Actions
- Punch Pass Actions
- Participant Actions
- List Actions
Overview
The node integrates with the OneTap API to manage punch passes, which are digital passes allowing multiple check-ins (e.g., loyalty cards or attendance passes). The Punch Pass - Get Single operation retrieves detailed information about a specific punch pass by its ID, including associated check-ins and metadata.
This operation is useful when you want to fetch comprehensive data about one particular punch pass, for example:
- To display punch pass details in a dashboard.
- To verify the status and usage of a punch pass before redeeming it.
- To audit or report on individual punch passes and their check-in history.
Properties
| Name | Meaning |
|---|---|
| Passport ID | The unique identifier of the punch pass to retrieve. |
| Page | Page number for paginated results (used if not returning all). |
| Page Size | Number of items per page to retrieve (pagination size limit). |
| Additional Fields | Optional filters and sorting options to refine the returned punch pass data: |
| - Sort Field | Field name to sort the results by (e.g., "name"). |
| - Sort Direction | Direction of sorting: "Ascending" or "Descending". |
| - Search Text | Text string to search within punch passes. |
| - Search Type | Type of search: "Exact", "Exact (Ignore Case)", or "Partial". |
| - Filter Field | Field name to filter by (e.g., "status"). |
| - Equal To | Filter value that must be equal to the field. |
| - Not Equal To | Filter value that must not equal the field. |
| - Greater Than | Filter for values greater than this value. |
| - Less Than | Filter for values less than this value. |
| - Contains | Filter for fields containing this substring. |
| - Greater Than Date | Filter for dates greater than this date/time. |
| - Less Than Date | Filter for dates less than this date/time. |
Output
The output JSON contains the detailed data of the requested punch pass, including but not limited to:
- Punch pass metadata such as ID, name, start and expiration dates, status, and limits.
- Associated check-ins related to the punch pass.
- Pagination info if applicable.
- Any additional fields filtered or sorted as per input parameters.
The structure corresponds directly to the OneTap API response for a single punch pass resource.
No binary data output is involved in this operation.
Dependencies
- Requires an authenticated connection to the OneTap API via an API key credential configured in n8n.
- The node uses HTTP requests to the OneTap API endpoints under
https://api-beta.onetapcheckin.com/api/passports/punch-passports. - Proper network access to the OneTap API endpoint is necessary.
Troubleshooting
- Invalid Passport ID: If the provided punch pass ID does not exist or is malformed, the API will return an error. Verify the ID correctness.
- Authentication Errors: Ensure the API key credential is valid and has sufficient permissions.
- Pagination Issues: When using pagination properties (
Page,Page Size), ensure values are within allowed ranges (page ≥ 0, pageSize between 1 and 100). - Date Filters Format: Date filters must be valid ISO date-time strings; otherwise, the request may fail or return no results.
- API Rate Limits: Excessive requests might trigger rate limiting; handle errors gracefully and consider retry logic.
- Continue On Fail: If enabled, errors for individual items will be captured in the output instead of stopping execution.
Links and References
- OneTap API Documentation (general reference for API endpoints)
- n8n HTTP Request Node Documentation (for understanding HTTP request handling)
- ISO 8601 Date Format (for date-time inputs)
This summary covers the static analysis of the node's execute method for the "Punch Pass" resource and "Get Single" operation, based on the provided source code and property definitions.