List phone numbers

GET/v1/phone-numbers

Authorization

bearerAuth

AuthorizationBearer <token>

API token issued from the dashboard (Settings → API Tokens). Sent as Authorization: Bearer <token>.

In: header

Query Parameters

provider?string

Value in"twilio" | "telnyx" | "vonage"

search?string

Matches the number or its label.

Length1 <= length <= 200

limit?integer

Default50

Range1 <= value <= 200

offset?integer

Default0

Range0 <= value <= 9007199254740991

Response Body

`application/json`

cURL

curl -X GET "https://example.com/phone-numbers"

{
  "success": true,
  "phoneNumbers": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "phoneNumber": "string",
      "countryCode": "string",
      "provider": "string",
      "isVerified": true,
      "label": "string",
      "smsEnabled": true,
      "capabilities": {
        "property1": null,
        "property2": null
      },
      "inboundAgentId": "c3d8ea5a-64bd-4aae-9765-2549d985a3a3",
      "inboundMode": "agent",
      "inboundForwardTo": "string",
      "inboundForwardCallerId": "original",
      "inboundForwardFallback": "hangup",
      "outboundAgentId": "3da9ac0a-5669-4e85-a9ed-b9bc318bacd6",
      "outboundPhoneNumber": "string",
      "callType": "one",
      "isDefault": true,
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ],
  "pagination": {
    "limit": -9007199254740991,
    "offset": -9007199254740991,
    "hasMore": true
  }
}

{
  "error": "validation_failed",
  "message": "string",
  "issues": null
}

{
  "error": "unauthorized"
}

Authorization

Query Parameters

Response Body

200application/json

400application/json

401application/json

`application/json`

`application/json`

`application/json`