Skip to main content
GET
List Numbers

Authorizations

Authorization
string
header
required

Retrieve your API Key from Dashboard API Keys Section.

Query Parameters

label
string

Filter numbers by label

Response

Successfully retrieved the list of numbers.

_id
string<objectId>
required

Unique identifier of the number

Example:

"a12f9c88-c155-461f-9771-4d240cdc9a04"

teamId
string<objectId>
required

This is unique identifier of the team.

Example:

"1f7b1b1b1b1b1b1b1b1b1b1b"

number
string
required

Phone number associated with the team

Example:

"+1234567890"

provider
object
required
assistantId
string

ID of the associated assistant (if any)

Example:

"a12f9c88-c155-461f-9771-4d240cdc9a04"

inboundEnabled
boolean

If true, inbound call is enabled. If false, inbound call is disabled.

Example:

true

outboundEnabled
boolean

If true, outbound call is enabled. If false, outbound call is disabled.

Example:

true

label
string

Label for the number

Example:

"friendly-name-1"