List your numbers

Lists your assigned numbers. When e164 is provided, the endpoint performs an exact lookup and returns at most one matching entry. When status is omitted, only IN_SERVICE numbers are returned.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
length ≥ 1

Partial alias or customer reference match. Can be combined with e164.

string
^\+[1-9][0-9]{1,14}$

Exact E.164 number match. When provided, the endpoint returns at most one entry.

status
array of strings | null

Number status filter. Repeat the parameter or use a comma-separated list. Defaults to IN_SERVICE when omitted.

status
Allowed:
string | null

Filter numbers whose next billing date is on or after this date. Can be combined with e164.

string | null

Filter numbers whose next billing date is on or before this date. Can be combined with e164.

number
≥ 1
Defaults to 1

The page number to retrieve. Ignored when e164 is provided.

number
1 to 100
Defaults to 10

The number of entries per page. Ignored when e164 is provided.

Responses

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json