Get a phone number by ID

Get a phone number by its unique identifier.

GET /v1/phone-numbers/{phoneNumberId}

Get a phone number by ID

cURL

curl --request GET \
  --url https://dev-public-api.openphone.dev/v1/phone-numbers/{phoneNumberId} \
  --header 'Authorization: <api-key>'

200

{
  "data": {
    "id": "PN123bc",
    "groupId": "1234",
    "portRequestId": "123abc",
    "formattedNumber": "[phone]",
    "forward": "[phone]",
    "name": "My phone number",
    "number": "[phone]",
    "portingStatus": "completed",
    "symbol": "🏡",
    "users": [
      {
        "email": "[e-mail]",
        "firstName": "John",
        "lastName": "Doe",
        "id": "US123abc",
        "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"
      }
    }
  }
}

{
  "message": "<string>",
  "code": "<string>",
  "status": 123,
  "docs": "<string>",
  "title": "<string>",
  "trace": "<string>",
  "errors": [
    {
      "path": "<string>",
      "message": "<string>",
      "schema": {
        "type": "<string>"
      },
      "value": "<unknown>"
    }
  ]
}

{
  "message": "<string>",
  "code": "<string>",
  "status": 123,
  "docs": "<string>",
  "title": "<string>",
  "trace": "<string>",
  "errors": [
    {
      "path": "<string>",
      "message": "<string>",
      "schema": {
        "type": "<string>"
      },
      "value": "<unknown>"
    }
  ]
}

{
  "message": "<string>",
  "code": "<string>",
  "status": 123,
  "docs": "<string>",
  "title": "<string>",
  "trace": "<string>",
  "errors": [
    {
      "path": "<string>",
      "message": "<string>",
      "schema": {
        "type": "<string>"
      },
      "value": "<unknown>"
    }
  ]
}

{
  "message": "<string>",
  "code": "<string>",
  "status": 123,
  "docs": "<string>",
  "title": "<string>",
  "trace": "<string>",
  "errors": [
    {
      "path": "<string>",
      "message": "<string>",
      "schema": {
        "type": "<string>"
      },
      "value": "<unknown>"
    }
  ]
}

{
  "message": "<string>",
  "code": "<string>",
  "status": 123,
  "docs": "<string>",
  "title": "<string>",
  "trace": "<string>",
  "errors": [
    {
      "path": "<string>",
      "message": "<string>",
      "schema": {
        "type": "<string>"
      },
      "value": "<unknown>"
    }
  ]
}

Authorizations

Authorization · string · header · required

Path Parameters

phoneNumberId · string · required

Unique identifier of the phone number.

Pattern: ^PN(.*)$

Example:

"PNlja6rrtI"

Response

200

application/json

OK

data · object · required

Show child attributes