API reference / Basics
Errors and conventions
Status codes you will see, and the shapes every endpoint keeps to.
Status codes#
- 401 — the key is missing, malformed, unknown or revoked. The body says which is not distinguished, deliberately.
- 429 — rate limited. Wait for the
Retry-Afterheader’s seconds. - 503 — the database is briefly unavailable. Retry.
Conventions#
- Money is integer credit-hundredths: 100 = $1.00. Never a float.
- Timestamps are ISO 8601 strings in UTC.
- Phone numbers are raw E.164, without formatting.
- A value the workspace does not have is
null— never an empty string standing in for absence.
An error bodyjson
{
"error": "invalid api key"
}