younifyd
Menu

List Collections

List collections in campaign

GET/v1/applications/{applicationId}/campaigns/{campaignId}/collections

Use it in a workflow

  1. Add a step and choose the Talon.One connector.
  2. Pick the List Collections action (under management).
  3. Fill in the fields below, then reference the result from later steps as {{listCollections.response.data}}.

Request

Path parameters

applicationIdinteger (int64)required

The ID of the Application. It is displayed in your Talon.One deployment URL.

campaignIdinteger (int64)required

The ID of the campaign. It is displayed in your Talon.One deployment URL.

Query parameters

pageSizeinteger (int64)

The number of items in the response.

Default 1000

skipinteger (int64)

The number of items to skip when paging through large result sets.

sortstring

The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.

withTotalResultSizeboolean

When this flag is set, the result includes the total number of results for this query. This might decrease performance on large data sets. - When `true`: `totalResultSize` contains the total number of results for this query. - When `false`: Only `hasMore` is returned, and it is set to `true` when there are more results than shown on the page.

namestring

Filter by collection name.

Response

Returns 200 with an object. Read it in later steps with {{listCollections.response.data.<field>}}.

hasMoreboolean
totalResultSizeinteger (int64)
dataarray<object>
idinteger (int64)required

The internal ID of this entity.

createdstring (date-time)required

The time this entity was created.

accountIdinteger (int64)required

The ID of the account that owns this entity.

modifiedstring (date-time)required

The time this entity was last modified.

descriptionstring

A short description of the purpose of this collection.

subscribedApplicationsIdsarray<integer (int64)>

A list of the IDs of the Applications where this collection is enabled.

namestringrequired

The name of this collection.

modifiedByinteger (int64)

ID of the user who last updated this effect if available.

createdByinteger (int64)required

ID of the user who created this effect.

applicationIdinteger (int64)

The ID of the Application that owns this entity.

campaignIdinteger (int64)

The ID of the campaign that owns this entity.

json
{
  "data": [
    {
      "accountId": 3886,
      "createdBy": 134,
      "created": {},
      "campaignId": 7,
      "subscribedApplicationsIds": [
        1,
        2,
        3
      ],
      "name": "My collection",
      "modified": {},
      "description": "My collection of SKUs",
      "modifiedBy": 48,
      "id": 6,
      "applicationId": 1
    }
  ],
  "hasMore": false,
  "totalResultSize": 1
}

Need more? See the Talon.One guide for connection setup and behaviour shared by every action.