Quickstart

Create a key in the dashboard at API keys. The secret is shown once. It starts with zt_live_ or zt_test_.

export ZOETEL_API_KEY="zt_live_…"

curl https://api.zoe-tel.com/v1/me \
  -H "Authorization: Bearer $ZOETEL_API_KEY"

GET /v1/me returns the caller and memberships. If you belong to more than one organisation, repeat the call with the organisation you mean:

curl https://api.zoe-tel.com/v1/numbers \
  -H "Authorization: Bearer $ZOETEL_API_KEY" \
  -H "X-Zoetel-Org: ORGANISATION_UUID"

GET /v1/numbers lists the numbers that organisation holds. A key with the numbers scope can also read GET /v1/numbers/{id}/usage?from&to. from and to are required ISO-8601 UTC timestamps ending in Z.

GET /v1/numbers/live is a signed-in member. An API key cannot call it.

There is no official SDK. The API is HTTP and JSON.