List campaigns with filtering and pagination

Retrieves a paginated list of campaigns with comprehensive filtering options.

Filtering Options:

Text Search: Search across campaign name, reference, and description

Status Filtering: Filter by campaign status (InProgress, Paused, etc.)

State Filtering: Filter by campaign state (Created, InProgress, etc.)

Date Filtering: Filter by start date, end date, created date, updated date

User Filtering: Filter by owner, creator, supplier, printer

Type Filtering: Filter by campaign type and item type

Department Filtering: Filter by department associations

Publication Status: Filter by published/unpublished status

Sorting Options:

Sort by name, number, reference, dates, status, state

Ascending or descending order

Special Features:

Includes invite information for campaigns

Augments with publication status

Supports complex date range queries

Includes user population for proper references

curl --location --request GET 'https://prod.your-api-server.com/campaigns?limit=25&skip=0&sort=-updatedAt&search=Holiday 2024&status&status&state&state&publishedStatus=published&startDateFrom=2024-01-01&startDateTo=2024-12-31&endDateFrom=2024-01-01&endDateTo=2024-12-31&createdDateFrom=2024-01-01T00:00:00.000Z&createdDateTo=2024-12-31T23:59:59.999Z&owner=550e8400-e29b-41d4-a716-446655440000&createdBy=550e8400-e29b-41d4-a716-446655440001&campaignType=seasonal&campaignType=holiday&itemType=fashion&department=menswear&department=womenswear&isActive=true&isLocked=false' \ --header 'Authorization: <api-key>'

{ "campaignIds": [ "550e8400-e29b-41d4-a716-446655440000", "550e8400-e29b-41d4-a716-446655440001" ], "campaignEntities": { "property1": {}, "property2": {} }, "totalCount": 150, "limit": 25, "skip": 0 }

List campaigns with filtering and pagination

Request

Responses