Getting StartedAPI Reference
Getting StartedAPI Reference
Help Center
Login
  1. Comissions
  • Campaigns
    • Get All Campaigns
      GET
    • Get Campaign By ID
      GET
    • Create campaign
      POST
    • Update campaign
      PUT
    • Delete campaign
      DELETE
  • Affiliates
    • List affiliates
      GET
    • Get Affiliate By ID
      GET
    • Create Affiliate
      POST
    • Update Affiliate
      PUT
    • Delete Affiliate
      DELETE
  • Affiliate Links
    • Get Affiliate Link By Affiliate ID
      GET
    • Create Affiliate Link
      POST
    • Delete Affiliate Link
      DELETE
  • Comissions
    • Get All Commissions
      GET
    • Get Commission By ID
      GET
    • Create Commision
      POST
    • Update Commision
      PUT
    • Delete Commision
      DELETE
  • Referred Users
    • Get All Referred Users
      GET
    • Get Referred User by Email
      GET
    • Create Referred User
      POST
    • Update Referred User
      PUT
    • Delete Referred User
      DELETE
Getting StartedAPI Reference
Getting StartedAPI Reference
Help Center
Login
  1. Comissions

Get All Commissions

GET
/commissions/list
Last modified:2025-12-30 08:26:10
Retrieves a paginated list of commissions for a specific campaign.
Supports optional filtering by affiliate, referred user, and commission status.

Request

Query Params

Header Params

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/commissions/list?campaignId=8b9cd67a-bc33-468f-bf31-2c3d25f56748&page=1&limit=50&affiliateId=d3a1153d-cb87-4644-8429-7ecf1a7c3257&referredUser=john@example.com&status&orderType=createdAt&orderValue=ASC or DESC' \
--header 'x-auth-referralstack: rs_live_e6761c15744c9be53be18802278fd3da751d03ce'

Responses

🟢200Success
application/json
Body

Example
{
  "status": 200,
  "message": "Commissions fetched successfully",
  "data": {
    "items": [
      {
        "commissionId": "725cf3e1-c61d-4c3e-902d-6cdd5bbf7ee6",
        "campaignId": "9112d17b-0c77-45ab-a82f-f963f135b63d",
        "workspaceId": "5bb8cbe6-67dc-4b07-853e-7ca5454f8512",
        "affiliateId": "c56896de-b596-4715-b747-0f10686d1eab",
        "referredUser": "john@example.com",
        "amount": "30.00",
        "adminEarnedAmount": "200.00",
        "status": "pending",
        "createdAt": "2025-10-13T05:32:50.638Z",
        "updatedAt": "2025-12-12T06:09:31.433Z"
      }
    ],
    "pagination": {
      "page": 1,
      "limit": 25,
      "total": 7,
      "totalPages": 1
    }
  }
}
🟠400Bad Request
🟠401Unauthorized (Missing API Key)
Modified at 2025-12-30 08:26:10
Previous
Delete Affiliate Link
Next
Get Commission By ID
Built with