Docs
get https://api.affiliates.iugu.com/api/affiliates

Retorna uma lista de afiliados

Permissão necessária: affiliates.list

Esta permissão deve constar como uma das ações permitidas para o app que faz a chamada. Isto pode ser feito através do GIA, ou então na edição do aplicativo. Em caso de dúvidas, clique aqui.

Request

Query params

name

Type: string

Nome do afiliado

Ex: Influencer instagram

document

Type: string

CPF/CNPJ do afiliado

Ex: 38235467828

email

Type: string

Email do afiliado

Ex: [email protected]

phone_number

Type: string

Telefone do afiliado

Ex: 5511911112222

Headers

workspace_id

Required

Type: string

Identificador do workspace

Ex: 4fHECmQtLdROI4fDLWMiLd

Response

200

OK

success
Array of objects

id
String

Identificador único do afiliado

Ex: 5N8wqsUjlwlxtx1tIqoP1a

name
String

Nome do afiliado

Ex: Primo Rico

workspace_id
String

ID do espaço de trabalho associado ao afiliado

Ex: 6AaVMPZBMTMweShgqdA7nR

email
String

Email do afiliado

Ex: [email protected]

phone_number
String

Telefone do afiliado

Ex: 11942424545

document
String

Documento do afiliado

Ex: 50949740098

created_at
String

Data e hora de criação do afiliado

Ex: 2023-12-20T17:46:49.461Z

updated_at
String

Data e hora da última atualização do afiliado

Ex: 2023-12-22T19:06:50.487Z

parent_affiliate
Object

id
String

Identificador único do afiliado indicador

Ex: 0XNFWtBURoI7O5vinlYjS2

name
String

Nome do afiliado indicador

Ex: Primo Rico

email
String

Email do afiliado indicador

Ex: [email protected]

document
String

Documento do afiliado indicador

Ex: 50949740098

Example
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
{
  "success": [
    {
      "id": "5N8wqsUjlwlxtx1tIqoP1a",
      "name": "Primo Rico",
      "workspace_id": "6AaVMPZBMTMweShgqdA7nR",
      "email": "[email protected]",
      "phone_number": "11942424545",
      "document": "50949740098",
      "created_at": "2023-12-20T17:46:49.461Z",
      "updated_at": "2023-12-22T19:06:50.487Z",
      "parent_affiliate": {
        "id": "0XNFWtBURoI7O5vinlYjS2",
        "name": "Primo Rico",
        "email": "[email protected]",
        "document": "50949740098"
      }
    }
  ]
}

401

Unauthorized

status
String

Ex: 401

title
String

Ex: JWT VALIDATION ERROR

detail
String

Ex: Signature has expired

Example
1
2
3
4
5
{
  "status": "401",
  "title": "JWT VALIDATION ERROR",
  "detail": "Signature has expired"
}

404

Not Found

message
String

Ex: Registro não encontrado.

Example
1
2
3
{
  "message": "Registro não encontrado."
}

500

Internal Server Error

status
String

Ex: 500

title
String

Ex: Internal Server Error

detail
String

Ex: Internal Error, try again later

Example
1
2
3
4
5
{
  "status": "500",
  "title": "Internal Server Error",
  "detail": "Internal Error, try again later"
}