Phone Numbers

Search Available Phone Numbers

Numbers a carrier has available to buy. Buy one with POST /phone-numbers/purchase.

post/phone-numbers/search

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/phone-numbers/search
  • Auth: HTTP bearer

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Request body

providerstring required

The carrier to search - the same values POST /phone-numbers/purchase takes.

countrystring

ISO country code.

area_codestring nullable
number_typestring

local or toll_free.

patternstring nullable

Digits or a phrase the number must contain.

matchstring

Where pattern must appear: first, anywhere or last.

localitystring nullable

City. Use this or pattern, not both.

Response

Successful Response

Changes

No recorded changes to this operation across all 2 revisions of this API.