List Distributors
Returns a paginated list of distributors with support for filtering by status and search.
Last updated: April 9, 2026
List Distributors
GET /siren/v1/distributors
Returns a paginated list of distributors. Results are wrapped by the ListResponseWrapperInterceptor.
Query Parameters:
| Parameter | Type | Default | Description |
|---|---|---|---|
status | string | — | Filter by status |
fields | string | core fields | Comma-separated list of fields to include |
include | string | — | Legacy: extended to include extra fields |
number | integer | 10 | Results per page |
offset | integer | 0 | Pagination offset |
orderBy | string | id | Sort field. Allowed: id, name, status, dateCreated |
order | string | DESC | Sort direction: ASC or DESC |
The name and description columns are searchable via the standard search parameter.
Response Headers:
x-siren-estimated-count. Total matching records (exposed viaAccess-Control-Expose-Headers).
Example Request:
GET /siren/v1/distributors?status=active&fields=id,name,status,collaboratorCount&number=25
Example Response:
[
{
"id": 1,
"name": "Standard Commission",
"status": "active",
"collaboratorCount": 12
}
]