personalizer.io Documentation

Help Page Home

GET v1/CuratedCollections?keyword={keyword}&status={status}

Request Information

URI Parameters

NameTypeDescriptionComments
keyword string

status CuratedCollectionStatus

Body Parameters

None.

Response Information

Resource Description

Collection of CuratedCollection
NameTypeDescriptionComments
Guid globally unique identifier

SubscriberGuid globally unique identifier

StartingCollectionID integer

StartingCollectionTitle string

FallbackVariationGuid globally unique identifier

Status CuratedCollectionStatus

StatusDate date

CreateDate date

VersionDate date

Variations Collection of CuratedCollectionVariation

Response Formats

application/json, text/json

Sample:
[
  {
    "Guid": "0f04f504-b56c-42bf-95c5-ebec50d1ff4b",
    "SubscriberGuid": "21f3fdd6-8b86-41d3-bbd8-bdcdcd0c8652",
    "StartingCollectionID": 3,
    "StartingCollectionTitle": "sample string 4",
    "FallbackVariationGuid": "091e3abb-65f0-405d-8e59-63f1a9e5934d",
    "Status": "Unpublished",
    "StatusDate": "2020-10-27T12:41:57.9911836+00:00",
    "CreateDate": "2020-10-27T12:41:57.9911836+00:00",
    "VersionDate": "2020-10-27T12:41:57.9911836+00:00",
    "Variations": [
      {
        "Guid": "708d24b2-aaef-44f7-b6cd-21d9fa7e5454",
        "Title": "sample string 2",
        "UserSegmentGuids": [
          "cec913a3-8e62-4307-966b-948f4dfdf99d",
          "468495e9-79d1-406d-90f0-b443ced570eb"
        ],
        "ProductCollectionIDs": [
          1,
          2
        ],
        "ProductSegmentGuids": [
          "9f7a8204-cf16-4f8d-8464-5543dabd7629",
          "4263df50-4a64-4151-8b96-8b918eea614d"
        ],
        "Sorting": "Original",
        "Limit": 3,
        "PinnedProductIDs": [
          1,
          2
        ]
      },
      {
        "Guid": "708d24b2-aaef-44f7-b6cd-21d9fa7e5454",
        "Title": "sample string 2",
        "UserSegmentGuids": [
          "cec913a3-8e62-4307-966b-948f4dfdf99d",
          "468495e9-79d1-406d-90f0-b443ced570eb"
        ],
        "ProductCollectionIDs": [
          1,
          2
        ],
        "ProductSegmentGuids": [
          "9f7a8204-cf16-4f8d-8464-5543dabd7629",
          "4263df50-4a64-4151-8b96-8b918eea614d"
        ],
        "Sorting": "Original",
        "Limit": 3,
        "PinnedProductIDs": [
          1,
          2
        ]
      }
    ]
  },
  {
    "Guid": "0f04f504-b56c-42bf-95c5-ebec50d1ff4b",
    "SubscriberGuid": "21f3fdd6-8b86-41d3-bbd8-bdcdcd0c8652",
    "StartingCollectionID": 3,
    "StartingCollectionTitle": "sample string 4",
    "FallbackVariationGuid": "091e3abb-65f0-405d-8e59-63f1a9e5934d",
    "Status": "Unpublished",
    "StatusDate": "2020-10-27T12:41:57.9911836+00:00",
    "CreateDate": "2020-10-27T12:41:57.9911836+00:00",
    "VersionDate": "2020-10-27T12:41:57.9911836+00:00",
    "Variations": [
      {
        "Guid": "708d24b2-aaef-44f7-b6cd-21d9fa7e5454",
        "Title": "sample string 2",
        "UserSegmentGuids": [
          "cec913a3-8e62-4307-966b-948f4dfdf99d",
          "468495e9-79d1-406d-90f0-b443ced570eb"
        ],
        "ProductCollectionIDs": [
          1,
          2
        ],
        "ProductSegmentGuids": [
          "9f7a8204-cf16-4f8d-8464-5543dabd7629",
          "4263df50-4a64-4151-8b96-8b918eea614d"
        ],
        "Sorting": "Original",
        "Limit": 3,
        "PinnedProductIDs": [
          1,
          2
        ]
      },
      {
        "Guid": "708d24b2-aaef-44f7-b6cd-21d9fa7e5454",
        "Title": "sample string 2",
        "UserSegmentGuids": [
          "cec913a3-8e62-4307-966b-948f4dfdf99d",
          "468495e9-79d1-406d-90f0-b443ced570eb"
        ],
        "ProductCollectionIDs": [
          1,
          2
        ],
        "ProductSegmentGuids": [
          "9f7a8204-cf16-4f8d-8464-5543dabd7629",
          "4263df50-4a64-4151-8b96-8b918eea614d"
        ],
        "Sorting": "Original",
        "Limit": 3,
        "PinnedProductIDs": [
          1,
          2
        ]
      }
    ]
  }
]