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 various entities such as profiles, passports, punch passes, participants, and lists. Specifically, for the Passport resource with the Get by Profile operation, it fetches all passport records associated with a given profile ID. This operation is useful when you want to retrieve all passes (e.g., event or access passes) linked to a specific user profile.

Practical scenarios include:

  • Retrieving all access passes assigned to a visitor or employee profile.
  • Checking which passes are active or available for a particular profile.
  • Integrating pass data into workflows that automate check-ins or attendance tracking.

Properties

Name Meaning
Profile ID The unique identifier of the profile whose passports you want to retrieve.
Custom Barcode Boolean flag indicating whether to include custom barcode information in the response.

Output

The output is an array of JSON objects representing the passports associated with the specified profile. Each item contains the full passport data returned by the OneTap API for that profile.

  • The json field holds the passport data object(s).
  • If the "Custom Barcode" option is enabled, the response may include additional barcode-related fields.
  • No binary data output is produced by this operation.

Example output snippet (simplified):

{
  "json": {
    "id": "passport123",
    "profileId": "profile456",
    "type": "event_pass",
    "status": "active",
    "customBarcode": "XYZ123", // if requested
    ...
  }
}

Dependencies

  • Requires an API key credential for authenticating requests to the OneTap API.
  • The node uses HTTP requests to the base URL: https://api-beta.onetapcheckin.com.
  • Proper configuration of the API key credential in n8n is necessary for successful calls.

Troubleshooting

  • Common issues:

    • Invalid or missing profile ID will cause the API to return errors or empty results.
    • Network connectivity problems or incorrect API credentials will result in authentication failures.
    • Using deprecated operations (noted as DEPRECATED in the UI) might lead to unexpected behavior if the API changes.

  • Error messages:

    • "Failed to execute passports operation from OneTap API: <error message>" indicates an issue during the API call.
    • Authentication errors typically mean the API key credential is invalid or not set up.
    • Validation errors usually relate to missing required parameters like Profile ID.

  • Resolution tips:

    • Verify the Profile ID is correct and exists in your OneTap account.
    • Ensure the API key credential is configured and has proper permissions.
    • Check network access and firewall settings.
    • Review OneTap API documentation for any updates on deprecated endpoints.

Links and References

Discussion