Actions36
- List Actions
- Participant Actions
- Passport Actions
- Profile Actions
- Punch Pass Actions
Punch Pass → Get Single
AI-generatedOverview
This node operation retrieves a single punch pass along with its associated check-ins from the OneTap API. It is useful for scenarios where detailed information about a specific punch pass is needed, such as viewing the status, usage, and check-in history of a loyalty or punch card for a profile. For example, a business can use this to track the usage of a customer's punch pass in a loyalty program.
Use Case Examples
- Retrieve a punch pass by its ID to display its current status and check-in details in a dashboard.
- Fetch punch pass details to verify if a customer has remaining check-ins before allowing redemption.
Properties
| Name | Meaning |
|---|---|
| Passport ID | The unique identifier of the punch pass to retrieve. |
| Page | Page number to retrieve for paginated check-in data (optional). |
| Page Size | Number of items to retrieve per page for paginated check-in data (optional). |
| Additional Fields | Optional filters and sorting options for the punch pass retrieval, such as sorting field, direction, search text, and various filter criteria. |
Output
JSON
json- The punch pass object including its details and associated check-ins.
Dependencies
- OneTap API authentication credential
Troubleshooting
- Ensure the provided Passport ID is valid and exists in the OneTap system to avoid 'not found' errors.
- Check API authentication credentials if requests fail due to authorization issues.
- Verify pagination parameters (Page and Page Size) are within allowed ranges to prevent errors.