REST API

Authentication

Authenticate API requests with a Token header, and manage API keys with read/write scopes.

Authentication is done through the Authorization request header. The value should be in the format Token abcdefg where abcdefg is replaced with your API Key.

Sample request

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

Sample response

{
  "id": 0,
  "name": "Your company name"
}

API keys

API Keys are created in the company dashboard under the Config menu. API keys are authorized for either read, write, or both.

API key permissions

API Keys are authorized for read, write, or both.

Attribute Allowed request methods
read GET
write POST, PATCH, DELETE