> ## Documentation Index > Fetch the complete documentation index at: https://docs.rc.cleverhub.co/llms.txt > Use this file to discover all available pages before exploring further. # Get Cashback Campaign List > 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. ## OpenAPI ````yaml /api/openapi/cashback-reference.yaml get /v2/cashbacks/campaigns openapi: 3.0.3 info: title: Cashback APIs description: >- ## Introduction The Cashback API Solution offers a streamlined way for developers to manage cashback campaigns, account activations, and withdrawals, providing a seamless user experience. ### Key Features - **Campaign Management**: - **Get Cashback Campaign List**: Retrieve a list of all available cashback campaigns. - **Get Campaign Configurations**: Retrieve detailed configurations for specific cashback campaigns. - **User Cashback Management**: - **Activate User's Cashback Account**: Activate a cashback account for a user. - **Initiate Cashback Delivery**: Initiate the delivery of cashback to a user. - **Initiate Cashback Withdrawal**: Begin the process of withdrawing cashback to a user's account. - **User Information**: - **Get User List**: Retrieve a list of users with cashback accounts. This documentation provides detailed guidance for integrating these capabilities into your application. version: 2.0.0 termsOfService: https://helloclever.co/terms contact: email: support@helloclever.co servers: - url: https://api.cleverhub.co/api description: Sandbox Environment - url: https://api-merchant.helloclever.co/api description: Production Environment security: [] paths: /v2/cashbacks/campaigns: get: tags: - Cashback summary: Get Cashback Campaign List description: > 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. parameters: - in: query name: page schema: type: integer default: 1 description: >- The page number to retrieve in the paginated response. Defaults to 1 if not specified. example: 1 - in: query name: per_page schema: type: integer default: 10 description: >- The number of campaigns to display per page. Defaults to 10 if not specified. example: 10 - in: query name: status schema: type: string enum: - active - scheduled - inactive description: >- Filter the list of cashback campaigns by their status. Possible values are 'active', 'scheduled', or 'inactive'. example: active responses: '200': description: A successful response containing a list of cashback campaigns. content: application/json: schema: type: object properties: page: type: integer description: The current page number in the paginated response. example: 1 per_page: type: integer description: The number of campaigns displayed per page. example: 10 next_page: type: integer nullable: true description: >- The page number of the next page, or null if there is no subsequent page. example: 2 total_page: type: integer description: >- The total number of pages available based on the current query. example: 5 total_count: type: integer description: >- The total number of cashback campaigns matching the query parameters. example: 50 records: type: array description: >- An array of cashback campaign objects for the current page. items: type: object properties: merchant_id: type: integer description: >- The unique identifier of the merchant who created the campaign. example: 123 site_id: type: string description: >- The unique identifier of the site where the campaign is active. example: site_123 campaign_id: type: string description: The unique identifier of the cashback campaign. example: campaign_456 name: type: string description: The descriptive name of the cashback campaign. example: Holiday Cashback Bonanza max_payable_cashback_amount: type: object description: >- Specifies the maximum cashback amounts that can be paid out under various conditions. properties: in_whole_campaign_duration: type: number nullable: true description: >- 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_transaction: type: number nullable: true description: >- The maximum cashback amount that can be awarded per individual transaction. Null indicates no limit per transaction. example: 50 per_user: type: number nullable: true description: >- The maximum cashback amount that each user can receive throughout the entire campaign. Null indicates no per-user limit. example: 200 time_schedule_response: type: object description: >- The time schedule for the campaign, including start and end times, and any repeating schedule. properties: start_time: type: string format: date-time description: >- 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_time: type: string format: date-time description: >- 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_repeat: type: string nullable: true description: >- 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_repeat: type: string nullable: true description: >- 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_days: type: array items: type: string nullable: true description: >- 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_methods: type: array description: >- A list of payment methods that are valid for the cashback program, such as 'pay_id', 'pay_to', and 'card'. items: type: string example: - pay_id - pay_to - card status: type: string description: >- The current status of the campaign, indicating whether it is active, scheduled to start, or inactive. example: active tiers: type: array description: >- A list of cashback tiers within the campaign, each defining specific cashback conditions and rewards. items: type: object properties: id: type: integer description: The unique identifier of the cashback tier. example: 3086 cashback_type: type: string description: >- 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_value: type: number description: >- 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_type: type: string description: >- 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_value: type: number description: >- The minimum transaction amount required to be eligible for the cashback in this tier. example: 100 '400': description: Bad Request '401': description: Unauthorized security: - app-id: [] secret-key: [] components: securitySchemes: app-id: type: apiKey in: header name: app-id description: | A unique identifier assigned to each application. secret-key: type: apiKey in: header name: secret-key description: | A secure token associated with the `app-id`. ```` ## Related topics - [Drive Loyalty with Cashback Campaigns](/developer-reference/api-use-cases/drive-loyalty-with-cashback-campaigns.md) - [Get Campaign Configurations](/api/cashback/get-campaign-configurations.md) - [Cashback API Overview](/api/cashback/overview.md)