Look up a collection

Last update: 2023-10-18
  • Created for:
  • Experienced

Collections are subsets of offers based on predefined conditions defined by a marketer, such as category of the offer.

You can look up specific collections by making a GET request to the Offer Library API that includes the collection id in the request path.

API format

GET /{ENDPOINT_PATH}/offer-collections/{ID}
Parameter Description Example
{ENDPOINT_PATH} The endpoint path for persistence APIs. https://platform.adobe.io/data/core/dps/
{ID} The id of the entity you wish to look up. offerCollection1234


curl -X GET 'https://platform.adobe.io/data/core/dps/offer-collections/offerCollection1234' \
-H 'Accept: *,application/json' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {IMS_ORG}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'


A successful response returns the details of the collection including information about your unique collection id.

        "created": "2022-09-16T18:59:23.063+00:00",
    "modified": "2022-09-16T18:59:23.063+00:00",
    "etag": 1,
    "schemas": [
    "createdBy": "{CREATED_BY}",
    "lastModifiedBy": "{MODIFIED_BY}",
    "id": "offerCollection1234",
    "name": "Test Collection with tags",
    "filterType": "any-tags",
    "ids": [
    "labels": [

On this page