Skip to main content
GET
List numbers

Authorizations

Authorization
string
header
required

HTTP Basic Authentication. Use your API Access Key ID as the username and your API Access Key Secret as the password. Generate keys in the CloudTalk Dashboard under Account -> Settings -> API Keys (https://dashboard.cloudtalk.io/menu/account/settings/API-keys).

Query Parameters

id
integer

Filter by number ID

country_code
integer

Filter by country calling code

area_code
integer

Filter by local area code. Area code cannot contain 0 at the beginning

connected_to
enum<integer>

Filter by route type. 0 = 'group', 1 = 'agent', 2 = 'conference room', 3 = 'fax'

Available options:
0,
1,
2,
3
is_free
enum<integer>

Filter by availability. 0 = 'taken', 1 = 'free'

Available options:
0,
1
limit
integer

Max. number of items in response data.

Required range: 1 <= x <= 1000
page
integer

Number of page to return.

Required range: x >= 1

Response

200 - application/json

Numbers data

responseData
object
required