Skip to content
Developers
Get started
Early access: these pages are being written and reviewed. Facts in the header boxes come straight from the product.

Get usage per user

GET
/api/v1/usage/users
curl --request GET \
--url https://api.pitch2sale.com/api/v1/usage/users \
--header 'Authorization: Bearer <token>'

For calling, transcript and live translation minutes, SMS and AI credits: meters[] with the company pool (pool.used, pool.limit, pool.resets_at), shared.used (usage with no person: the pool less the listed people) and limits_allowed (the plan lets admins limit people on this meter); users[] with each active person’s used (what they drew from the pool; calling minutes to two decimals, so the people plus shared.used add up to pool.used) and limits per meter (null = no limit); enabled is the “Limit individual users” switch. Mira and AI voice agent minutes are per company and are not listed. Requires settings.view_global. 404 while per-user limits are not available.

OK

Authentication required or token invalid

Media typeapplication/json
object
error
required
string
code
string
message
string
details
Array<object>
object
field
required
string
message
required
string
code
required
string
Examplegenerated
{
"error": "example",
"code": "example",
"message": "example",
"details": [
{
"field": "example",
"message": "example",
"code": "example"
}
]
}

Role permission or token scope missing; OAuth app tokens are not accepted on this route

Media typeapplication/json
object
error
required
string
code
string
message
string
details
Array<object>
object
field
required
string
message
required
string
code
required
string
Examplegenerated
{
"error": "example",
"code": "example",
"message": "example",
"details": [
{
"field": "example",
"message": "example",
"code": "example"
}
]
}

Rate limit exceeded

Media typeapplication/json
object
error
required
string
code
string
message
string
details
Array<object>
object
field
required
string
message
required
string
code
required
string
Examplegenerated
{
"error": "example",
"code": "example",
"message": "example",
"details": [
{
"field": "example",
"message": "example",
"code": "example"
}
]
}