Get Contacts

Retrieve a paginated list of contacts for a sub-account. Supports filtering by query string, sort order, and pagination.

GET/contacts/

Scope

contacts.readonly

Auth Method

Bearer Token

Token Type

Sub-Account / Company

Header Parameters

Parameter	Type	Description
`Authorization`required	string	Bearer {access_token}
`Version`required	string	API Version Possible values: `2021-07-28`

Query Parameters

Parameter	Type	Description
`locationId`required	string	Sub-account ID to retrieve contacts from.
`limit`	integer	Number of contacts to return per page. Default: 20, Max: 100.
`startAfterId`	string	Contact ID to start after (for cursor-based pagination).
`startAfter`	integer	Offset-based pagination start index.
`query`	string	Search query to filter contacts by name, email, phone, or company.
`sortBy`	string	Field to sort by (e.g. date_added, date_updated).
`order`	string	Sort order. Possible values: `asc, desc`

Example RequestcURL

curl -X GET \
  'https://services.leadconnectorhq.com/contacts/?locationId=ve9EPM428h8vShlRW1KT&limit=20&query=john' \
  -H 'Authorization: Bearer {access_token}' \
  -H 'Version: 2021-07-28' \
  -H 'Accept: application/json'

Response — 200 OK

Example ResponseJSON

{
  "contacts": [
    {
      "id": "ocQHyuzHvuMOe5N5jjXF",
      "name": "John Doe",
      "firstName": "John",
      "lastName": "Doe",
      "email": "[email protected]",
      "phone": "+15551234567",
      "locationId": "ve9EPM428h8vShlRW1KT",
      "tags": ["customer"],
      "dateAdded": "2024-01-10T12:00:00.000Z",
      "dateUpdated": "2024-06-15T09:30:00.000Z"
    },
    {
      "id": "xYzAbCdEfGhIjKlMnOpQ",
      "name": "John Smith",
      "firstName": "John",
      "lastName": "Smith",
      "email": "[email protected]",
      "phone": "+15559876543",
      "locationId": "ve9EPM428h8vShlRW1KT",
      "tags": ["lead"],
      "dateAdded": "2024-03-20T08:00:00.000Z",
      "dateUpdated": "2024-06-14T11:00:00.000Z"
    }
  ],
  "meta": {
    "total": 2,
    "nextPageUrl": null,
    "startAfterId": "xYzAbCdEfGhIjKlMnOpQ",
    "startAfter": 2,
    "currentPage": 1
  }
}

Pagination

Use the meta.startAfterId or meta.startAfter value from the response to fetch the next page. When meta.nextPageUrl is null, you have reached the last page.

← Upsert Contact Get Contacts By Business ID →