List Collaborators

List Collaborators

GET /siren/v1/collaborators

Returns a paginated list of collaborators. Results are wrapped by the ListResponseWrapperInterceptor.

Query Parameters:

Parameter	Type	Default	Description
fields	string	—	Comma-separated list of fields to include (required)
status	string	—	Filter by exact status
fullName	string	—	Filter by exact full name
nickname	string	—	Filter by exact nickname
email	string	—	Filter by exact email
s	string	—	Search across fullName, nickname, email, and alias codes
programId	integer	—	Filter to collaborators enrolled in this program
distributorId	integer	—	Filter to collaborators assigned to this distributor
number	integer	10	Results per page
offset	integer	0	Pagination offset
orderBy	string	id	Sort field
order	string	ASC	Sort direction: ASC or DESC

Response Headers:

• x-siren-estimated-count. Total matching records (exposed via Access-Control-Expose-Headers).

Example Request:

GET /siren/v1/collaborators?fields=id,fullName,status,referralCode&status=active&number=25

Example Response:

[
  {
    "id": 7,
    "fullName": "Jane Smith",
    "status": "active",
    "referralCode": "BCDGHJK"
  }
]