Skip to main content
GET
Search Available Phone Numbers

Authorizations

Authorization
string
header
required

Your API key (ta_live_…) from Settings → API keys, sent as Authorization: Bearer <key>. Keep it on a server: it can message every customer you have. A key is full, build or read-only; a request its level does not allow is refused with 403.

Headers

Thinnest-Workspace
string

Developers only: the customer workspace this request acts in — its org_… id from POST /customers. Leave it out to act in your own workspace. Refused with 404 (Workspace not found.) when the id is unknown, is not one of your customers, or is not an org_… id; 410 when that customer was deleted (restore it with POST /customers/{id}/restore until it is erased); 403 when the key belongs to one customer workspace (it cannot act as another); 400 when your workspace is not a developer workspace. /customers/* and GET /customers/usage are your own workspace's and refuse the header with 400: call them without it.

Example:

"org_3fKq9TzQ1mN8vB2xR7cLpA"

Query Parameters

pattern
string

Up to ten digits that follow the country code — an area code, such as 80 for Bengaluru or 415 for San Francisco.

Pattern: ^\d{1,10}$
city
string

A city (India) or a state (United States), spelled exactly as List Available Cities lists it.

Maximum string length: 60
cursor
string

The nextCursor from the page before. Leave it out for the first page.

Pattern: ^\d+$

Response

A page of numbers you can rent.

items
object[]
required
nextCursor
string | null
required

Pass as cursor for the next page; null when there are no more.

Example:

"20"