REST API

Devices

Scanners enrolled to your account. Resolves the device_id on an arrival to a device.

A device is a scanner enrolled to your account: an iPad running the Guest Manager scanner app, a Shopify POS register, or the web check-in screen. Every arrival records the device that handled it.

Devices are enrolled through the scanner apps and are read-only through the API.

Default response fields

id, name, model, system_name, created_at, updated_at.

name is set during enrolment and may be blank on older devices. model and system_name are reported by the device itself, so they are the most reliable way to tell one kind of scanner from another.

List devices

GET /devices

curl -X GET \
  'https://app.guestmanager.com/api/public/v2/devices?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 device

GET /devices/{id}

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