API Reference · Account

Check your API key

Confirms a key works and tells you which company it belongs to and whether it is full access or read-only. It changes nothing, so it's a good first call when you set up an integration.

GET/whoami

https://calling.ubiqproject.com/api/v1/whoami · Auth: API key (full or read-only)

Request

No parameters.

Request

curl https://calling.ubiqproject.com/api/v1/whoami \
  -H "Authorization: Bearer vk_live_YOUR_KEY"

Response

Response · 200

{
  "tenant_id": "6d1f0b2a-4e7c-4a39-9b85-c2e3f4a5b6d7",
  "auth_method": "api_key",
  "scope": "full"
}

Response fields

tenant_idstring (UUID)

Your company's ID.

auth_methodstring

api_key for API-key requests. (session when called from a logged-in dashboard.)

scopestring

full or read. A read key can only make GET requests.

A wrong or revoked key returns 401 with {"detail": "Invalid API key"}.