List the target services of temporary numbers

GET

/numbers/catalog/services

const url = 'https://api.clearance.rest/numbers/catalog/services';
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/services \
  --header 'X-API-Key: <X-API-Key>'

q narrows the list to services whose name or code contains the text (case-insensitive).

Authorizations

ApiKeyAuth

Parameters

Query Parameters

country

string

>= 2 characters <= 2 characters

Limit the list to services offered in this country.

string

>= 1 characters <= 64 characters

Only services whose name or code contains this text (case-insensitive).

Responses

200

Default Response

application/json

object

success

required

boolean

services

required

Array<object>

object

code

required

string

name

required

string

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
}

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
}