Skip to main content
GET
List affiliates
Required permissions:
  • affiliate:basic:read

Autorizaciones

Authorization
string
header
requerido

An Account API key, account-scoped JWT, App API key, or user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************.

Scopes

affiliate:basic:read

Parámetros de consulta

after
string

Returns the elements in the list that come after the specified cursor.

before
string

Returns the elements in the list that come before the specified cursor.

first
integer

Returns the first n elements from the list.

Ejemplo:

42

last
integer

Returns the last n elements from the list.

Ejemplo:

42

direction
enum<string>

The sort direction for results. Defaults to descending.

Opciones disponibles:
asc,
desc
order
enum<string>

The field to sort results by.

Opciones disponibles:
id,
created_at,
cached_total_referrals,
cached_total_rewards
query
string

Search affiliates by username.

status
enum<string>

Filter by affiliate status (active or archived).

Opciones disponibles:
active,
archived,
deleted
account_id
string
requerido

The unique identifier of the company to list affiliates for.

Ejemplo:

"biz_xxxxxxxxxxxxxx"

Respuesta

A successful response

The connection type for Affiliate.

data
object[]
requerido

A list of nodes.

page_info
object
requerido

Information to aid in pagination.