Authorizations
Query Parameters
Filter results to return only phone numbers associated with the specified user"s unique identifier.
Examples:
"US123abc"
Response
Success
π£ OpenPhone is now Quo. Learn more β
curl --request GET \
  --url https://api.openphone.com/v1/phone-numbers \
  --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"
        }
      }
    }
  ]
}Retrieve the list of phone numbers and users associated with your OpenPhone workspace.
curl --request GET \
  --url https://api.openphone.com/v1/phone-numbers \
  --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"
        }
      }
    }
  ]
}Filter results to return only phone numbers associated with the specified user"s unique identifier.
"US123abc"
Success
Show child attributes
Was this page helpful?