Skip to main content
GET
/
v2
/
phone-numbers
List phone numbers
curl --request GET \
  --url https://api.openmic.ai/v2/phone-numbers \
  --header 'Authorization: Bearer <token>'
{
  "has_more": true,
  "phone_numbers": [
    {
      "id": "<string>",
      "phone_number": "<string>",
      "name": "<string>",
      "inbound_agent_uid": "<string>",
      "outbound_agent_uid": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "next_cursor": "<string>"
}

Authorizations

​
Authorization
string
header
required

API key obtained from the OpenMic dashboard.

Query Parameters

​
page_size
integer

Number of records per page (default 50, max 100).

Required range: 1 <= x <= 100
​
cursor
string

Opaque pagination cursor returned by the previous response.

​
phone_number
string

Filter by phone number (partial match).

​
name
string

Filter by name (partial match).

Response

Paginated list of phone numbers.

​
has_more
boolean
required

Whether more records exist after this page.

​
phone_numbers
object[]
required
​
next_cursor
string

Opaque cursor to pass as cursor in the next request.