v1

latestOpenAPI 3.1.0MIT2026-07-26121931.0 KB

Returns all campaigns from the system that the user has access to

get/affiliate/campaigns

Query parameters

pageinteger

Page number for pagination

limitinteger

Maximum number of results per page (default: 10, max: 20)

typesstring[]

Campaign types to filter

offerTypestring[]

Type of offer to filter. If not provided, all offers will be returned.

Spreadsheet: Spreadsheet offer type. In this case, links will not be generated automatically. You need to use the POST /affiliate/shortener/url endpoint to generate links by passing the campaign id as a parameter through featureId.

Url: Link offer type. In this case, links will be generated automatically.

organizationIdstring

Brand identifier to filter campaigns

organizationIdsstring[]

List of brand identifiers to filter campaigns

namestring

Campaign name to search for

isHighlightboolean

Filter campaigns by highlight status

categoriesstring[]

List of categories to filter campaigns

statusstring[]

Filter campaigns by status. Accepts multiple values separated by comma.

onTime: Active campaign within period.

expired: Campaign expired (period.endAt has passed).

scheduled: Campaign scheduled (period.startAt has not arrived yet).

Example: status=onTime,expired

startAtstring date

Campaign start date

endAtstring date

Campaign end date

Campaign period filter

startAtstring date-time

Campaign start date (ISO 8601). Must be used together with endAt.

endAtstring date-time

Campaign end date (ISO 8601). Must be used together with startAt.

Response

Campaign response