Listar Afiliados

curl --request GET \
  --url https://api.affiliatus.io/v1/affiliates \
  --header 'X-API-Key: <x-api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<x-api-key>'}};

fetch('https://api.affiliatus.io/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://api.affiliatus.io/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 => [
    "X-API-Key: <x-api-key>"
  ],
]);

$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://api.affiliatus.io/v1/affiliates"

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

	req.Header.Add("X-API-Key", "<x-api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.affiliatus.io/v1/affiliates")

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

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<x-api-key>'

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

{
  "affiliates": [
    {
      "id": 123,
      "name": "<string>",
      "email": "<string>",
      "phone": "<string>",
      "referralId": "<string>",
      "status": "<string>",
      "createdAt": "<string>",
      "totalConversions": 123,
      "totalCommissions": 123,
      "totalPaid": 123
    }
  ],
  "total": 123,
  "page": 123,
  "limit": 123,
  "totalPages": 123
}

GET

affiliates

Listar Afiliados

curl --request GET \
  --url https://api.affiliatus.io/v1/affiliates \
  --header 'X-API-Key: <x-api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<x-api-key>'}};

fetch('https://api.affiliatus.io/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://api.affiliatus.io/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 => [
    "X-API-Key: <x-api-key>"
  ],
]);

$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://api.affiliatus.io/v1/affiliates"

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

	req.Header.Add("X-API-Key", "<x-api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.affiliatus.io/v1/affiliates")

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

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<x-api-key>'

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

{
  "affiliates": [
    {
      "id": 123,
      "name": "<string>",
      "email": "<string>",
      "phone": "<string>",
      "referralId": "<string>",
      "status": "<string>",
      "createdAt": "<string>",
      "totalConversions": 123,
      "totalCommissions": 123,
      "totalPaid": 123
    }
  ],
  "total": 123,
  "page": 123,
  "limit": 123,
  "totalPages": 123
}

Endpoint

GET https://api.affiliatus.io/v1/affiliates

Este endpoint retorna uma lista paginada de todos os afiliados associados à campanha da sua API Key.

Performance: A API retorna até 100 afiliados por requisição. Use paginação para grandes listas.

Autenticação

string

required

Sua API key obtida no dashboard em Configurações → API Keys

Query Parameters

string

Filtrar por status do afiliadoValores possíveis:

pending - Apenas afiliados aguardando aprovação
active - Apenas afiliados ativos
inactive - Apenas afiliados inativos

Se não fornecido, retorna todos os status.

string

Buscar por nome, e-mail ou referralIdA busca é case-insensitive e busca correspondências parciais.Exemplo: search=joao encontra “João Silva”, “joao@example.com”, “JOAO123”

number

default:"1"

Número da página para paginação (começa em 1)

number

default:"50"

Número de afiliados por páginaLimites:

Mínimo: 1
Máximo: 100
Padrão: 50

Response

array

Array de objetos de afiliados

Show Affiliate Object

number

ID único do afiliado

string

Nome do afiliado

string

E-mail do afiliado

string

Telefone do afiliado

string

Código de referência único

string

Status (pending, active ou inactive)

string

Data de criação (ISO 8601)

number

Total de conversões geradas

number

Total de comissões em BRL

number

Total já pago em BRL

number

Número total de afiliados (sem paginação)

number

Página atual

number

Limite por página

number

Número total de páginas

Exemplos

Listar Todos os Afiliados

curl -X GET "https://api.affiliatus.io/v1/affiliates" \
  -H "X-API-Key: sua_api_key_aqui"

const response = await fetch('https://api.affiliatus.io/v1/affiliates', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.AFFILIATUS_API_KEY,
  }
});

const data = await response.json();
console.log(`Total: ${data.total} afiliados`);
console.log(`Página: ${data.page}/${data.totalPages}`);
data.affiliates.forEach(affiliate => {
  console.log(`- ${affiliate.name} (${affiliate.referralId})`);
});

import requests

response = requests.get(
    'https://api.affiliatus.io/v1/affiliates',
    headers={
        'X-API-Key': 'sua_api_key_aqui',
    }
)

data = response.json()
print(f"Total: {data['total']} afiliados")
for affiliate in data['affiliates']:
    print(f"- {affiliate['name']} ({affiliate['referralId']})")

<?php
$ch = curl_init('https://api.affiliatus.io/v1/affiliates');

curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'X-API-Key: sua_api_key_aqui'
]);

$response = curl_exec($ch);
curl_close($ch);

$data = json_decode($response, true);
echo "Total: {$data['total']} afiliados\n";
foreach ($data['affiliates'] as $affiliate) {
    echo "- {$affiliate['name']} ({$affiliate['referralId']})\n";
}

Resposta de Sucesso (200 OK)

{
  "affiliates": [
    {
      "id": 123,
      "name": "João Silva",
      "email": "joao@example.com",
      "phone": "+55 11 99999-9999",
      "referralId": "JOAO123",
      "status": "active",
      "createdAt": "2024-01-15T10:30:00.000Z",
      "totalConversions": 45,
      "totalCommissions": 2500.00,
      "totalPaid": 1200.00
    },
    {
      "id": 124,
      "name": "Maria Santos",
      "email": "maria@example.com",
      "phone": "+55 21 98888-8888",
      "referralId": "MARIA456",
      "status": "active",
      "createdAt": "2024-01-16T14:20:00.000Z",
      "totalConversions": 32,
      "totalCommissions": 1800.00,
      "totalPaid": 800.00
    }
  ],
  "total": 2,
  "page": 1,
  "limit": 50,
  "totalPages": 1
}

Filtrar por Status

curl -X GET "https://api.affiliatus.io/v1/affiliates?status=active" \
  -H "X-API-Key: sua_api_key_aqui"

const params = new URLSearchParams({ status: 'active' });

const response = await fetch(
  `https://api.affiliatus.io/v1/affiliates?${params}`,
  {
    headers: { 'X-API-Key': process.env.AFFILIATUS_API_KEY }
  }
);

const data = await response.json();
console.log(`${data.total} afiliados ativos`);

response = requests.get(
    'https://api.affiliatus.io/v1/affiliates',
    headers={'X-API-Key': 'sua_api_key_aqui'},
    params={'status': 'active'}
)

Buscar por Nome ou E-mail

curl -X GET "https://api.affiliatus.io/v1/affiliates?search=joao" \
  -H "X-API-Key: sua_api_key_aqui"

const params = new URLSearchParams({ search: 'joao' });

const response = await fetch(
  `https://api.affiliatus.io/v1/affiliates?${params}`,
  {
    headers: { 'X-API-Key': process.env.AFFILIATUS_API_KEY }
  }
);

response = requests.get(
    'https://api.affiliatus.io/v1/affiliates',
    headers={'X-API-Key': 'sua_api_key_aqui'},
    params={'search': 'joao'}
)

Paginação

# Página 2, 20 afiliados por página
curl -X GET "https://api.affiliatus.io/v1/affiliates?page=2&limit=20" \
  -H "X-API-Key: sua_api_key_aqui"

const params = new URLSearchParams({
  page: '2',
  limit: '20'
});

const response = await fetch(
  `https://api.affiliatus.io/v1/affiliates?${params}`,
  {
    headers: { 'X-API-Key': process.env.AFFILIATUS_API_KEY }
  }
);

const data = await response.json();
console.log(`Página ${data.page} de ${data.totalPages}`);

response = requests.get(
    'https://api.affiliatus.io/v1/affiliates',
    headers={'X-API-Key': 'sua_api_key_aqui'},
    params={'page': 2, 'limit': 20}
)

data = response.json()
print(f"Página {data['page']} de {data['totalPages']}")

Combinar Filtros

# Afiliados ativos que contenham "silva" no nome, página 1, 10 por página
curl -X GET "https://api.affiliatus.io/v1/affiliates?status=active&search=silva&page=1&limit=10" \
  -H "X-API-Key: sua_api_key_aqui"

const params = new URLSearchParams({
  status: 'active',
  search: 'silva',
  page: '1',
  limit: '10'
});

const response = await fetch(
  `https://api.affiliatus.io/v1/affiliates?${params}`,
  {
    headers: { 'X-API-Key': process.env.AFFILIATUS_API_KEY }
  }
);

Erros

401 - API Key Inválida

{
  "statusCode": 401,
  "message": "Invalid or inactive API Key",
  "error": "Unauthorized"
}

Solução: Verifique se o header X-API-Key está correto.

400 - Parâmetros Inválidos

{
  "statusCode": 400,
  "message": [
    "limit must not be greater than 100"
  ],
  "error": "Bad Request"
}

Solução: Ajuste os parâmetros de acordo com os limites.

429 - Rate Limit

{
  "statusCode": 429,
  "message": "ThrottlerException: Too Many Requests",
  "error": "Too Many Requests"
}

Solução: Aguarde 60 segundos.

Dicas de Uso

Paginação eficiente

Para grandes listas, use limit=100 e navegue pelas páginas. Isso otimiza a performance e reduz o tempo de resposta.

Busca inteligente

O parâmetro search busca em nome, e-mail e referralId simultaneamente. Use-o para encontrar afiliados rapidamente.

Filtre por status

Use status=pending para revisar cadastros aguardando aprovação, status=active para listar afiliados que podem gerar conversões, ou status=inactive para revisar afiliados pausados.

Combine filtros

Você pode combinar status, search, page e limit para buscas muito específicas.

Cache de resultados

Se sua aplicação lista afiliados frequentemente, considere cachear os resultados por alguns minutos para reduzir chamadas à API.

Próximos Passos

Consultar Afiliado

Veja detalhes de um afiliado específico

Criar Afiliado

Adicione um novo afiliado

Atualizar Afiliado

Edite informações de um afiliado

Dashboard

Visualize no dashboard

Visão Geral

Eventos

Afiliados

Listar Afiliados

Endpoint

Autenticação

Query Parameters

Response

Exemplos

Listar Todos os Afiliados

Resposta de Sucesso (200 OK)

Filtrar por Status

Buscar por Nome ou E-mail

Paginação

Combinar Filtros

Erros

401 - API Key Inválida

400 - Parâmetros Inválidos

429 - Rate Limit

Dicas de Uso

Próximos Passos

Consultar Afiliado

Criar Afiliado

Atualizar Afiliado

Dashboard

​Endpoint

​Autenticação

​Query Parameters

​Response

​Exemplos

​Listar Todos os Afiliados

​Resposta de Sucesso (200 OK)

​Filtrar por Status

​Buscar por Nome ou E-mail

​Paginação

​Combinar Filtros

​Erros

​401 - API Key Inválida

​400 - Parâmetros Inválidos

​429 - Rate Limit

​Dicas de Uso

​Próximos Passos

Consultar Afiliado

Criar Afiliado

Atualizar Afiliado

Dashboard

Endpoint

Autenticação

Query Parameters

Response

Exemplos

Listar Todos os Afiliados

Resposta de Sucesso (200 OK)

Filtrar por Status

Buscar por Nome ou E-mail

Paginação

Combinar Filtros

Erros

401 - API Key Inválida

400 - Parâmetros Inválidos

429 - Rate Limit

Dicas de Uso

Próximos Passos