OneTapInstall

Overview

This node integrates with the OneTap API to manage lists and related entities such as profiles, participants, passports, and punch passes. Specifically, for the List resource with the Get Single operation, it retrieves detailed information about a single list by its unique ID.

Use cases include:

• Fetching details of a specific event or attendance list.
• Retrieving metadata like name, date, description, and settings of a list.
• Accessing survey data associated with a list (via other operations).

Practical example:

• You have an event list identified by a List ID and want to get all its details to display in your app or use in further automation workflows.

Properties

Output

The output is a JSON object representing the requested list's data. It typically includes fields such as:

• id: The list's unique identifier.
• name: The name of the list.
• date: The date of the list (timestamp).
• description: Optional description of the list.
• notes: Additional notes.
• endDate: Optional end date timestamp.
• timeZone: Time zone string.
• Other configuration fields like check-in/check-out options, open registration settings, schedule, and source.

The exact structure depends on the OneTap API response for a single list but generally contains all relevant metadata about that list.

No binary data output is produced by this operation.

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.
• No additional environment variables are needed beyond the configured API authentication.

Troubleshooting

• Common issues:

  • Invalid or missing List ID will cause the API to return an error.
  • Network connectivity problems can prevent successful API calls.
  • Insufficient permissions or invalid API credentials will result in authorization errors.

• Error messages:

  • "Failed to execute lists operation from OneTap API: <message>" indicates an error returned by the API or network failure.
  • If the node is set to continue on fail, errors will be included in the output JSON under an error field.

• Resolutions:

  • Verify the List ID is correct and exists in your OneTap account.
  • Check API credentials and ensure they have proper access rights.
  • Confirm network connectivity and API endpoint availability.

Links and References

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

This summary focuses on the "List" resource with the "Get Single" operation as requested, based on static analysis of the provided source code and property definitions.