Skip to main content

Get Phone Numbers

GET 

/api/phone-numbers

Get paginated phone numbers for the current tenant with optional search and capability filtering.

Query Parameters:

  • search: Filter by phone number or location
  • required_capability: Check if phone numbers support a specific capability (sms/voice/mms). Returns all phones but marks unsupported ones as disabled=true with a reason.
  • exclude_from_pool: If true, exclude phone numbers that belong to a number pool.
  • page: Page number (1-indexed, default: 1)
  • page_size: Number of items per page (default: 20, max: 100)

Request

Responses

Successful Response