latestOpenAPI 3.1.12026-08-108026304.2 KB

7b222e8ec91c

Check ins

List check ins

Returns a paginated list of checkins

get/v1/check_ins

Query parameters

limitstring

The number of items to retrieve

event_idstring

A string representing the event ID

event_series_idstring

A string representing the event series ID

issued_ticket_idstring

A string representing the issued ticket ID

created_atinteger

Unix timestamp filter that returns items with matched created_at value.

created_at.gtinteger

Unix timestamp filter that returns items with created_at greater than given value.

created_at.gteinteger

Unix timestamp filter that returns items with created_at greater than or equal given value.

created_at.ltinteger

Unix timestamp filter that returns items with created_at less than given value.

created_at.lteinteger

Unix timestamp filter that returns items with created_at less than or equal given value.

check_in_atinteger

Unix timestamp filter that returns items with matched check_in_at value.

check_in_at.gtinteger

Unix timestamp filter that returns items with check_in_at greater than the given value.

check_in_at.gteinteger

Unix timestamp filter that returns items with check_in_at greater than or equal to the given value.

check_in_at.ltinteger

Unix timestamp filter that returns items with check_in_at less than given value.

check_in_at.lteinteger

Unix timestamp filter that returns items with check_in_at less than or equal given value.

Response

Successfully returned the list of check ins

Example response

{
  "data": [
    {
      "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
    }
  ],
  "links": {
    "next": "/v1/check_ins?starting_after=ci_123",
    "previous": "/v1/check_ins?ending_before=ci_234"
  }
}