List phone numbers

Retrieve the list of phone numbers and users associated with your Quo workspace.

GET /v1/phone-numbers

List phone numbers

cURL

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

Query Parameters

userId · string

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

Pattern: ^US(.*)$

Example:

"US123abc"

Response

200

application/json

OK

data · object[] · required

Show child attributes