Retrieve a guest's collection of data extensions

Request

Retrieves the URLs for each of the guest's data extensions.

We recommend that you retrieve the URLs using the expand=true query parameter to check that the keys you intend to create when you Create a data extension are unique. This is because keys must be unique across all data extensions within a guest profile.

In the response, each URL in items.href corresponds to one data extension. Use this URL to interact with the guest's data extension, for example, to retrieve or update it.

Security

BasicAuth

Path

guestRefstringrequired

The guest reference. This is a unique identifier of the guest record. If you don't know the guest reference, first retrieve guests.

Example:f7aabbca-1c1b-4fc2-be72-3e16294a4f03

Query

offsetobject(Offset)

Collection responses use offset pagination. The offset query parameter is used to exclude from a response the first N items of the entire resource collection.

Default:"0"

Example:offset=10

limitobject, [ 10 .. 100 ](Limit)

Collection responses use offset pagination. This query parameter lets you adjust the maximum number of collection items to return for a single request.

Default:"10"

Example:limit=40

expandArray of strings(Expand)

You can expand items in a collection by setting expand=true. This eliminates the need to send multiple follow-up requests (one for the collection and another for each of its items). This also helps you check if the data you intend to create already exists.

Default:"false"

Example:expand=true

curl -i -X GET \
  -u '<username>:<password>' \
  'https://api-engage-ap.sitecorecloud.io/v2.1/guests/f7aabbca-1c1b-4fc2-be72-3e16294a4f03/extensions?offset=10&limit=40&expand=true'

Responses

Successful operation

Bodyapplication/json

hrefstring

Request's URL.

Example:"https://api-engage-eu.sitecorecloud.io/v2.1/guests/f7aabbca-1c1b-4fc2-be72-3e16294a4f03/extensions?offset=0&limit=10"

itemsArray of objects(GuestExtensionLink)

limitinteger, (int32)

Request's limit.

Example:10

offsetinteger, (int32)

Request's offset.

Example:0

Response

{
  "href": "https://api-engage-eu.sitecorecloud.io/v2.1/guests/f7aabbca-1c1b-4fc2-be72-3e16294a4f03/extensions?offset=0&limit=10",
  "items": [
    { … }
  ],
  "limit": 10,
  "offset": 0
}