Get a referral by ID

GET

/api/v2/referrals/{id}

Request

Path Params

Header Params

Responses

🟢200Success

application/json

Body

🔴500Server Error

🟠401Unauthorized

🟠422Parameter Error

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://aff-api.uppromote.com/api/v2/referrals/' \
--header 'Accept: application/json' \
--header 'Authorization: ****************************' \
--header 'Content-Type: application/json'

Response Example

200 - Example 1

{
    "status": 200,
    "message": "success",
    "data": {
        "id": 1781736,
        "order_id": 6439217201474,
        "order_number": 3833,
        "customer_id": "8680153416002",
        "quantity": 1,
        "total_sales": "1075.00",
        "commission_rule": {
            "program_id": 29486,
            "commission_rate": "50.00",
            "commission_type": "Percent Of Sale"
        },
        "commission_adjustment": "0.00",
        "status": "approved",
        "commission": "537.50",
        "refund_id": null,
        "tracking_type": "Tracked by coupon",
        "affiliate": {
            "id": 2029214,
            "email": "example@gmail.com",
            "first_name": "Example",
            "last_name": "Test"
        },
        "coupon_applied": "COUPON_NAME",
        "customer_email": "customer-name@gmail.com",
        "created_at": "2025-09-24T09:28:10Z"
    }
}

Modified at 2025-10-06 04:50:27

Get list referrals

Create a referral