Get Cashback Campaign List

GET 
https://api.cleverhub.co/api/v2/cashbacks/campaigns

Retrieves a paginated list of current cashback campaigns available on the site. This endpoint allows merchants to view and manage ongoing promotional cashback offers, including filtering by campaign status such as active, scheduled, or inactive. Detailed information about each campaign is provided, including tiers, schedule, applicable payment methods, and maximum cashback amounts.

Request

Query Parameters

page integer
The page number to retrieve in the paginated response. Defaults to 1 if not specified.
Default value: 1
Example: 1
per_page integer
The number of campaigns to display per page. Defaults to 10 if not specified.
Default value: 10
Example: 10
status string
Possible values: [active, scheduled, inactive]
Filter the list of cashback campaigns by their status. Possible values are 'active', 'scheduled', or 'inactive'.
Example: active

Responses

200

A successful response containing a list of cashback campaigns.

application/json

Schema

Schema

pageinteger
The current page number in the paginated response.
Example: 1
per_pageinteger
The number of campaigns displayed per page.
Example: 10
next_pageintegernullable
The page number of the next page, or null if there is no subsequent page.
Example: 2
total_pageinteger
The total number of pages available based on the current query.
Example: 5
total_countinteger
The total number of cashback campaigns matching the query parameters.
Example: 50
records object[]
An array of cashback campaign objects for the current page.
Array [
merchant_idinteger
The unique identifier of the merchant who created the campaign.
Example: 123
site_idstring
The unique identifier of the site where the campaign is active.
Example: site_123
campaign_idstring
The unique identifier of the cashback campaign.
Example: campaign_456
namestring
The descriptive name of the cashback campaign.
Example: Holiday Cashback Bonanza
max_payable_cashback_amount object
Specifies the maximum cashback amounts that can be paid out under various conditions.
in_whole_campaign_durationnumbernullable
The maximum total cashback amount for the entire duration of the campaign. Null indicates unlimited cashback availability over the campaign's duration.
Example: null
per_transactionnumbernullable
The maximum cashback amount that can be awarded per individual transaction. Null indicates no limit per transaction.
Example: 50
per_usernumbernullable
The maximum cashback amount that each user can receive throughout the entire campaign. Null indicates no per-user limit.
Example: 200
time_schedule_response object
The time schedule for the campaign, including start and end times, and any repeating schedule.
start_timedate-time
The start time of the campaign in ISO 8601 format (e.g., "2024-11-05T16:20:00.000Z").
Example: 2024-11-05T16:20:00.000Z
end_timedate-time
The end time of the campaign in ISO 8601 format (e.g., "2024-12-05T16:20:00.000Z").
Example: 2024-12-05T16:20:00.000Z
start_time_repeatstringnullable
The start time for any repeating cycles within the campaign in "HH:mm:ss" format. Null if there is no repeating schedule.
Example: 08:00:00
end_time_repeatstringnullable
The end time for any repeating cycles within the campaign in "HH:mm:ss" format. Null if there is no repeating schedule.
Example: 14:00:00
repeat_daysstring[]nullable
An array of days of the week on which the campaign repeats, represented as strings (e.g., ["Mon", "Wed", "Fri"]). Null if the campaign does not repeat.
Example: ["Mon","Wed","Fri"]
payment_methodsstring[]
A list of payment methods that are valid for the cashback program, such as 'pay_id', 'pay_to', and 'card'.
Example: ["pay_id","pay_to","card"]
statusstring
The current status of the campaign, indicating whether it is active, scheduled to start, or inactive.
Example: active
tiers object[]
A list of cashback tiers within the campaign, each defining specific cashback conditions and rewards.
Array [
idinteger
The unique identifier of the cashback tier.
Example: 3086
cashback_typestring
The type of cashback offered in this tier. Possible values are 'percentage' for a percentage-based cashback or 'absolute_amount' for a fixed cashback amount.
Example: percentage
cashback_valuenumber
The cashback value for this tier. For 'percentage' type, this represents a percentage (e.g., 10.0 for 10%). For 'absolute_amount', this is a fixed monetary value in the campaign's currency.
Example: 10
absolute_typestring
The condition type that must be met to qualify for cashback in this tier, such as 'min_order' for minimum order value.
Example: min_order
absolute_valuenumber
The minimum transaction amount required to be eligible for the cashback in this tier.
Example: 100
]
]

Example (auto)

{
  "page": 1,
  "per_page": 10,
  "next_page": 2,
  "total_page": 5,
  "total_count": 50,
  "records": [
    {
      "merchant_id": 123,
      "site_id": "site_123",
      "campaign_id": "campaign_456",
      "name": "Holiday Cashback Bonanza",
      "max_payable_cashback_amount": {
        "in_whole_campaign_duration": null,
        "per_transaction": 50,
        "per_user": 200
      },
      "time_schedule_response": {
        "start_time": "2024-11-05T16:20:00.000Z",
        "end_time": "2024-12-05T16:20:00.000Z",
        "start_time_repeat": "08:00:00",
        "end_time_repeat": "14:00:00",
        "repeat_days": [
          "Mon",
          "Wed",
          "Fri"
        ]
      },
      "payment_methods": [
        "pay_id",
        "pay_to",
        "card"
      ],
      "status": "active",
      "tiers": [
        {
          "id": 3086,
          "cashback_type": "percentage",
          "cashback_value": 10,
          "absolute_type": "min_order",
          "absolute_value": 100
        }
      ]
    }
  ]
}

400

Bad Request

401

Unauthorized

Authorization: app-id

name: app-idtype: apiKeyin: headerdescription: A unique identifier assigned to each application.

name: secret-keytype: apiKeyin: headerdescription: A secure token associated with the `app-id`.

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://api.cleverhub.co/api/v2/cashbacks/campaigns");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("app-id", "<app-id>");
request.Headers.Add("secret-key", "<app-id>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Base URL

https://api.cleverhub.co/api

Auth

app-id

secret-key

Parameters

page — query

per_page — query

status — query

---activescheduledinactive

ResponseClear

Click the Send API Request button above and see the response here!