Skip to main content
GET
/
clients
/
{clientId}
/
phone-numbers
Get Phone Numbers
curl --request GET \
  --url https://api.chat-dash.com/v1/public/clients/{clientId}/phone-numbers \
  --header 'Authorization: <authorization>'
[
  {
    "_id": "<string>",
    "clientId": "<string>",
    "platform": "<string>",
    "platformId": "<string>",
    "apiKey": "<string>",
    "number": "<string>",
    "type": "<string>"
  }
]

Headers

​
Authorization
string
required

Client-specific API key for authentication

Path Parameters

​
clientId
string
required

Client ID to retrieve phone numbers for

Query Parameters

​
agentId
string
required

Filter phone numbers by associated agent ID

Response

OK

​
_id
string

The ID of the phone number

​
clientId
string

The ID of the client associated with the phone number

​
platform
string

The platform this phone number is associated with (Retell/Vapi)

​
platformId
string

The ID of the phone number on the platform

​
apiKey
string

The platform API key associated with the phone number

​
number
string

The phone number in E.164 format

​
type
string

The type of phone number (assigned or imported)