Meta

Check that the API is up, which company a key belongs to, and what it may do.

• GET/v1/healthCheck the service
• GET/v1/companyGet the company
• GET/v1/api-keyGet the calling key

Check the service

GET/v1/health

Available from phase 1

Whether the API is up. Needs no scope.

Request

curl "https://api.ambula.nl/v1/health" \
  -H "Authorization: Bearer amb_live_<key>"

Response · 200

{
  "ok": true
}

Get the company

GET/v1/company

Available from phase 1

The company that owns the key: its name, the modules it has on, and its timezone. Never its settings or credentials.

Request

curl "https://api.ambula.nl/v1/company" \
  -H "Authorization: Bearer amb_live_<key>"

Response · 200

{
  "id": "co_4Tz1",
  "name": "Dierenambulance Utrecht",
  "modules": [
    "contacts",
    "runaways"
  ],
  "timezone": "Europe/Amsterdam"
}

Get the calling key

GET/v1/api-key

Available from phase 1

The key you're calling with: its company, scopes, expiry and current limits. Use it to check a key before you rely on it.

Request

curl "https://api.ambula.nl/v1/api-key" \
  -H "Authorization: Bearer amb_live_<key>"

Response · 200

{
  "id": "key_9Qw2",
  "name": "BI export",
  "company_id": "co_4Tz1",
  "scopes": [
    "rides:read",
    "conversations:read"
  ],
  "expires_at": "2027-11-09T00:00:00Z",
  "limits": {
    "read_per_minute": 120,
    "write_per_minute": 60
  }
}