Get a phone number by ID

Retrieve a single phone number in your Quo workspace by its unique identifier. Assigned users and usage restrictions are opt-in through the include parameter.

GET /phone-numbers/{phoneNumberId}

Get a phone number by ID

cURL

curl --request GET \
  --url https://dev-public-api.openphone.dev/phone-numbers/{phoneNumberId} \
  --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"
      }
    }
  }
}

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

Path Parameters

phoneNumberId · string · required

The unique identifier of the phone number being retrieved.

Pattern: ^PN(.*)$

Example:

"PNlja6rrtI"

Query Parameters

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