Skip to main content
GET
Get org usage

Authorizations

x-conveyour-token
string
header
required

Your API key token. Contacts endpoints require a Server-only — Full API key — see Authentication.

Query Parameters

type
string

Usage type to return. Default all returns every usage type.

just
string

Set to rate to return only rate information.

cache
string

Set to false to bypass the usage cache and recompute. Any other value uses the cache.

teams[]
string[]

Team scope for the request, as one or more team ObjectIds. The brackets are required: PHP keeps only the last value for a repeated plain key, so teams=A&teams=B silently resolves to B alone. On requests with a JSON body you may send teams (no brackets) in the body instead.

Values that are not valid ObjectIds are silently ignored — a mistyped team ID behaves as if no team was sent. See the teams section of the API conventions guide.

Response

Success.

The common response envelope shared by all ConveYour endpoints.

status
enum<string>

ok on success, failed on error.

Available options:
ok,
failed
message
string

Human-readable description of the result.

data
object

Usage overview from planOverview()->getUsageOverview(). Its keys depend on the type and just query parameters and have not been verified field by field.