REST API

Stations

Named check-in points such as gates or entrances. Resolves the station_id on an arrival to a name.

A station is a named check-in point: a gate, an entrance, a will-call desk. Every arrival records the station it was handled at, so this endpoint is what turns a station_id into something you can put on a dashboard.

Stations are created in the Guest Manager dashboard, and one is created automatically for each Shopify POS location the first time it is used. They are read-only through the API.

Bear in mind that an arrival’s station_id may be null. Shopify POS always records a station, while the iPad scanner and web check-in only do so when one has been chosen.

Default response fields

id, name, created_at, updated_at.

List stations

GET /stations

curl -X GET \
  'https://app.guestmanager.com/api/public/v2/stations?page[cursor]=' \
  -H 'Authorization: Token abcdefg' \
  -H 'Content-Type: application/json'

Request parameters

Parameter Type Description
page[cursor] string Opaque cursor token. Send empty for the first page. See Pagination.
page[size] integer Records per page. Default 10, maximum 100.
sort[{field}] string Sort by id, created_at, updated_at, name. Value is asc or desc.

Get station

GET /stations/{id}

curl -X GET \
  'https://app.guestmanager.com/api/public/v2/stations/1040' \
  -H 'Authorization: Token abcdefg' \
  -H 'Content-Type: application/json'