zazzy
API reference

Get the authenticated organization's usage summary

Returns the authenticated organization's current-period usage for every metered metric — the amount used, the plan limit (`null` when the metric is unmetered or the plan is unlimited), and the remaining headroom. Served through the same `getUsageSummary` service the in-app usage dashboard reads, so the API and the dashboard always agree. Requires the `read` scope.

GET
/usage
AuthorizationBearer <token>

A bearer API key minted in Account settings → API keys. Send it as Authorization: Bearer <token>. The scheme match is case-insensitive; the token is taken verbatim. A missing, malformed, unknown, revoked, or expired key is rejected with an indistinguishable 401.

In: header

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/usage"
{  "metrics": [    {      "key": "apiRequests",      "description": "API requests served",      "aggregation": "sum",      "enforcement": "warn",      "used": 3120,      "limit": 10000,      "remaining": 6880    },    {      "key": "seats",      "description": "Team members",      "aggregation": "count",      "enforcement": "block",      "used": 4,      "limit": null,      "remaining": null    }  ]}
{  "error": {    "code": "UNAUTHORIZED",    "message": "Invalid API key."  }}
{  "error": {    "code": "FORBIDDEN",    "message": "This API key lacks the required 'read' scope."  }}
{  "error": {    "code": "RATE_LIMITED",    "message": "API rate limit exceeded. Retry after the window resets."  }}
{  "error": {    "code": "INTERNAL",    "message": "An unexpected error occurred."  }}