Get Usage Statistics

Retrieve current feature usage statistics for the authenticated tenant. Shows usage across contacts, conversations, campaigns, and staff with limits from the active subscription plan.

Authentication

Required Scope: account:read

Response

Success (200 OK): Returns usage data for each tracked feature. Includes message: "Usage statistics retrieved successfully".

Response Structure

The data object contains usage entries for each feature:

Feature Keys

Feature	Description
`contacts`	Total contacts in account
`conversations`	Conversations (per month)
`campaigns`	Active campaigns
`staff`	Team members

Per-Feature Fields

Field	Type	Description
`current`	integer	Current usage count
`limit`	integer\|null	Maximum allowed (`-1` means unlimited, `null` if not configured)
`remaining`	integer\|null	Remaining quota
`percentage_used`	float	Percentage of limit used (0-100, rounded to 2 decimals). Returns `0` for unlimited features
`is_unlimited`	boolean	`true` if the feature has no limit (`limit === -1`)

Error Responses

Status	Code	Description
404	`NOT_FOUND`	Tenant not found
500	`INTERNAL_ERROR`	Failed to fetch usage statistics

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Authentication#

Response#

Response Structure#

Feature Keys#

Per-Feature Fields#

Error Responses#