RErecruitwithatlas
People

Get identities for a person

Changed on

Use this endpoint to retrieve all contact details (known as "identities") stored against a specific person in Atlas.

In Atlas, a person can have multiple ways of being contacted - for example, two email addresses, a mobile number, and a LinkedIn profile. Each of these is stored as a separate "identity". This endpoint returns all of them for a given person.

To use it, you need the person's Atlas ID (a unique identifier, returned by other endpoints like Search or Lookup). You can optionally filter the results to only return a specific type - for example, only phone numbers or only emails.

Each identity returned includes its identityId, its type (e.g. email, phone, linkedin), its value (e.g. john@example.com), whether it is currently active, and - when it is not - the inactiveReason (unsubscribed, bounced, suppressed or other). Inactive identities are included, unlike on GET /api/v1/people/{id}, which lists active identities only.

get/api/v1/people/{personId}/identities

Request

Path parameters

personIdstring uuid required

Person ID

Example:123e4567-e89b-12d3-a456-426614174000

Query parameters

typestring

Comma-separated identity types to filter by

Example:email,phone

Response

Person identities

status'ok' required

Example response

{
  "data": [
    {
      "identityId": "6f1c2d3e-4b5a-4c6d-8e7f-9a0b1c2d3e4f",
      "inactiveReason": "unsubscribed"
    }
  ]
}

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