Introduction

Check-in API endpoint

https://checkin.tito.io/

Examples in this documentation are written using curl.

The Check-in API is designed to be a predictable and intuitive interface for programmatic access to check-in workflow within Tito. This API can be used to manage and customize the check-in process for your events.

The Check-in Tito API is a REST API and returns JSON responses.

We hope by providing an API it will allow developers to build cool and useful tools on top of Tito.

Authentication

curl --request GET \
  --url 'https://checkin.tito.io/checkin_lists/...' \
  --header 'Accept: application/json'

Unlike other Tito APIs the Tito Check-in API is not authenticated. Instead each request to the Tito Check-In API must include the Check-In List slug in the URL.

To find the Check-In List slug:

Go to your event dashboard.
Select Check-In Lists.
Select the check-in list you want to use.
Click Check-in Apps.
Click Web Check-in.

A URL will be shown e.g.

https://checkin.tito.io/checkin_lists/chk_xxxx.

In this case the Check-in List slug is chk_xxxx.

Pagination

Pass ?page=N to tickets, answers and checkins for pagination.

The following returns a JSON of all tickets on page one:

GET https://checkin.tito.io/checkin_lists/:checkin_list_slug/tickets?page=1

Pagination information for tickets, answers and checkins can be retrieved by fetching the check-in list. The total number of pages for each paginated resource is specified by the following attributes:

total_pages (deprecated) - the total number of pages of tickets.
total_ticket_pages - the total number of pages of tickets.
total_checkin_pages - the total number of pages of check-ins.
total_answer_pages - the total number of pages of answers.

Each page is limited to a maximum of 1000 items.

Since

Pass the ?since=N to tickets, answers and checkins to get any resources that have been updated since the given timestamp. For pagination information the ?since=N can be passed to the:

GET https://checkin.tito.io/checkin_lists/<checkin list slug> endpoint.

Check-in Lists

Check-in Lists allow you to check your attendees in at the venue of your event.

Create a master check-in list for all attendees or create special lists just for particular ticket types.

Get a Check-in List

curl --request GET \
  --url 'https://checkin.tito.io/checkin_lists/:checkin_list_slug' \
  --header 'Accept: application/json'

{
  "id": 111111,
  "title": "Biscuit Box Checkin",
  "slug": "xxxx",
  "expires_at": null,
  "show_company_name": false,
  "show_email": true,
  "show_phone_number": true,
  "total_pages": 1,
  "total_ticket_pages": 1,
  "tickets_count": 7,
  "answers_count": 0,
  "total_answer_pages": 0,
  "questions_count": 0,
  "total_checkin_pages": 1,
  "checkins_count": 6,
  "account": {
    "slug": "biscuit-box",
    "name": "Biscuit Box"
  },
  "event": {
    "slug": "2018",
    "title": "2018"
  }
}

Retrieves a Check-in List.

GET https://checkin.tito.io/checkin_lists/:checkin_list_slug

checkin_list_slug - The slug attribute of a Check-in List.

Check-ins

A Checkin is when an attendee with a ticket arrives at your venue and you would like to record their attendence.

Attributes

Attribute	Type	Description
created_at	`datetime`	The date the `Checkin` was created
deleted_at	`datetime`	The date the checkin was deleted.
id	`integer`	The identifier of the `Checkin`
ticket_id	`integer`	The `id` of the ticket that was checked-in.
ticket_reference	`string`	The `reference` of the ticket that was checked-in.
updated_at	`datetime`	The date the `Checkin` was last updated.
uuid	`string`	The universally unique identifier of the `Checkin`.

Get all Check-ins

curl --request GET \
  --url 'https://checkin.tito.io/checkin_lists/:checkin_list_slug/checkins' \
  --header 'Accept: application/json'

[
  {
    "id": 111111,
    "uuid": "1111b6x1-8083-49e9-916a-b8d324e2bd52",
    "created_at": "2018-06-18T09:35:39.000Z",
    "updated_at": "2018-06-18T09:35:39.000Z",
    "ticket_id": 123456,
    "deleted_at": null
  }
]

Retrieves all Checkins for the given CheckinList.

GET https://checkin.tito.io/checkin_lists/:checkin_list_slug/checkins

checkin_list_slug - The slug attribute of a CheckinList.

Create a Check-in

curl --request POST \
  --url 'https://checkin.tito.io/checkin_lists/:checkin_list_slug/checkins' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"checkin":{"ticket_id":111111}}'

{
  "id":12345,
  "ticket_id":111111,
  "created_at":"2018-11-30T12:03:51.000Z",
  "updated_at":"2018-11-30T12:03:51.000Z",
  "deleted_at":null,
  "uuid":"e169x65x-ca51-4e9f-9d48-32e5819eb2b3",
  "ticket":{
    "slug":"abc123",
    "reference":"ABCD-1",
    "email":"alice@example.com",
    "first_name":"Alice",
    "last_name":"Example"
  },
  "release":{
    "slug":"early-bird",
    "title":"Early Bird"
  }
}

Create a new Checkin belonging to the given CheckinList.

POST https://checkin.tito.io/checkin_lists/:checkin_list_slug/checkins

checkin_list_slug - The slug attribute of a CheckinList.

Parameters

You must pass in one of either ticket_id or ticket_reference.

Parameter	Type	Description
ticket_id	`integer`	The `id` of the ticket that was checked-in.
ticket_reference	`string`	The `reference` of the ticket that was checked-in.

Create many Check-ins

curl --request POST \
  --url 'https://checkin.tito.io/checkin_lists/:checkin_list_slug/checkins' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"batch":{"checkins":{"0":{"ticket_id":111111},"1":{"ticket_id":222222}}}}'

[
  {
    "id":123456,
    "ticket_id":111111,
    "created_at":"2018-11-30T12:03:51.000Z",
    "updated_at":"2018-11-30T12:03:51.000Z",
    "deleted_at":null,
    "uuid":"e169x65x-ca51-4e9f-9d48-04b680ff9382",
    "ticket":{
      "slug":"abc123",
      "reference":"ABCD-1",
      "email":"alice@example.com",
      "first_name":"Alice",
      "last_name":"Example"
    },
    "release":{
      "slug":"early-bird",
      "title":"Early Bird"
    }
  },
  {
    "id":123457,
    "ticket_id":111111,
    "created_at":"2018-11-30T12:03:51.000Z",
    "updated_at":"2018-11-30T12:03:51.000Z",
    "deleted_at":null,
    "uuid":"e169x65x-ca51-4e9f-9d48-32e5819eb2b3",
    "ticket":{
      "slug":"abc124",
      "reference":"ABCD-2",
      "email":"bob@example.com",
      "first_name":"Bob",
      "last_name":"Example"
    },
    "release":{
      "slug":"early-bird",
      "title":"Early Bird"
    }
  }
]

Create many new Checkins belonging to the given CheckinList.

POST https://checkin.tito.io/checkin_lists/:checkin_list_slug/checkins

checkin_list_slug - The slug attribute of a CheckinList.

Delete a Check-in

curl --request DELETE \
  --url 'https://checkin.tito.io/checkin_lists/:checkin_list_slug/checkins/:checkin_uuid' \
  --header 'Accept: application/json'

{
  "id":111111,
  "uuid":"1111b6x1-8083-49e9-916a-b8d324e2bd52",
  "created_at":"2018-06-18T09:35:39.000Z",
  "updated_at":"2018-11-30T11:36:54.000Z",
  "ticket_id":12345,
  "deleted_at":"2018-11-30T11:36:54.000Z"
}

Delete a Checkin belonging to the given CheckinList.

DELETE https://checkin.tito.io/checkin_lists/:checkin_list_slug/checkins/:checkin_uuid

checkin_list_slug - The slug attribute of a CheckinList.
checkin_uuid - The uuid attribute of a Checkin.

Tickets

Get all Tickets

curl --request GET \
  --url 'https://checkin.tito.io/checkin_lists/:checkin_list_slug/tickets' \
  --header 'Accept: application/json'

Retrieves all Tickets for the given CheckinList.

GET https://checkin.tito.io/checkin_lists/:checkin_list_slug/tickets

checkin_list_slug - The slug attribute of a Check-in List.

Get a Ticket

curl --request GET \
  --url 'https://checkin.tito.io/checkin_lists/:checkin_list_slug/tickets/:ticket_slug' \
  --header 'Accept: application/json'

Retrieves a Ticket for the given CheckinList.

GET https://checkin.tito.io/checkin_lists/:checkin_list_slug/tickets/:ticket_slug

checkin_list_slug - The slug attribute of a Check-in List.
ticket_slug - The slug attribute of a Ticket.

Questions

Get all Questions

curl --request GET \
  --url 'https://checkin.tito.io/checkin_lists/:checkin_list_slug/questions' \
  --header 'Accept: application/json'

Retrieves all Questions asked when purchasing a Ticket.

GET https://checkin.tito.io/checkin_lists/:checkin_list_slug/questions

checkin_list_slug - The slug attribute of a Check-in List.

Answers

Get all Answers

curl --request GET \
  --url 'https://checkin.tito.io/checkin_lists/:checkin_list_slug/answers' \
  --header 'Accept: application/json'

Retrieves all Answers for questions asked when purchasing a Ticket.

GET https://checkin.tito.io/checkin_lists/:checkin_list_slug/answers

checkin_list_slug - The slug attribute of a Check-in List.