Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

JWT Bearer token obtained from authentication. Pass as: Authorization: Bearer

Query Parameters

cursor
string

Opaque cursor from a previous response to fetch the next page

Pattern: ^[cC][^\s-]{8,}$
limit
integer
default:20

Maximum number of items to return per page (1–100, default 20)

Required range: 1 <= x <= 100
query
string

Free-text search. Digits match the number itself, ignoring punctuation and spacing; the raw term also matches the owning agent's name or slug.

Required string length: 1 - 120
agentId

Restrict to one agent's numbers. Omit to list every number in the organization. An agent key is confined to its own numbers whether or not this is set.

Pattern: ^[0-9a-z]+$

Response

200 - application/json

OK

Paginated list of phone numbers across an organization

items
object[]
required

Phone identities matching the query, with their owning agent

pagination
object
required

Cursor-based pagination metadata