Siren

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:

ParameterTypeDefaultDescription
statusstringFilter by status
fieldsstringcore fieldsComma-separated list of fields to include
includestringLegacy: extended to include extra fields
numberinteger10Results per page
offsetinteger0Pagination offset
orderBystringidSort field. Allowed: id, name, status, dateCreated
orderstringDESCSort 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 via Access-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
  }
]