Skip to main content
GET
cURL

Notes

  • Simple listing with optional filters and pagination

Authorizations

X-API-KEY
string
header
required

API Key for MCP server and external service authentication

X-API-SECRET
string
header
required

API Secret for MCP server and external service authentication

Query Parameters

limit
integer<int32>

Number of results per page

page
integer<int32>

Page number (0-based)

sort_by
string

Sort field (phone_number, nickname, area_code, updated_at)

sort_order
string

Sort direction (ascending, descending)

nickname
string

Filter by nickname (partial match)

area_code
integer<int32>

Filter by area code

agent_id
string

Filter by agent ID (inbound or outbound)

Response

200 - application/json

Phone numbers retrieved successfully

message
string
status
string
error
string | null
data
object