Get a number

GET

/numbers/items/{id}

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

The ETag header carries the metadata version.

Authorizations

ApiKeyAuth

Parameters

Path Parameters

required

string

>= 1 characters

Resource id.

Responses

200

Default Response

application/json

object

success

required

boolean

item

required

A number of the project with its status and metadata.

object

required

string

phone_number

required

string

type

required

string

Allowed values: temporary monthly device

status

required

string

Allowed values: ACTIVE OFFLINE SIM_REMOVED MOVED RELEASED EXPIRED UNASSIGNED

status_reason

required

string | null

country

required

string | null

capabilities

required

Any of:

object
null

object

key

additional properties

boolean

assigned_at

required

Any of:

string
null

UTC timestamp (ISO 8601).

string

ended_at

required

Any of:

string
null

UTC timestamp (ISO 8601).

string

expires_at

required

Any of:

string
null

UTC timestamp (ISO 8601).

string

renews_at

required

Any of:

string
null

UTC timestamp (ISO 8601).

string

released_reason

required

string | null

created_at

required

UTC timestamp (ISO 8601).

string

updated_at

required

UTC timestamp (ISO 8601).

string

temporary

required

Any of:

object
null

object

service

required

string | null

operator

required

string | null

first_sms_at

required

Any of:

string
null

UTC timestamp (ISO 8601).

string

device

required

Any of:

object
null

object

carrier_name

required

string | null

present

required

boolean

verified_at

required

Any of:

string
null

UTC timestamp (ISO 8601).

string

last_seen_at

required

Any of:

string
null

UTC timestamp (ISO 8601).

string

online

required

boolean

metadata

required

Any of:

object
null

Free-form JSON object (at most 16 KB, 5 levels deep, keys up to 64 characters).

object

key

additional properties

metadata_version

required

Increases on every change; use it in If-Match.

integer

>= -9007199254740991 <= 9007199254740991

Example

{
  "success": true,
  "item": {
    "type": "temporary",
    "status": "ACTIVE"
  }
}

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
}

404

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
}