Get Affiliate(s)

Returns an affiliate by ID or email, or all affiliates for the program. Affiliate objects include an affiliateLinks array with every link slug for that affiliate. The legacy link field on the affiliate is deprecated and is usually null—use affiliateLinks instead.

GET /affiliates

Get all affiliates or by ID/email

cURL

curl --request GET \
  --url https://www.referly.so/api/v1/affiliates \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://www.referly.so/api/v1/affiliates"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://www.referly.so/api/v1/affiliates', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://www.referly.so/api/v1/affiliates",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://www.referly.so/api/v1/affiliates"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://www.referly.so/api/v1/affiliates")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://www.referly.so/api/v1/affiliates")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "firstName": "<string>",
    "lastName": "<string>",
    "name": "<string>",
    "email": "[e-mail]",
    "password": "<string>",
    "emailVerified": true,
    "image": "<string>",
    "detailsComplete": true,
    "programId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "payoutEmail": "[e-mail]",
    "paymentMethod": "<string>",
    "commissionRate": 123,
    "link": "<string>",
    "affiliateLinks": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "link": "<string>",
        "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "programId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      }
    ],
    "status": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "numberOfReferredUsers": 123,
    "numberOfClicks": 123,
    "totalCommissionEarned": 123
  }
]

{
  "error": 123,
  "message": "<string>"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

id · string<uuid>

Affiliate user ID (UUID), numeric click ID, or an affiliate link slug for this program

email · string<email>

The email of the affiliate to retrieve

Response

200

application/json

A list of affiliates or a single affiliate

id · string<uuid>

The affiliate ID

firstName · string

First name of the affiliate

lastName · string

Last name of the affiliate

name · string | null

Full name of the affiliate (optional)

email · string<email>

Email of the affiliate

password · string | null · deprecated

Hashed Password of the affiliate (optional)

emailVerified · boolean | null

Flag to indicate if the email has been verified

image · string | null

Profile image URL of the affiliate

detailsComplete · boolean

Flag to indicate if affiliate details are complete

programId · string<uuid>

The program ID that the affiliate is associated with

payoutEmail · string<email>

Email to be used for payouts

paymentMethod · string

Payment method for the affiliate (e.g., WISE)

commissionRate · number<float>

Commission rate for the affiliate (0 - 100)

link · string | null · deprecated

Deprecated legacy field; often null. Use affiliateLinks for all link slugs.

affiliateLinks · object[]

All affiliate link records for this affiliate. This is the source of truth for referral link slugs.

Show child attributes

status · string

Status of the affiliate (active/inactive)

createdAt · string<date-time>

Timestamp when the affiliate was created

updatedAt · string<date-time>

Timestamp when the affiliate was last updated

numberOfReferredUsers · integer

Number of users referred by the affiliate

numberOfClicks · integer

Number of clicks generated by the affiliate

totalCommissionEarned · number<float>

Total commission earned by the affiliate