Siren

Get Collaborator

Retrieve a single collaborator by ID with optional field selection.

Last updated: April 9, 2026

Get Collaborator

GET /siren/v1/collaborators/{id}

Returns a single collaborator by ID. Access is granted to administrators and to the collaborator themselves (owner-bound access).

When the fields parameter is omitted, the following default fields are returned: id, status, fullName, nickname, email, referralCode, programs, distributors, createdDate, modifiedDate.

Query Parameters:

ParameterTypeDefaultDescription
fieldsstringdefault fieldsComma-separated list of fields to include

Example Request:

GET /siren/v1/collaborators/7?fields=id,fullName,programs,unfulfilledObligationCount

Example Response:

{
  "id": 7,
  "fullName": "Jane Smith",
  "programs": [
    { "id": 1, "name": "Standard Affiliate" },
    { "id": 3, "name": "VIP Partners" }
  ],
  "unfulfilledObligationCount": 4
}

Error Responses:

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