Skip to main content
POST
/
api
/
phone-numbers
/
list
cURL
curl --request POST \
  --url http://localhost:8080/api/phone-numbers/list \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --header 'X-API-SECRET: <api-key>' \
  --data '
{
  "page": 0,
  "limit": 50,
  "sort_by": "updated_at",
  "sort_order": "descending",
  "filter_criteria": {
    "nickname": "customer",
    "area_code": 415,
    "agent_id": "agent_abc123"
  }
}
'
{
  "message": "Phone numbers retrieved successfully",
  "status": "success",
  "error": null,
  "data": {
    "organization_id": "org_123",
    "phone_numbers": [
      {
        "phone_number": "+14157774444",
        "phone_number_pretty": "+1 (415) 777-4444",
        "area_code": 415,
        "nickname": "Customer Service Line",
        "phone_number_type": "zudu-twilio",
        "inbound_agent_id": "agent_abc123",
        "outbound_agent_id": "agent_xyz789",
        "number_provider": "twilio",
        "outbound_trunk_id": "ST_4Xo2mZgQsfyQ",
        "created_at": "2024-01-15T10:30:00Z",
        "updated_at": "2024-01-15T10:30:00Z"
      }
    ],
    "returned_count": 1,
    "pagination": {
      "page": 0,
      "limit": 50,
      "total_pages": 1,
      "total_count": 1,
      "has_next": false,
      "has_previous": false
    },
    "sort_order": "descending",
    "sort_by": "updated_at"
  }
}

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

Body

application/json
page
integer

Page number (default: 0)

limit
integer

Items per page

sort_by
string
sort_order
string
filter_criteria
object

Response

200 - application/json

Phone numbers retrieved successfully

message
string
status
string
error
string | null
data
object