Sign in
CheckIns

List Check-ins

Retrieves a list of all check-ins, optionally filtered by customer, site, date range and method.

get/customers/check-ins

Query parameters

customer_idstring[]

The customer IDs to filter check-ins by

site_idstring

The site ID to filter check-ins by

date_fromstring

Filter check-ins and check-outs that happened on or after the given datetime.

date_tostring

Filter check-ins and check-outs that happened on or before the given datetime.

checked_in_at_fromstring

Filter check-ins that happened on or after the given datetime.

checked_in_at_tostring

Filter check-ins that happened on or before the given datetime.

method_idstring

Filter check-ins that were created by the given method ID.

method_type'gantner'

Filter check-ins that were created by the given method type.

pageinteger

The page to retrieve results from

per_pageinteger

The number of results to return per page

Response

The check-ins were successfully retrieved

Example response

{
  "data": [
    {
      "id": "000000-000000-000000-000000",
      "customer": {
        "id": "000000-000000-000000-000000",
        "first_name": "John",
        "last_name": "Smith",
        "full_name": "John Smith",
        "email": "john@example.com"
      },
      "membership_id": "000000-000000-000000-000000",
      "site_id": "000000-000000-000000-000000",
      "method": {
        "name": "Scanned"
      },
      "source": "kiosk",
      "checked_in_at": "2021-01-01T00:00:00.000Z",
      "checked_out_at": "2021-01-01T00:00:00.000Z"
    }
  ],
  "meta": {
    "from": 1,
    "to": 2,
    "total": 2,
    "current_page": 1,
    "last_page": 2,
    "per_page": 15,
    "path": "http://example.com/api"
  },
  "links": {
    "first": "http://example.com?page=1",
    "next": "https://example.com?page=3",
    "prev": "https://example.com?page=1",
    "last": "https://example.com?page=4"
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.