Skip to content
clearance.rest

List the numbers of the project

GET
/numbers/items
curl --request GET \
  --url 'https://api.clearance.rest/numbers/items?limit=50' \
  --header 'X-API-Key: <X-API-Key>'

Every number the project has ever had stays in the list; status tells whether it is usable. Sorted by assigned_at (newest first). A page can hold fewer than limit items; the list ends when next_cursor is null. Filter on metadata values with metadata.<key>=<string> query parameters (top-level keys of letters, digits, _ and -, up to 64 characters; the value is compared as a string; several filters must all match), and on missing keys with metadata_absent=<key>,<key> (comma-separated).

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
limit
integer
default: 50 >= 1 <= 200

Page size (1-200).

cursor
string

The next_cursor value of the previous page.

status
Array<string>
Allowed values: ACTIVE OFFLINE SIM_REMOVED MOVED RELEASED EXPIRED UNASSIGNED

Comma-separated statuses; a number matches when it has any of them (default: all).

type
Array<string>
Allowed values: temporary monthly device

Comma-separated number types; a number matches when it has any of them.

capability
Array<string>
Allowed values: sms mms voice fax

Comma-separated capabilities; the number must have all of them.

phone_number
string

Exact match (E.164); encode + as %2B.

metadata_absent
string

Comma-separated metadata keys; the number must have none of them.

Responses

Section titled “Responses”

200

Section titled “200”

Default Response

Media typeapplication/json
object
success
required
boolean
items
required
Array<object>

A number of the project with its status and metadata.

object
id
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
key
additional properties
boolean
assigned_at
required
Any of:

UTC timestamp (ISO 8601).

string
ended_at
required
Any of:

UTC timestamp (ISO 8601).

string
expires_at
required
Any of:

UTC timestamp (ISO 8601).

string
renews_at
required
Any of:

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
service
required
string | null
operator
required
string | null
first_sms_at
required
Any of:

UTC timestamp (ISO 8601).

string
device
required
Any of:
object
carrier_name
required
string | null
present
required
boolean
verified_at
required
Any of:

UTC timestamp (ISO 8601).

string
last_seen_at
required
Any of:

UTC timestamp (ISO 8601).

string
online
required
boolean
metadata
required
Any of:

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
next_cursor
required
Any of:

Opaque cursor of the next page.

string
Example
{
  "success": true,
  "items": [
    {
      "type": "temporary",
      "status": "ACTIVE"
    }
  ]
}

400

Section titled “400”

Default Response

Media typeapplication/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

Section titled “401”

Default Response

Media typeapplication/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

Section titled “403”

Default Response

Media typeapplication/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
}