Skip to main content
GET
List usage

Authorizations

Authorization
string
header
required

An org API key: Authorization: Bearer phk_…

Headers

Phonely-Organization
string | null

Optional. Must be the key's org.

Path Parameters

id
string
required

The organization's ID.

Query Parameters

occurred_from
string<date-time>
required

Usage at or after this time (ISO 8601 with a timezone).

occurred_before
string<date-time>
required

Usage before this time (ISO 8601 with a timezone). At most 366 days after occurred_from.

group_by
string | null

agent_id returns one item per agent instead of the total. How to split the usage: one item per agent. Known values: agent_id. More can be added, so handle values you don't recognize.

agent_id
string | null

Only this agent's usage. A deleted agent's usage stays readable.

Minimum string length: 1
limit
integer
default:50

Items per page, 1 to 100.

Required range: 1 <= x <= 100
cursor
string | null

next_cursor from the previous page.

Response

Successful Response

data
Usage · object[]
required

The items on this page.

next_cursor
string | null
required

Pass as cursor to get the next page. null on the last page.