Get referral orders

GET

/api/v1/referral

Retrieve a list of referral orders, or view detailed info for a specific referral, including the associated order, offer, and commission.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Query Params

Responses

🟢200Success

application/json

Body

🟠422Parameter Error

🔴500Server Error

🟠401Unauthorized

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET '/api/v1/referral?page=1&per_page=10&start_date=2024-01-11&end_date=2024-02-11&id=12345&shop_id=56789&referral_id=10262521' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Example 1

{
    "per_page": 10,
    "current_page": 1,
    "next_page_url": "string",
    "prev_page_url": "string",
    "from": 1,
    "to": 10,
    "data": [
        {
            "id": 0,
            "shop_id": 0,
            "offer_name": "Demo Store",
            "website": "https://demostore.myshopify.com",
            "referral_id": 0,
            "order_number": "6267135590722",
            "total_sales": "100.00",
            "commission_amount": "10.00",
            "currency": "USD",
            "created_at": "2023-01-11T18:06:03.000000Z",
            "sub_id1": "string",
            "sub_id2": "string",
            "sub_id3": "string",
            "status": "PENDING"
        }
    ]
}

Modified at 2025-07-04 07:14:47

Get affiliate links

Get payments