List all affiliate partners

GET https://api.tamio.com/v2/affiliates/list

Returns a paginated list of affiliate partners. Supports filtering by status, country, affiliate program, automation, date range, and text search.

Query Parameters

page integer*

Page number for pagination (1-based).

per_page integer*

Number of affiliate partners to return per page.

order string

Sort order for the results.

ascdesc

filter string

Text filter to search affiliate partners by name or email.

sort_by string

Field to sort results by.

nameemailcountrycreated_at

from object

Start date filter (ISO 8601 string or Unix timestamp).

to object

End date filter (ISO 8601 string or Unix timestamp).

affiliate_program_id string

Filter by a specific affiliate program UUID.

automation_id string

Filter by a specific automation UUID.

status string

Filter by application status.

approvedpending

countries array of string

Array of country codes to filter by (1–120 unique values).

Responses

200 Paginated list of affiliate partners.

Paginated list of affiliate partners.

status integer

total_results integer

Total number of matching affiliate partners.

affiliates array of Affiliate

object string

email string

name string

surname string

address string

city string

state string

country string

postcode string

vat string

telephone string

billing_information object

Full billing/business information object for this affiliate.

id string

bonus integer

Accumulated bonus amount in the smallest currency unit.

approved boolean

date_joined integer

Unix timestamp of when the affiliate joined the program.

language string

Dashboard locale of the affiliate partner.

payments array of string

Payment gateways available for this affiliate.

has_notes boolean

Whether the affiliate has any merchant notes.

sales integer

Total number of sales attributed to this affiliate.

referrals integer

Total number of unique referrals.

affiliate_program_id string

UUID of the affiliate program this partner belongs to.

affiliate_program_label string

Label of the affiliate program.

currency string

Currency code for commission payments.

balance integer

Current available payout balance in the smallest currency unit.

400 Validation or business logic error. Possible causes:

Validation or business logic error. Possible causes:

page or per_page is not an integer or exceeds maximum
order is not one of asc, desc
sort_by is not one of name, email, country, created_at
status is not one of approved, pending
filter exceeds 120 characters
from / to is not a valid date format
affiliate_program_id or automation_id is not a valid UUID
countries is empty, exceeds 120 items, has duplicates, or contains invalid codes
Additional properties present

Error codes:

Code	Description
1002	Affiliate program or automation not found

status integer

error string

error_code integer

401 Missing or invalid Bearer token.

Retrieve an affiliate partner

/affiliates/list

1 const response = await fetch("https://api.tamio.com/v2/affiliates/list", {
2   headers: {
3     "Authorization": "Bearer YOUR_API_KEY",
4     "Accept": "application/json"
5   }
6 });
7 const data = await response.json();

1 require "uri"
2 require "net/http"
3 
4 url = URI("https://api.tamio.com/v2/affiliates/list")
5 
6 https = Net::HTTP.new(url.host, url.port)
7 https.use_ssl = true
8 
9 request = Net::HTTP::Get.new(url)
10 request["Accept"] = "application/json"
11 request["Authorization"] = "Bearer YOUR_API_KEY"
12 
13 response = https.request(request)
14 puts response.read_body

Responses

{
  "status": 200,
  "total_results": 42,
  "affiliates": [
    {
      "object": "affiliate",
      "email": "[email protected]",
      "name": "Jane",
      "surname": "Doe",
      "address": "123 Main Street",
      "city": "London",
      "state": "England",
      "country": "GB",
      "postcode": "SW1A 1AA",
      "vat": "GB123456789",
      "telephone": "+44 20 7946 0958",
      "billing_information": {
        "name": "Jane Doe",
        "email": "[email protected]",
        "address": "123 Main Street",
        "city": "London",
        "country": "GB",
        "postcode": "SW1A 1AA"
      },
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "bonus": 500,
      "approved": true,
      "date_joined": 1706140800,
      "language": "en",
      "payments": [
        "stripe",
        "paypal"
      ],
      "has_notes": false,
      "sales": 42,
      "referrals": 18,
      "affiliate_program_id": "f0e1d2c3-b4a5-6789-0fed-cba987654321",
      "affiliate_program_label": "Default Program",
      "currency": "USD",
      "balance": 15000
    }
  ]
}

1	const response = await fetch("https://api.tamio.com/v2/affiliates/list", {
2	headers: {
3	"Authorization": "Bearer YOUR_API_KEY",
4	"Accept": "application/json"
5	}
6	});
7	const data = await response.json();

1	require "uri"
2	require "net/http"
3
4	url = URI("https://api.tamio.com/v2/affiliates/list")
5
6	https = Net::HTTP.new(url.host, url.port)
7	https.use_ssl = true
8
9	request = Net::HTTP::Get.new(url)
10	request["Accept"] = "application/json"
11	request["Authorization"] = "Bearer YOUR_API_KEY"
12
13	response = https.request(request)
14	puts response.read_body