Skip to main content
GET
List Affiliate Users
Retrieve all users for a specific affiliate. Returns user details including contact information, roles, and primary user designation.

Authorizations

X-Eflow-Api-Key
string
header
required

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

Path Parameters

affiliateId
integer
required

The ID of the affiliate whose users you want to fetch.

Query Parameters

relationship
enum<string>

Include additional related data in the response. Multiple relationships can be supplied by repeating the relationship query parameter. Supported values: logins (includes the users' list of logins), password_history (includes the users' password changes history), api (includes the users' API key and whitelisted IPs), affiliate_status (includes the status of the affiliate to which the user belongs), customizations (includes the users' customizations).

Available options:
logins,
password_history,
api,
affiliate_status,
customizations

Response

200 - application/json
users
object[]

List of affiliate users.