Skip to main content
GET
List phone numbers

Authorizations

Authorization
string
header
required

Enter your API key (Bearer token)

Query Parameters

offset
integer
default:0

Rows to skip.

Required range: 0 <= x <= 100000
limit
integer
default:50

Page size, at most 200.

Required range: 1 <= x <= 200
agent_id
string<uuid>

Only numbers attached to this agent.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
status
enum<string>

Only numbers in this state.

Available options:
provisioning,
active,
releasing,
failed

Response

data
object[]
required
limit
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
offset
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
total
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991