REST API

Staff

The people who operate your scanners. Resolves the staff_id on an arrival to a name.

A staff member is someone who operates a scanner. Every arrival records who handled it, so this endpoint is what turns a staff_id into a name.

Staff are managed in the Guest Manager dashboard and are read-only through the API.

Default response fields

id, name, created_at, updated_at.

List staff

GET /staff

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

GET /staff/{id}

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