Operations API Affiliate Programs

List all affiliate programs

GET https://api.tamio.com/v2/affiliate-programs/list

Returns a paginated list of affiliate programs. Supports filtering by product, date range, and sort order.

Query Parameters

page integer*

Page number for pagination (1-based).

per_page integer*

Number of programs to return per page.

order string

Sort order for the results.

ascdesc

product_id string

Filter programs by a specific product UUID.

from object

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

to object

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

Responses

200 Programs retrieved successfully

Programs retrieved successfully

status integer

total_results integer

Total number of programs matching the query.

programs array of AffiliateProgram

object string

affiliate_program

id string

label string

created_at integer

Unix epoch (seconds).

currency string

commission_amount integer

Fixed commission in smallest currency unit.

commission_percent number

Percentage as a decimal (e.g. 0.10 = 10%).

description string

payout_delay integer

subscription_commission_type string

onceforeverrepeating

destinations array of string

payments array of string

payment_count integer

Duration in months (only for repeating type).

approved boolean

auto_approve boolean

is_active boolean

products array of string

languages object

Multilingual content keyed by language code.

domain object

id string

domain string

signup_url string

is_listed boolean

banners array of string

affiliates integer

Number of affiliates in the program.

sales integer

Number of sales with affiliate revenue.

javascript_url string

is_public boolean

cookie_expiry integer

first_takes_all string

enableddisabled

affiliate_notifications boolean

400 Validation or business logic error. Returned when:

Validation or business logic error. Returned when:

page or per_page are not integers or exceed their maximum (100000 / 100)
order is not asc or desc
product_id is not a valid UUID
from or to are not a valid date format, are null, or exceed 26 characters
Unknown query parameters are sent

Error codes:

Code	Description
1002	Product not found or does not belong to your account

status integer

error string

error_code integer

401 Missing or invalid API key

Retrieve an affiliate program

/affiliate-programs/list

1 const response = await fetch("https://api.tamio.com/v2/affiliate-programs/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/affiliate-programs/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": 5,
  "programs": [
    {
      "object": "affiliate_program",
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "label": "Premium Affiliate Program",
      "created_at": 1709500800,
      "currency": "EUR",
      "commission_amount": 500,
      "commission_percent": 0.1,
      "description": "Premium Affiliate Program",
      "payout_delay": 30,
      "subscription_commission_type": "once",
      "destinations": [
        "worldwide"
      ],
      "payments": [
        "stripe"
      ],
      "payment_count": 12,
      "approved": true,
      "auto_approve": false,
      "is_active": true,
      "products": [
        "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
      ],
      "languages": {
        "en": {
          "label": "English Program",
          "description": "English description"
        },
        "es": {
          "label": "Spanish Program",
          "description": "Spanish description"
        }
      },
      "domain": {
        "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "domain": "example.com"
      },
      "signup_url": "https://example.com/signup",
      "is_listed": true,
      "banners": [
        "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
      ],
      "affiliates": 10,
      "sales": 100,
      "javascript_url": "https://example.com/javascript.js",
      "is_public": true,
      "cookie_expiry": 30,
      "first_takes_all": "enabled",
      "affiliate_notifications": false
    }
  ]
}

1	const response = await fetch("https://api.tamio.com/v2/affiliate-programs/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/affiliate-programs/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