Account
Get the account profile
Return the workspace owner profile, plan and WhatsApp connection state.
Returns the account this API key belongs to: name, email, role, subscription tier and status, and whether a WhatsApp account is connected. Use it to confirm which workspace you are acting on before calling anything else. Read-only.
Get the account profile › Responses
The API key is missing, malformed, expired, or its owner is inactive.
successGet the credit balance
Return the current prepaid credit balance.
Returns the workspace credit balance and when it last changed. Use it before an action that spends credit (such as a broadcast) to check there is enough left. Read-only; it does not top up.
Get the credit balance › Responses
The API key is missing, malformed, expired, or its owner is inactive.
successList credit transactions
Return the credit ledger, newest first.
Returns credit transactions (top-ups, usage, refunds) with the balance before and after each one. Use it to explain where credit went. Read-only. Paginated, at most 50 rows a page: follow meta.pagination.nextCursor until hasMore is false.
query Parameters
limitRows to return, 1-50. Defaults to 25.
Rows to return, 1-50. Defaults to 25.
cursorThe meta.pagination.nextCursor value from the previous call. Omit it to read the first page.
The meta.pagination.nextCursor value from the previous call. Omit it to read the first page.
List credit transactions › Responses
The API key is missing, malformed, expired, or its owner is inactive.
successGet the subscription and usage
Return the plan tier, feature flags, limits and current usage.
Returns the workspace plan (tier, status, expiry), what the plan allows (feature flags and numeric limits such as agents, API keys and channel counts) and how much of each is used now. Use it to check whether an action would exceed the plan. Read-only; it does not change or renew the plan.
Get the subscription and usage › Responses
The API key is missing, malformed, expired, or its owner is inactive.
successList WhatsApp quality ratings
Return the quality rating of each WhatsApp number with its recent history.
Returns, per WhatsApp phone number, the latest quality rating and the 10 most recent ratings. Use it to see whether a number is at risk of a lower messaging limit before sending a large campaign. Reads stored ratings only: it does not ask Meta to refresh them. Paginated by phone number.
query Parameters
limitRows to return, 1-100. Defaults to 25.
Rows to return, 1-100. Defaults to 25.
cursorThe meta.pagination.nextCursor value from the previous call. Omit it to read the first page.
The meta.pagination.nextCursor value from the previous call. Omit it to read the first page.
List WhatsApp quality ratings › Responses
The API key is missing, malformed, expired, or its owner is inactive.
success