Skip to main content
POST
Retrieve a paginated list of affiliates. Supports search filters, sorting, and pagination to help you find and browse affiliates programmatically. Supports the relationship query parameter with values: signup, users.

Authorizations

X-Eflow-Api-Key
string
header
required

The Everflow API key generated from the Control Center > Security.

Query Parameters

page
integer
default:1

Page number (1-based).

page_size
integer
default:50

Number of results per page.

Required range: x <= 2000
relationship
enum<string>

Include related data.

Available options:
signup,
users

Body

application/json
search_terms
object[]

Text search filters.

filters
object

Structured filters to narrow results.

Response

200 - application/json
affiliates
object[]

List of affiliates matching the search criteria.

paging
object

Pagination information.