Skip to main content
GET
List affiliates

Authorizations

Authorization
string
header
required

Workspace API key, e.g. sa_live_…. Scopes: read / write / track / *.

Query Parameters

limit
integer
default:50

Page size (1–200, default 50).

Required range: 1 <= x <= 200
offset
integer
default:0

Rows to skip (default 0).

Required range: x >= 0
status
string

Filter by affiliate status.

Example:

"active"

q
string

Case-insensitive substring match on name, email, or ref_code.

Response

A page of affiliates

object
string
Example:

"list"

resource
string
Example:

"affiliates"

limit
integer
Example:

50

offset
integer
Example:

0

data
object[]