Skip to main content
GET
/
v1
/
phone-numbers
List Phone Numbers
curl --request GET \
  --url https://api.oneinbox.ai/v1/phone-numbers \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "id": "<string>",
      "phone_number": "<string>",
      "friendly_name": "<string>",
      "provider": "<string>",
      "agent_id": "<string>",
      "status": "<string>",
      "inbound_trunk_id": "<string>",
      "outbound_trunk_id": "<string>",
      "dispatch_rule_id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "inbound_routing": {
        "agent_id": "<string>",
        "fallback": {
          "agent_id": "<string>"
        },
        "voicemail_message": "<string>"
      }
    }
  ],
  "total": 123,
  "limit": 123,
  "offset": 123
}

Authorizations

Authorization
string
header
required

Your API key sent as a Bearer credential — Authorization: Bearer <api_key>, where <api_key> starts with oi_sk_ (create one via POST /v1/api-keys). Although the field is labelled 'token', paste your API key here. A dashboard JWT is also accepted on this header for the same endpoints.

Query Parameters

limit
integer
default:50
Required range: 1 <= x <= 100
offset
integer
default:0
Required range: x >= 0

Response

Successful Response

items
PhoneNumberResponse · object[]
required
total
integer
required
limit
integer
required
offset
integer
required