Applied LabsDocs
Contacts

List contacts

Retrieve contacts from your Applied workspace. Use filters to narrow results by ID, email, phone number, platform, archive state, or parent relationship.

GET/v2026-04/contacts/

Usage

Start from this cURL example and add filters as needed.

cURL
curl -X GET https://core.appliedlabs.ai/v2026-04/contacts/ \
  -H "Authorization: Bearer <api-token>" \
  -H "X-Shop-Id: 66e4c4d2-34e8-4f85-8f51-84b6ed7b5f10"

Authorizations

Authorizationstringheaderrequired

Send your Applied API key as Authorization: Bearer AL.... Create the key in the Applied dashboard and keep it on your server.

Query parameters

cursorstring

Use the cursor from a previous next or previous link to move through the results.

emailstring

Only return contacts with this email address.

idstring · uuid

Only return this contact.

id__inarray

Only return contacts with these IDs. Separate values with commas.

is_archivedboolean

Set to true for archived contacts or false for active contacts.

limitinteger

How many results to return in this page.

parent_contact_idstring · uuid

Only return child contacts for this parent contact.

parent_contact_id__inarray

Only return child contacts for these parent contacts. Separate values with commas.

parent_contact_id__isnullboolean

Set to true for top-level contacts only, or false for child contacts only.

phonestring

Only return contacts with this phone number (any common format).

remote_platformstring

Only return contacts from this external platform.

remote_platform__inarray

Only return contacts from these external platforms. Separate values with commas.

Header parameters

X-Shop-Idstring · uuidrequired

The shop whose data you want to read.

Response

A page of contacts.

nextstring · uri | null
previousstring · uri | null
resultsarrayrequired
results.companystring
results.created_atstring · date-timerequired
results.display_namestring
results.emailstring | nullrequired

Contact email address (most recently updated, if several).

results.idstring · uuidrequired
results.is_archivedboolean
results.is_testboolean
results.last_activity_atstring · date-time | null
results.namestring
results.parent_contact_idstring · uuid | nullrequired
results.phonestring | nullrequired

Contact phone number in E.164 format (most recently updated, if several).

results.remote_idstring | nullrequired

Your system's ID for the contact, if one is set.

results.remote_platformstring | nullrequired

The external platform this contact was originally imported from, if any.

results.rolestring
results.updated_atstring · date-timerequired
{
  "next": "https://core.appliedlabs.ai/v2026-04/contacts/?cursor=next-cursor-token",
  "previous": "https://core.appliedlabs.ai/v2026-04/contacts/?cursor=previous-cursor-token",
  "results": [
    {
      "company": "Barber Group",
      "created_at": "2026-04-07T14:30:00Z",
      "display_name": "Nancy Clarke",
      "email": "tonywalker@example.org",
      "id": "11111111-1111-4111-8111-111111111111",
      "is_archived": false,
      "is_test": false,
      "last_activity_at": "2026-04-07T15:05:00Z",
      "name": "Nancy Clarke",
      "parent_contact_id": "22222222-2222-4222-8222-222222222222",
      "phone": "+14155559664",
      "remote_id": "cust_ip66yv88",
      "remote_platform": "zendesk",
      "role": "Printmaker",
      "updated_at": "2026-04-07T15:12:00Z"
    }
  ]
}