Siren

Get Collaborator Group

Returns a single collaborator group by ID, with optional field selection via the standard field-resolver pattern.

Last updated: June 7, 2026

GET /siren/v1/collaborator-groups/{id}

Returns a single collaborator group by ID. When no fields parameter is provided, returns the default set (id, name, description, structure). Requires authentication and the Read capability on the CollaboratorGroup resource.

Query Parameters:

ParameterTypeDefaultDescription
fieldsstringid,name,description,structureComma-separated list of fields to include

Example Request:

GET /siren/v1/collaborator-groups/12?fields=id,name,description,structure

Example Response:

{
  "id": 12,
  "name": "Sales Reps",
  "description": "Inside sales chain",
  "structure": "linearChain"
}

The available fields are whatever field resolvers are registered for the group: id, name, description, and structure in core, plus any a plugin adds through the CollaboratorGroupResolverRegistryInitiated event. The default is the core set. The fields value is filtered against the available set, so a name that has no resolver (for example dateCreated, which is not exposed on a group read) is silently dropped from the response rather than returning an error or a null. The fields parameter is optional here and defaults to the core set, unlike List Collaborator Groups, where it is required.

Error Responses:

  • 404. No record found with that ID.
  • 500. Database error fetching the collaborator group.

Events: Broadcasts CollaboratorGroupResolverRegistryInitiated so registered listeners can contribute additional field resolvers before the response is built.