List phone numbers

Retrieve a paginated list of the phone numbers in your Quo workspace. Assigned users and usage restrictions are opt-in through the include parameter.

GET /phone-numbers

List phone numbers

cURL

curl --request GET \
  --url https://dev-public-api.openphone.dev/phone-numbers \
  --header 'Authorization: <api-key>' \
  --header 'Quo-Api-Version: <quo-api-version>'

200

{
  "data": [
    {
      "id": "PNlja6rrtI",
      "groupId": "GRcei8k90o",
      "name": "My phone number",
      "number": "[phone]",
      "formattedNumber": "[phone]",
      "forward": "[phone]",
      "portRequestId": "123abc",
      "portingStatus": "completed",
      "symbol": "🏡",
      "createdAt": "2022-01-01T00:00:00Z",
      "updatedAt": "2022-01-01T00:00:00Z",
      "users": [
        {
          "id": "US123abc",
          "email": "[e-mail]",
          "firstName": "John",
          "lastName": "Doe",
          "role": "owner",
          "groupId": "GRcei8k90o"
        }
      ],
      "restrictions": {
        "calling": {
          "CA": "unrestricted",
          "Intl": "unrestricted",
          "US": "unrestricted"
        },
        "messaging": {
          "CA": "unrestricted",
          "Intl": "unrestricted",
          "US": "unrestricted"
        }
      }
    }
  ],
  "nextCursor": "eyJsYXN0SWQiOiJVU211a09NaXBhIn0"
}

Authorizations

Authorization · string · header · required

Headers

Quo-Api-Version · enum<string> · required

API version header. Supported values: 2026-03-30

Available options: 2026-03-30

Query Parameters

limit · integer · default: 10

Max number of items to return per page.

Required range: 1 <= x <= 50

after · string

Example:

"eyJsYXN0SWQiOiJVU211a09NaXBhIn0"

userId · string

Filter results to phone numbers assigned to the specified user.

Pattern: ^US(.*)$

Example:

"US123abc"

phoneNumber · string

Filter results to the phone number matching this E.164 value.

Pattern: ^\+[1-9]\d{1,14}$

Example:

"[phone]"

include · enum<string>[]

Comma-separated list of optional payload sections to include. users adds the members assigned to the number, restrictions adds its calling and messaging restrictions. Omitted sections are left out of the response entirely.

Maximum array length: 2

Available options: users, restrictions

Examples:

"users"

"users,restrictions"

Response

200

application/json

OK

data · object[] · required

Show child attributes

nextCursor · string | null · required

Cursor for the next page, or null when there are no more pages.

Example:

"eyJsYXN0SWQiOiJVU211a09NaXBhIn0"