Skip to navigation
API Referencenumbers

List Numbers

List the active phone numbers for this account.

Released (deleted) numbers are excluded so the count reflects the numbers the account actually holds. Fetch a single number via GET /{number_id} (which returns it regardless of status). Pass externalId to find the number you tagged with your own identifier.

Authentication

AuthorizationBearer

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

Headers

X-Sub-Account-IdstringOptionalDefaults to 20

Target a sub-account. Pass a sub-account ID to scope this request. Omit to use the master account.

Query parameters

offsetintegerOptional>=0Defaults to 0
externalIdstring or nullOptional
Only the number tagged with this externalId

Response

Successful Response
datalist of objects
hasMoreboolean
totalinteger

Errors

422
Unprocessable Entity Error