---
canonical_url: "https://docs.composio.dev/toolkits/onetapcheckin"
markdown_url: "https://docs.composio.dev/toolkits/onetapcheckin.md"
product: "platform"
version: null
last_updated: null
---

# OneTapCheckIn

OneTapCheckIn helps organizations manage events, attendee profiles, check-ins, passports, integrations, and attendance alerts.

- **Category:** event management
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 19
- **Triggers:** 0
- **Slug:** `ONETAPCHECKIN`
- **Version:** 00000000_00

## Tools

### Add Participants

**Slug:** `ONETAPCHECKIN_ADD_PARTICIPANTS`

Add 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `source` | string | No | Source label stored on created participant records. |
| `list_ids` | array | Yes | Target list IDs. |
| `profile_ids` | array | Yes | Existing profile IDs to add. |
| `prevent_duplicates` | boolean | No | Prevent creating duplicate participant records. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create List

**Slug:** `ONETAPCHECKIN_CREATE_LIST`

Create 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

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Profile

**Slug:** `ONETAPCHECKIN_CREATE_PROFILE`

Create 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

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Profiles

**Slug:** `ONETAPCHECKIN_CREATE_PROFILES`

Create 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `profiles` | array | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete List

**Slug:** `ONETAPCHECKIN_DELETE_LIST`

Permanently 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `list_id` | string | Yes | Exact ID of the single list to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Profile

**Slug:** `ONETAPCHECKIN_DELETE_PROFILE`

Permanently 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `profile_id` | string | Yes | Exact ID of the single profile to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Find Lists

**Slug:** `ONETAPCHECKIN_FIND_LISTS`

Get one list by exact ID or search the connected organization's lists. Search returns one page and a continuation cursor.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Find Participants

**Slug:** `ONETAPCHECKIN_FIND_PARTICIPANTS`

Get 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `list_ids` | array | No | Return participants in any of these lists. |
| `page_size` | integer | No | Maximum participant records in this page (1-1000). |
| `checked_in` | boolean | No | Filter by current checked-in state. |
| `sort_field` | string ("checkInDate" | "checkOutDate" | "createdAt" | "updatedAt" | "name" | "email" | "phone" | "checkInCode") | No | Field used to sort records. |
| `checked_out` | boolean | No | Filter by current checked-out state. |
| `next_cursor` | string | No | Continuation cursor returned by a previous search call. |
| `profile_ids` | array | No | Return participant records for these profiles. |
| `search_text` | string | No | Search participant identity fields. |
| `check_in_after` | integer | No | Only records checked in after this Unix timestamp. |
| `participant_id` | string | No | Exact participant ID. When set, other search and pagination parameters are ignored. |
| `sort_direction` | string ("ascending" | "descending") | No | Search result sort direction. |
| `check_in_before` | integer | No | Only records checked in before this Unix timestamp. |
| `check_out_after` | integer | No | Only records checked out after this Unix timestamp. |
| `check_out_before` | integer | No | Only records checked out before this Unix timestamp. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Find Profiles

**Slug:** `ONETAPCHECKIN_FIND_PROFILES`

Get one profile by ID or search profiles by identity, list, passport, or check-in code. Returns one page and a continuation cursor.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Organization

**Slug:** `ONETAPCHECKIN_GET_ORGANIZATION`

Return the organization associated with the connected API key. The response does not expose the organization's subscription tier.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Profile Custom Fields

**Slug:** `ONETAPCHECKIN_GET_PROFILE_CUSTOM_FIELDS`

Return 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Alerts

**Slug:** `ONETAPCHECKIN_LIST_ALERTS`

Return one page of organization alert and automation rules together with outbound check-in confirmation settings.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page_size` | integer | No | Maximum alert rules in this page. |
| `descending` | boolean | No | Whether to sort alert rules in descending order. |
| `next_cursor` | string | No | Continuation cursor returned by a previous call. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Passports

**Slug:** `ONETAPCHECKIN_LIST_PASSPORTS`

List 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

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove Participant

**Slug:** `ONETAPCHECKIN_REMOVE_PARTICIPANT`

Remove one participant record from its list. This deletes the list membership and attendance record, not the underlying profile.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `list_id` | string | No | Optional expected list ID for provider-side validation. |
| `participant_id` | string | Yes | Exact participant record ID to remove. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update List

**Slug:** `ONETAPCHECKIN_UPDATE_LIST`

Partially update a list. Omitted fields are preserved even though the provider uses PUT.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `date` | string | No | New start date and time in ISO 8601 format. |
| `name` | string | No | New list name. |
| `list_id` | string | Yes | List ID to update. |
| `end_date` | string | No | New end date and time in ISO 8601 format. |
| `metadata` | object | No | Replacement metadata fields supplied in this update. |
| `time_zone` | string | No | IANA timezone. |
| `description` | string | No | New list description. |
| `check_in_option` | string ("none" | "signature" | "photo" | "survey") | No | Check-in interaction mode. |
| `check_out_option` | string ("none" | "signature" | "photo" | "survey") | No | Checkout interaction mode. |
| `check_out_enabled` | boolean | No | Enable or disable checkout. |
| `is_open_registration` | boolean | No | Enable or disable open registration. |
| `open_registration_setting` | string ("open" | "closed" | "profiles") | No | Who may register for the list. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Participant

**Slug:** `ONETAPCHECKIN_UPDATE_PARTICIPANT`

Update metadata on one participant record without performing check-in or checkout. Omitted fields are preserved.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `source` | string | No | Source application label. |
| `location` | object | No | Location object with latitude and longitude. |
| `time_zone` | string | No | IANA timezone associated with the update. |
| `utc_offset` | integer | No | Timezone offset in minutes. |
| `check_in_notes` | string | No | Check-in notes; sent using the provider's accepted checkInNotes field. |
| `participant_id` | string | Yes | Participant record ID to update. |
| `check_in_method` | string ("tap" | "signature" | "survey" | "picture" | "qr-pass") | No | Recorded check-in method metadata. |
| `check_out_notes` | string | No | Checkout notes. |
| `check_out_method` | string ("tap" | "signature" | "survey" | "picture" | "qr-pass") | No | Recorded checkout method metadata. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Participant Attendance

**Slug:** `ONETAPCHECKIN_UPDATE_PARTICIPANT_ATTENDANCE`

Check 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

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Participant Attendance Batch

**Slug:** `ONETAPCHECKIN_UPDATE_PARTICIPANT_ATTENDANCE_BATCH`

Apply one shared check-in, checkout, undo check-in, or undo checkout operation to 1 to 25 participants in input order, using one provider request per item. Items execute independently: validation, not-found, and conflict failures are reported per item and do not stop later items, so partial updates are possible and successful changes are not rolled back. Authentication, rate-limit, server, unexpected client, and malformed-success failures abort the batch. Check-in never sends visitor alerts.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `operation` | string ("check_in" | "check_out" | "undo_check_in" | "undo_check_out") | Yes | Attendance transition to perform for every participant item. |
| `participants` | array | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Profile

**Slug:** `ONETAPCHECKIN_UPDATE_PROFILE`

Partially update one profile. Omitted fields are preserved even though the provider uses PUT.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | New display name. |
| `email` | string | No | New email address. |
| `notes` | string | No | New internal notes. |
| `phone` | string | No | New phone number. |
| `address` | string | No | New physical address. |
| `favorite` | boolean | No | New favorite state. |
| `profile_id` | string | Yes | Profile ID to update. |
| `check_in_code` | string | No | New unique check-in code. |
| `custom_fields` | object | No | Custom-field values to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |