Platform APIPhone Numbers

List phone numbers

View as Markdown
Lists all phone numbers assigned to a workspace.

Authentication

AuthorizationBearer

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

Query parameters

workspacestringRequired
Workspace ID.
limitintegerOptionalDefaults to 20
Phone numbers displayed per page.
offsetintegerOptionalDefaults to 0
Index of the first phone number to be returned.
is_availablebooleanOptional
Filters phone numbers by inbound availability. - `true`: only numbers not assigned to inbound agents - `false`: only numbers assigned to inbound agents

Response

200
statusstring
Whether the request was successful.
responseobject

Errors

400
Bad Request Error