Skip to main content

Core

The calling key itself and the workspace it belongs to. Read /v1/company once and cache it: every money field elsewhere is in its currency, and every calendar date is in its timezone.

Describe the calling API key

GET/v1/me

Identity and scopes of the key making the request.

Responses

StatusMeaning
200The key.
401The API key is missing, malformed, revoked or expired.
403The key does not carry the required scopes.
429Rate limit exceeded. See the RateLimit-* headers.

Retrieve the workspace

GET/v1/company

Currency and timezone are published here because every money and date field elsewhere is expressed in them.

Responses

StatusMeaning
200The workspace.
401The API key is missing, malformed, revoked or expired.
403The key does not carry the required scopes.
429Rate limit exceeded. See the RateLimit-* headers.