Retrieve a list of promotions according to filters

get

https://management.uniqodo.io/v2/promotion/find

Find multiple promotions using a set of fields to filter the result.

Multiple parameters will be treated as an 'AND' condition - only promotions matching all the parameters will be returned. By default, active promotions that have not ended will be returned where no filters are supplied.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

status

string

enum

Use to match the status of the promotions.

Allowed:

title

string

Use to fully or partially match the title of the promotions. Case insensitive.

externalPartnerId

string

Use to match promotions assigned to a specific external partner ID.

externalUserId

string

Use to match promotions assigned to a specific external user ID.

userId

integer

Use to match promotions created by a specific Uniqodo user ID.

timeStatus

string

enum

Use to match promotions by their time-relative state, evaluated against the current time:

live — the promotion has started and has not yet ended (startsAt <= now < endsAt).
scheduled — the promotion has not started yet (startsAt > now).
expired — the promotion has already ended (endsAt <= now).

This filter is independent of status. Combine the two when needed — for example, status=paused&timeStatus=live to retrieve promotions that are live in respect of time (startDate - endDate range) but paused. Consequently, to retrieve a list of active and live promotions use status=active&timeStatus=live.

Allowed:

orderBy

string

enum

Use to define the order in which promotions are returned in the response.

Allowed:

limit

number

≤ 50

Limit the number of promotions to be returned. Default maximum and highest value: 50.

Responses

200OK

400Bad request - there was a problem with the request