GET
/
v1
/
contacts
curl --request GET \
  --url https://api.openphone.com/v1/contacts
{
  "data": [
    {
      "id": "664d0db69fcac7cf2e6ec",
      "externalId": "664d0db69fcac7cf2e6ec",
      "source": "public-api",
      "defaultFields": {
        "company": "OpenPhone",
        "emails": [
          {
            "name": "company email",
            "value": "[email protected]",
            "id": "acb123"
          }
        ],
        "firstName": "John",
        "lastName": "Doe",
        "phoneNumbers": [
          {
            "name": "company phone",
            "value": "+12345678901",
            "id": "acb123"
          }
        ],
        "role": "Sales"
      },
      "customFields": [
        {
          "name": "Inbound Lead",
          "key": "inbound-lead",
          "id": "66d0d87d534de8fd1c433cec3",
          "type": "multi-select",
          "value": [
            "option1",
            "option2"
          ]
        }
      ],
      "createdAt": "2022-01-01T00:00:00Z",
      "updatedAt": "2022-01-01T00:00:00Z",
      "createdByUserId": "US123abc"
    }
  ],
  "totalItems": 123,
  "nextPageToken": "<string>"
}

Query Parameters

​
externalIds
string[]
required

An external identifier of the contact.

​
sources
string[]

Indicates how the contact was created or where it originated from.

​
maxResults
integer
default:
10
required

Maximum number of results to return per page.

Required range: 1 <= x <= 50
​
pageToken
string

Response

200
application/json
Success
​
data
object[]
required

Array of items

​
totalItems
integer
required

Total number of items available. ⚠️ Note: totalItems is not accurately returning the total number of items that can be paginated. We are working on fixing this issue.

​
nextPageToken
string | null
required

Was this page helpful?

Get contact custom fieldsCreate a contact