Skip to main content
GET
List a customer's agent consumption

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

customer_id
string
required

Query Parameters

agent
string

Agent slug. An empty string selects the shared pool; omission includes all scopes.

Maximum string length: 128
Example:

"support"

overage

Filter by overage status. Omit to include both ordinary and overage entries.

Example:

false

from
string<date-time>

UTC date time string in the ISO 8601 format.

Example:

"2024-12-20T16:04:11Z"

to
string<date-time>

UTC date time string in the ISO 8601 format.

Example:

"2024-12-20T16:04:11Z"

take
number | null
default:50
Required range: 0 <= x <= 100
skip
number | null
default:0
Required range: x >= 0

Response

meta
object
required
data
object[]
required

List of AgentConsumptionEntry.