Check ins

Create a check in

Creates a check in

post/v1/check_ins

Request

Request body application/x-www-form-urlencoded

check_in_atinteger

Unix timestamp for when the device checked the issued ticket. If not provided, our system will default to the current Unix timestamp.

issued_ticket_idstring required

Issued ticket identifier

local_unique_idstring

Used for safely retrying a check in without creating it multiple times. If not provided, it will be generated automatically.

quantity-1 | 1 required

-1 for check out, 1 for check in

Example request

{
  "check_in_at": 1657204364,
  "issued_ticket_id": "it_123",
  "local_unique_id": "4c2eae10-2dd7-11ed-a261-0242ac120002-b3fd6e91-334e-4d99-8cb3-322452a54b2a",
  "quantity": 1
}

Response

Successfully created a new check in

objectstring
idstring
check_in_atinteger

Timestamp of when the ticket is checked in or out

created_atinteger

Check in creation timestamp

event_idstring

The ID of the associated event

issued_ticket_idstring

The ID of the associated ticket that is to be checked in or out

local_unique_idstring

The optional unique ID that safegards from accidentally checking in multiple times

quantityinteger

in=1, out=-1

Example response

{
  "object": "check_in",
  "id": "ci_123",
  "check_in_at": 1580211492,
  "created_at": 1580211492,
  "event_id": "ev_40980",
  "issued_ticket_id": "it_50199",
  "local_unique_id": "4c2eae10-2dd7-11ed-a261-0242ac120002-b3fd6e91-334e-4d99-8cb3-322452a54b2a",
  "quantity": 1
}

Changes

No recorded changes to this operation across all 6 revisions of this API.