Skip to main content
OneTapCheckIn logo
  • Category: event management
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 19
  • Triggers: 0
  • Slug: ONETAPCHECKIN
  • Version: 20261101_00

Tools

Slug: ONETAPCHECKIN_ADD_PARTICIPANTSAdd one or more existing profiles to one or more lists without checking them in. This deliberately excludes add-all-profiles and initial attendance fields to prevent unexpectedly broad or historical mutations.

Input Parameters

string
Source label stored on created participant records.
array
required
Target list IDs.
array
required
Existing profile IDs to add.
boolean
Prevent creating duplicate participant records.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ONETAPCHECKIN_CREATE_LISTCreate an event/check-in list. The provider currently creates open registration even when disabled during creation, so this tool does not expose that unreliable flag; update the list afterward when registration must be changed.

Input Parameters

string
required
List start date and time in ISO 8601 format.
string
required
List name.
string
Internal notes for the list.
string
Optional list end date and time in ISO 8601 format.
object
Additional string metadata to store on the list.
string
Parent list ID when creating a child list.
string
IANA timezone for the list.
string
List description.
string ("tap" | "signature" | "photo" | "survey")
Required interaction at check-in.
string ("tap" | "signature" | "photo" | "survey")
Required interaction at checkout.
boolean
Whether participants can check out.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ONETAPCHECKIN_CREATE_PROFILECreate one person profile without adding it to a list. OneTapCheckIn automatically creates a global passport. This tool does not send a confirmation email.

Input Parameters

string
required
Person’s display name.
string
Person’s email address.
string
Internal profile notes.
string
Person’s phone number.
string
Source label stored with the profile.
string
Person’s physical address.
boolean
Whether to mark the profile as a favorite.
boolean
Create despite a possible duplicate; leave false unless duplicate creation is intentional.
string
Unique check-in code for the profile.
object
Profile custom-field values. Call Get Profile Custom Fields first when field definitions are unknown.
string
Optional custom barcode value.
string ("code128" | "code39" | "ean13" | "upca" | "upce")
Format of custom_barcode; only use when custom_barcode is set.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ONETAPCHECKIN_CREATE_PROFILESCreate 1 to 25 person profiles in input order using one provider request per profile. Confirmation emails are always disabled. Provider validation or conflict failures are reported per item and later profiles are still attempted, so partial creation is possible and successful creations are not rolled back. Authentication, rate-limit, server, and malformed-success failures abort the batch.

Input Parameters

array
required
Profiles to create in order. Each item requires name and may include email, phone, address, notes, favorite, custom_fields, check_in_code, custom_barcode with custom_barcode_format, force_create, and source. Each profile is created independently; provider validation or conflict failures do not stop later items.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ONETAPCHECKIN_DELETE_LISTPermanently delete one list by ID. This is intentionally limited to one known list and never invokes the provider’s bulk or delete-all operation.

Input Parameters

string
required
Exact ID of the single list to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ONETAPCHECKIN_DELETE_PROFILEPermanently delete one profile. This also removes the profile’s automatically created global passport and never invokes the provider’s bulk or delete-all operation.

Input Parameters

string
required
Exact ID of the single profile to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ONETAPCHECKIN_FIND_LISTSGet one list by exact ID or search the connected organization’s lists. Search returns one page and a continuation cursor.

Input Parameters

string
Exact list ID. When set, search filters and pagination parameters are ignored.
boolean
Filter by archived state.
integer
Return lists scheduled at or before this Unix timestamp.
string ("all" | "recurring" | "children" | "individual" | "root")
Kind of lists to return.
integer
Maximum lists in this page (1-1000).
string
Return lists containing this profile.
string ("name" | "date" | "size" | "totalGuests" | "createdAt")
Field used to sort search results.
integer
Return lists scheduled at or after this Unix timestamp.
string
Continuation cursor returned by a previous search call. Omit for the first page.
string
Filter list names by text.
string
Return child lists of this parent.
string ("ascending" | "descending")
Search result sort direction.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ONETAPCHECKIN_FIND_PARTICIPANTSGet one participant by exact ID or search attendance records by list, profile, status, text, or date range. Search returns one page and a continuation cursor.

Input Parameters

array
Return participants in any of these lists.
integer
Maximum participant records in this page (1-1000).
boolean
Filter by current checked-in state.
string ("checkInDate" | "checkOutDate" | "createdAt" | "updatedAt" | "name" | "email" | "phone" | "checkInCode")
Field used to sort records.
boolean
Filter by current checked-out state.
string
Continuation cursor returned by a previous search call.
array
Return participant records for these profiles.
string
Search participant identity fields.
integer
Only records checked in after this Unix timestamp.
string
Exact participant ID. When set, other search and pagination parameters are ignored.
string ("ascending" | "descending")
Search result sort direction.
integer
Only records checked in before this Unix timestamp.
integer
Only records checked out after this Unix timestamp.
integer
Only records checked out before this Unix timestamp.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ONETAPCHECKIN_FIND_PROFILESGet one profile by ID or search profiles by identity, list, passport, or check-in code. Returns one page and a continuation cursor.

Input Parameters

string
Return profiles associated with this list.
integer
Maximum profiles in this page.
array
Restrict the search to these profile IDs.
string
Exact profile ID. When set, the tool ignores other search and pagination parameters.
string
Continuation cursor returned by a previous search call.
string
Return the profile associated with this passport.
string
Search name, email, phone, or check-in code.
string ("exact" | "exactIgnoreCase" | "partial")
How search text is matched.
string
Filter by exact check-in code using the supported profiles endpoint.
array
Identity fields searched by search_text.
string ("ascending" | "descending")
Search result sort direction.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ONETAPCHECKIN_GET_ORGANIZATIONReturn the organization associated with the connected API key. The response does not expose the organization’s subscription tier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ONETAPCHECKIN_GET_PROFILE_CUSTOM_FIELDSReturn the organization’s configured profile custom-field definitions so an agent can use valid field names and value types when creating or updating profiles.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ONETAPCHECKIN_LIST_ALERTSReturn one page of organization alert and automation rules together with outbound check-in confirmation settings.

Input Parameters

integer
Maximum alert rules in this page.
boolean
Whether to sort alert rules in descending order.
string
Continuation cursor returned by a previous call.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ONETAPCHECKIN_LIST_PASSPORTSList one page of standard passports for exactly one profile or participant. Use next_page to continue when a full page is returned; the provider does not support an unfiltered list-all call.

Input Parameters

integer
Zero-based page number. Start at 0 and use next_page to continue.
boolean
Filter by active state.
integer
Maximum passports requested in this page (1-1000).
string
Profile whose passports to return; mutually exclusive with participant_id.
boolean
Filter for custom-barcode passports.
string
Participant whose passports to return; mutually exclusive with profile_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ONETAPCHECKIN_REMOVE_PARTICIPANTRemove one participant record from its list. This deletes the list membership and attendance record, not the underlying profile.

Input Parameters

string
Optional expected list ID for provider-side validation.
string
required
Exact participant record ID to remove.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ONETAPCHECKIN_UPDATE_LISTPartially update a list. Omitted fields are preserved even though the provider uses PUT.

Input Parameters

string
New start date and time in ISO 8601 format.
string
New list name.
string
required
List ID to update.
string
New end date and time in ISO 8601 format.
object
Replacement metadata fields supplied in this update.
string
IANA timezone.
string
New list description.
string ("none" | "signature" | "photo" | "survey")
Check-in interaction mode.
string ("none" | "signature" | "photo" | "survey")
Checkout interaction mode.
boolean
Enable or disable checkout.
boolean
Enable or disable open registration.
string ("open" | "closed" | "profiles")
Who may register for the list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ONETAPCHECKIN_UPDATE_PARTICIPANTUpdate metadata on one participant record without performing check-in or checkout. Omitted fields are preserved.

Input Parameters

string
Source application label.
object
Location object with latitude and longitude.
string
IANA timezone associated with the update.
integer
Timezone offset in minutes.
string
Check-in notes; sent using the provider’s accepted checkInNotes field.
string
required
Participant record ID to update.
string ("tap" | "signature" | "survey" | "picture" | "qr-pass")
Recorded check-in method metadata.
string
Checkout notes.
string ("tap" | "signature" | "survey" | "picture" | "qr-pass")
Recorded checkout method metadata.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ONETAPCHECKIN_UPDATE_PARTICIPANT_ATTENDANCECheck in, check out, undo check-in, or undo checkout for one known participant. These operations change attendance history; undo actions retain attachments. This tool never sends visitor alerts.

Input Parameters

string
Notes for check-in or checkout.
string ("tap" | "signature" | "survey" | "picture" | "qr-pass")
Attendance method for check-in or checkout.
string
Exact list ID associated with the participant. Required for check-in and checkout; omit for undo operations.
object
Location with latitude and longitude for check-in or checkout.
string ("check_in" | "check_out" | "undo_check_in" | "undo_check_out")
required
Attendance transition to perform.
string
IANA timezone for check-in or checkout metadata.
integer
Unix timestamp for check-in or checkout; omit to use provider current time.
integer
Timezone offset in minutes for check-in or checkout metadata.
string
required
Exact participant record ID whose attendance state will change.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ONETAPCHECKIN_UPDATE_PARTICIPANT_ATTENDANCE_BATCHApply one shared check-in, checkout, undo check-in, or undo checkout operation to 1–25 participants in input order, without requesting visitor alerts for check-in. Request validation precedes processing; eligible provider validation, not-found, and conflict errors are reported per item, while other failures abort the batch without rolling back successful changes.

Input Parameters

string ("check_in" | "check_out" | "undo_check_in" | "undo_check_out")
required
Attendance transition to perform for every participant item.
array
required
Participants to update in order. Each item requires participant_id. For check_in and check_out, each item also requires list_id and may include timestamp, method, notes, location, time_zone, and utc_offset. For undo_check_in and undo_check_out, each item must omit list_id, timestamp, method, notes, location, time_zone, and utc_offset.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ONETAPCHECKIN_UPDATE_PROFILEPartially update one profile. Omitted fields are preserved even though the provider uses PUT.

Input Parameters

string
New display name.
string
New email address.
string
New internal notes.
string
New phone number.
string
New physical address.
boolean
New favorite state.
string
required
Profile ID to update.
string
New unique check-in code.
object
Custom-field values to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not