Get affiliates

GET

/api/v2/affiliates

The email_verified field accepts the values verified and unverified.
The status field accepts the values active, inactive, pending.

Request

Query 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/affiliates?affiliate_email=example@gmail.com' \
--header 'Accept: application/json' \
--header 'Authorization: ****************************' \
--header 'Content-Type: application/json'

Response Example

200 - Example

{
    "status": 200,
    "message": "success",
    "data": [
        {
            "id": 2011818,
            "email": "t1324.enactusneu+5@gmail.com",
            "first_name": "Johnny",
            "last_name": "Test",
            "status": "active",
            "email_verified": "verified",
            "company": "UpPromote",
            "address": "Han Hollanderlaan 1",
            "city": "Amsterdam",
            "state": null,
            "zipcode": "1067 BB",
            "country": "NL",
            "phone": "012345678",
            "facebook": "https://www.facebook.com/example",
            "twitter": "example123",
            "youtube": "example",
            "instagram": "example.ig",
            "created_at": "2025-07-11T11:05:26Z",
            "default_affiliate_link": "https://viet-hoang-secom.myshopify.com?sca_ref=2011818.",
            "custom_affiliate_link": "https://viet-hoang-secom.myshopify.com/nguyen",
            "program_id": 28048,
            "program_name": "Standard Affiliate Commissionn",
            "custom_fields": [],
            "coupons": [
                "TEST123"
            ],
            "vat_number": "1239081283",
            "tax_value": 0,
            "up_line_affiliate_id": null,
            "up_line_affiliate_email": null,
            "payment_method": "paytm",
            "payment_info": {
                "number": "2715500356"
            },
            "paid_amount": 122.39,
            "approved_amount": 50,
            "pending_amount": 267.56,
            "denied_amount": 0
        }
    ]
}

Modified at 2025-10-06 04:38:36

API overview

Get affiliate by ID