List the monthly numbers that can be rented

GET

/numbers/catalog/available

const url = 'https://api.clearance.rest/numbers/catalog/available?country=example&line_type=local';
const options = {method: 'GET', headers: {'X-API-Key': '<X-API-Key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://api.clearance.rest/numbers/catalog/available?country=example&line_type=local' \
  --header 'X-API-Key: <X-API-Key>'

Authorizations

ApiKeyAuth

Parameters

Query Parameters

country

required

string

>= 2 characters <= 2 characters

ISO 3166-1 alpha-2 country code (e.g. US).

line_type

string

Allowed values: local mobile national toll_free

Line type (default local).

area_code

string

>= 1 characters <= 10 characters

Restrict to an area code (where supported).

contains

string

>= 1 characters <= 32 characters

Digits the number must contain.

mms

boolean

Only numbers that can receive MMS.

voice

boolean

Only numbers that can receive voice calls.

Responses

200

Default Response

application/json

object

success

required

boolean

numbers

required

Array<object>

A monthly number that can be rented.

object

phone_number

required

string

friendly_name

required

string

region

required

string | null

country

required

string

capabilities

required

object

key

additional properties

boolean

price

required

Any of:

number
null

Amount in USD.

number

Example

{
  "success": true
}

400

Default Response

application/json

Error envelope returned by every JSON endpoint.

object

success

required

boolean

error

required

object

code

required

Machine-readable error code (snake_case).

string

message

required

Human-readable message.

string

details

Extra context for the error.

object

key

additional properties

Example

{
  "success": false
}

401

Default Response

application/json

Error envelope returned by every JSON endpoint.

object

success

required

boolean

error

required

object

code

required

Machine-readable error code (snake_case).

string

message

required

Human-readable message.

string

details

Extra context for the error.

object

key

additional properties

Example

{
  "success": false
}

403

Default Response

application/json

Error envelope returned by every JSON endpoint.

object

success

required

boolean

error

required

object

code

required

Machine-readable error code (snake_case).

string

message

required

Human-readable message.

string

details

Extra context for the error.

object

key

additional properties

Example

{
  "success": false
}

502

Default Response

application/json

Error envelope returned by every JSON endpoint.

object

success

required

boolean

error

required

object

code

required

Machine-readable error code (snake_case).

string

message

required

Human-readable message.

string

details

Extra context for the error.

object

key

additional properties

Example

{
  "success": false
}

503

Default Response

application/json

Error envelope returned by every JSON endpoint.

object

success

required

boolean

error

required

object

code

required

Machine-readable error code (snake_case).

string

message

required

Human-readable message.

string

details

Extra context for the error.

object

key

additional properties

Example

{
  "success": false
}