OneTap

Manage visitors, check-ins, and attendance with OneTap

Actions35

Overview

This node interacts with the OneTap API to manage punch passes associated with profiles. Specifically, the "Get Many" operation for the "Punch Pass" resource fetches multiple punch passes linked to a given profile. It supports pagination and filtering options to retrieve punch passes efficiently.

Common scenarios where this node is beneficial include:

Retrieving all punch passes for a customer loyalty program.
Fetching punch pass data for reporting or analytics.
Integrating punch pass information into workflows that automate attendance or rewards tracking.

For example, you might use this node to get all punch passes for a user profile to check their remaining punches or to display their active passes in a dashboard.

Properties

Name	Meaning
Profile ID	The unique identifier of the profile whose punch passes you want to retrieve. This is required.
Return All	Boolean flag indicating whether to return all punch passes available or limit the results to a specific page size.
Page	The page number to retrieve when not returning all results. Pagination starts at 0.
Page Size	Number of punch passes to retrieve per page (between 1 and 100). Used only if "Return All" is false.
Additional Fields	A collection of optional filters and sorting parameters: - Sort Field: Field name to sort by (e.g., "name") - Sort Direction: Ascending or Descending - Search Text: Text to search for - Search Type: Exact, Exact Ignore Case, or Partial - Filter Field: Field to filter by - Equal To / Not Equal To / Greater Than / Less Than / Contains: Various filter values - Greater Than Date / Less Than Date: Date filters (converted to Unix timestamp)

Output

The output is an array of JSON objects representing punch passes retrieved from the OneTap API. Each item corresponds to a punch pass and includes all its properties as returned by the API, such as ID, name, status, expiration, check-in limits, and associated check-ins.

No binary data output is produced by this operation.

Example output snippet (simplified):

[
  {
    "id": "punchpass123",
    "profileId": "profile456",
    "name": "Coffee Loyalty Card",
    "status": "active",
    "checkInsLimit": 10,
    "expiresAt": 1688000000,
    "checkIns": [
      { "id": "checkin789", "date": 1687000000 }
    ]
  },
  ...
]

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/passports/punch-passports.
No additional external dependencies are needed.

Troubleshooting

Empty Results: If no punch passes are returned, verify that the provided Profile ID is correct and that punch passes exist for that profile.
Pagination Issues: When "Return All" is false, ensure that the "Page" and "Page Size" parameters are set correctly to avoid missing data.
Date Filters: Date filters must be valid date-time strings; invalid dates may cause errors or unexpected filtering.
API Errors: Common error messages may relate to authentication failures (invalid API key), missing required parameters (Profile ID), or rate limiting by the API. Check credentials and parameter values.
Network Issues: Ensure network connectivity to the OneTap API endpoint.

Links and References

OneTap API Documentation (general reference for API endpoints and data structures)
n8n documentation on HTTP Request Authentication for setting up API credentials

OneTapInstall