RErecruitwithatlas
People

Bulk identity feed for contact sync

Changed on

Use this endpoint to download a full list of contact details (phone numbers, email addresses, LinkedIn URLs, etc.) for everyone in your Atlas account - intended for syncing contacts into an external system such as a VOIP phone system or address book.

For example, a phone system integration could call this endpoint periodically to keep its contact list up to date, so that when a candidate calls in, their name automatically appears on screen.

How it works:

  • Results are returned in the order they were added to Atlas (oldest first), making it easy to pick up only what's new since your last sync
  • You can filter by updatedAfter to only fetch identities added or updated after a certain point
  • Results are paginated - if there are more results than fit in one response, hasMore will be true and you can fetch the next page

Important: This feed is designed for background syncing and caching, not for real-time lookups. You may occasionally receive duplicate entries - your system should handle this by updating existing records rather than creating duplicates (known as an "upsert"). Use the identityId field as the unique key when doing so.

Syncing opt-outs: every row carries active and inactiveReason, and inactive identities are included. Poll with updatedAfter set to the time of your last sync - marking an address unsubscribed updates its updatedAt, so every opt-out since then is in the feed.

get/api/v1/people/identities

Request

Query parameters

pageinteger

Page number (1-indexed)

Example:1
pageSizeinteger

Items per page (max 100)

Example:25
perPageinteger

Alias for pageSize

string
OR
string date-time
string
OR
string date-time
string
OR
string date-time
string
OR
string date-time

Response

Paginated list of contact identities

status'ok' required
pageinteger required

Use pagination.page instead

pageSizeinteger required

Use pagination.pageSize instead

hasMoreboolean required

Use pagination instead

Example response

{
  "data": [
    {
      "type": "phone",
      "value": "+447786267677",
      "inactiveReason": "unsubscribed",
      "person": {
        "firstName": "Jordan",
        "lastName": "Shlosberg"
      }
    }
  ],
  "pagination": {
    "page": 1,
    "pageSize": 100,
    "total": 500,
    "totalPages": 5
  }
}

Changes

  • 158ee454751cRevision changes
    • warning

      added the new undefined enum value to the // response property for the response status

  • b7e1215476a1Revision changes
    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status