Skip to main content
GET
/
v1
/
phone-numbers
/
search
Search Available Numbers
curl --request GET \
  --url https://api.oneinbox.ai/v1/phone-numbers/search \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "phone_number": "<string>",
      "friendly_name": "<string>",
      "locality": "<string>",
      "region": "<string>",
      "country": "<string>",
      "capabilities": [
        "<string>"
      ]
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
country
string
default:US
Required string length: 2
​
area_code
string | null

Area code (US/CA)

​
contains
string | null

Digits/letters to match

​
limit
integer
default:20
Required range: 1 <= x <= 50
​
credential_id
string | null

Twilio credential id (accepts crd_<uuid> or bare uuid)

Response

Successful Response

​
items
AvailablePhoneNumber · object[]
required