Skip to navigation
API OverviewApplication configuration

Get application configuration

View as Markdown
Get assigned inbound phone numbers, permitted outbound caller IDs and SMS identities, webhook settings, and effective resource limits.

Authentication

AuthorizationBearer

Send Authorization: Bearer <app_uuid>:<api_key> using an active API key. See Authentication for details.

Response headers

traceparentstringOptionalformat: "^00-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-f]{2}$"=55 characters

Server-owned W3C Trace Context for correlating this response with support and observability data. It is present on successful and error responses. A valid incoming traceparent is linked to, but never becomes, the server-owned trace identifier.

Response

Current application configuration
app_uuidstring

Application identifier starting with app_.

blocked_webhook_eventslist of enums
Event types excluded from webhook delivery. An empty array means all event types are delivered.
inbound_phone_numberslist of strings
Inbound phone numbers assigned to this application, sorted in ascending canonical E.164 order. Assignment changes can take time to reach call routing.
limitsobject
outbound_caller_idslist of strings
Phone numbers this application can present as caller ID on outbound calls, sorted in ascending canonical E.164 order.
sms_identitieslist of strings

Exact, case-sensitive SMS identities this application may present to recipients, sorted by stored value. An empty array means outbound SMS is disabled.

webhook_urlstring or null
Webhook delivery URL, or null when webhook delivery is disabled.

Errors

401
Unauthorized Error
406
Not Acceptable Error
500
Internal Server Error
503
Service Unavailable Error