Siren

Get Distributor

Returns a single distributor by ID, including specialized domain fields for schedule, engagement types, and current distribution.

Last updated: April 9, 2026

Get Distributor

GET /siren/v1/distributors/{id}

Returns a single distributor by ID, including specialized domain fields that are not available on the list endpoint.

Query Parameters:

ParameterTypeDefaultDescription
fieldsstringcore fieldsComma-separated list of fields to include
includestringLegacy: extended for all available fields plus currentDistribution

Example Request:

GET /siren/v1/distributors/1?include=extended

Example Response:

{
  "id": 1,
  "name": "Standard Commission",
  "description": "Percentage-based commission on all sales",
  "distributionResolver": "percentage_based",
  "distributionPoolResolver": "standard_pool",
  "status": "active",
  "units": "USD",
  "dateCreated": "2026-01-15T10:00:00Z",
  "dateModified": "2026-03-20T14:30:00Z",
  "collaboratorCount": 12,
  "schedule": ["first day of next month"],
  "engagementTypes": [
    { "id": 5, "type": "sale", "value": "100" }
  ],
  "transactionCompilers": ["standard"],
  "revenuePercentage": 30,
  "lineItemFilters": {
    "withTypes": ["products"],
    "collaboratorOwned": false,
    "withSkus": [],
    "inCategories": null
  },
  "currentDistribution": {
    "id": 42,
    "distributorId": 1,
    "status": "pending"
  }
}

Error Responses:

  • 404. No record found with that ID.
  • 500. Database error.