Guest REST API v2 (legacy)

Retrieve guests (legacy)

Important

A newer version of this REST API (v2.1) is available. If you're new to this REST API, use the new version. Alternatively, if you're already using the old version, read about the differences between v2 and v2.1 so you can upgrade.

GET /v2/guests

Retrieves guests using their email address or other identifying information.

In the response, in items.href, the guest reference is the string that follows the final slash:

"href": "<baseURL>/v2/guests/<guestRef>"

You use the guest reference to interact with the full guest record, for example, to retrieve or update it.

You can also use the guest reference to find data about the guest in Sitecore CDP. In Sitecore CDP, click Guests. In the Search field, enter the guest reference. Then, Sitecore CDP lists the guest profile for the guest.

Retrieve guests by email:

curl -X GET '<baseURL>/v2/[email protected]' \
-u '<username>:<password>' \
-H 'Accept: application/json'

{
  "href": "<baseURL>/v2/guests?offset=0&limit=10&[email protected]",
  "offset": 0,
  "limit": 10,
  "items": [
      {
          "href": "<baseURL>/v2/guests/f7aabbca-1c1b-4fc2-be72-3e16294a4f03"
      }
  ]
}

Retrieve guests by identifiers:

curl -X GET '<baseURL>/v2/guests?identifiers.provider=BXLP&identifiers.id=123456' \
-u '<username>:<password>' \
-H 'Accept: application/json'

{
  "href": "<baseURL>/v2/guests?offset=0&limit=10&identifiers.provider=BXLP&identifiers.id=123456",
  "offset": 0,
  "limit": 10,
  "items": [
      {
          "href": "<baseURL>/v2/guests/f7aabbca-1c1b-4fc2-be72-3e16294a4f03"
      }
  ]
}

Customize the request

You can search the collection using the following query parameters:

firstName
lastName
email
email.untouched
phoneNumber
identifiers.provider plus identifiers.id
identityStatus

If you have suggestions for improving this article, let us know!