Sign in

Get your setup overview

View as Markdown
GET/v1/provisioning/tenants/{tenant_id}/overview

Your Telephony setup in one read, narrowed with `include` and `month`.

Auth

Authentication required.

Parameters

NameInRequiredTypeDescription
tenant_idpathYesstringYour setup ID — the `_id` returned by `GET /me`.
includequeryNostringComma-separated sections to return. Omit for all of them. Unknown names are ignored. Known: `tenant`, `trunk_status`, `usage`
monthqueryNostringYYYY-MM, Asia/Bangkok month, for the usage section

Request body

No request body.

Responses

StatusDescriptionContent-TypeShape
200Successful Responseapplication/jsonunknown
422Validation Errorapplication/jsonHTTPValidationError