Skip to main content
GET
/
v1
/
phone-numbers
List phone numbers
curl --request GET \
  --url https://dev-public-api.openphone.dev/v1/phone-numbers \
  --header 'Authorization: <api-key>'
{
  "data": [
    {
      "id": "<string>",
      "groupId": "<string>",
      "portRequestId": "123abc",
      "formattedNumber": "+15555555555",
      "forward": "+15555555555",
      "name": "<string>",
      "number": "<string>",
      "portingStatus": "completed",
      "symbol": "🏡",
      "users": [
        {
          "email": "jsmith@example.com",
          "firstName": "John",
          "lastName": "Doe",
          "id": "<string>",
          "role": "owner",
          "groupId": "<string>"
        }
      ],
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "restrictions": {
        "calling": {
          "CA": "restricted",
          "Intl": "restricted",
          "US": "restricted"
        },
        "messaging": {
          "CA": "restricted",
          "Intl": "restricted",
          "US": "restricted"
        }
      }
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Query Parameters

​
userId
string

Filter results to return only phone numbers associated with the specified user"s unique identifier.

Example:

"US123abc"

Response

Success

​
data
object[]
required