GET
/
v1
/
phone-numbers
/
{phoneNumberId}
Get a phone number by ID
curl --request GET \
  --url https://api.openphone.com/v1/phone-numbers/{phoneNumberId} \
  --header 'Authorization: <api-key>'
{
  "data": {
    "id": "PN123bc",
    "groupId": "1234",
    "portRequestId": "123abc",
    "formattedNumber": "+15555555555",
    "forward": "+15555555555",
    "name": "My phone number",
    "number": "+15555555555",
    "portingStatus": "completed",
    "symbol": "🏑",
    "users": [
      {
        "email": "[email protected]",
        "firstName": "John",
        "lastName": "Doe",
        "id": "<string>",
        "role": "owner",
        "groupId": "GRcei8k90o"
      }
    ],
    "createdAt": " '2022-01-01T00:00:00Z'",
    "updatedAt": " '2022-01-01T00:00:00Z'",
    "restrictions": {
      "calling": {
        "CA": "unrestricted",
        "Intl": "unrestricted",
        "US": "unrestricted"
      },
      "messaging": {
        "CA": "unrestricted",
        "Intl": "unrestricted",
        "US": "unrestricted"
      }
    }
  }
}

Authorizations

Authorization
string
header
required

Path Parameters

phoneNumberId
string
required

Unique identifier of the phone number.

Examples:

"PNlja6rrtI"

Response

Success

data
object
required