List campaigns
GET {{baseUrl}}/v1/applications/:applicationId/campaigns?pageSize=1000&skip=10&sort=value&campaignState=expired&name=value&tags=value&createdBefore=2022-11-08T00:11:22.082Z&createdAfter=2022-11-08T00:11:22.082Z&campaignGroupId=10&templateId=10&storeId=10
List the campaigns of the specified application that match your filter criteria.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
pageSize | number | The number of items in this response. | |
skip | number | The number of items to skip when paging through large result sets. | |
sort | string | 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: This parameter works only with numeric fields.
|
| campaignState | string | | Filter results by the state of the campaign.
enabled: Campaigns that are scheduled, running (activated), or expired.running: Campaigns that are running (activated).disabled: Campaigns that are disabled.expired: Campaigns that are expired.archived: Campaigns that are archived.draft: Campaigns that are drafts. | |name| string | | Filter results performing case-insensitive matching against the name of the campaign. | |tags| string | | Filter results performing case-insensitive matching against the tags of the campaign. When used in conjunction with the "name" query parameter, a logical OR will be performed to search both tags and name for the provided values | |createdBefore| string | | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the campaign creation timestamp. You can use any timezone. Talon.One will convert to UTC internally. | |createdAfter| string | | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the campaign creation timestamp. You can use any timezone. Talon.One will convert to UTC internally. | |campaignGroupId| number | | Filter results to campaigns owned by the specified campaign group ID. | |templateId| number | | The ID of the Campaign Template this Campaign was created from. | |storeId| number | | Filter results to campaigns linked to the specified store ID. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |