GET
Get Cashback Campaign List

Authorizations

app-id
string
header
required

A unique identifier assigned to each application.

secret-key
string
header
required

A secure token associated with the app-id.

Query Parameters

page
integer
default:1

The page number to retrieve in the paginated response. Defaults to 1 if not specified.

per_page
integer
default:10

The number of campaigns to display per page. Defaults to 10 if not specified.

status
enum<string>

Filter the list of cashback campaigns by their status. Possible values are 'active', 'scheduled', or 'inactive'.

Available options:
active,
scheduled,
inactive

Response

A successful response containing a list of cashback campaigns.

page
integer

The current page number in the paginated response.

Example:

1

per_page
integer

The number of campaigns displayed per page.

Example:

10

next_page
integer | null

The page number of the next page, or null if there is no subsequent page.

Example:

2

total_page
integer

The total number of pages available based on the current query.

Example:

5

total_count
integer

The total number of cashback campaigns matching the query parameters.

Example:

50

records
object[]

An array of cashback campaign objects for the current page.