Authorization

All requests must be authenticated with an API key. Create one in your dashboard under Integrations → API, where you assign it a role and can optionally restrict it to one or more IP ranges (ip_range, in CIDR notation) and set an expiry date (expire_at).

Include the key in the Authorization header of every request as a bearer token:

Authorization: Bearer {YOUR_API_KEY}

Example

curl --request GET \
  --url https://{instance}.clym.io/api/admin/company/api-keys \
  --header 'Authorization: Bearer {YOUR_API_KEY}'

A request with a missing or invalid key returns 401; a valid key that lacks permission for the route returns 403.