Get User Group

This endpoint returns one user group with its members and its project and task assignments.

Endpoint

GET /v1/user-groups/user-groups/:id

Authentication

Include your API key in the x-api-key header. See Authentication.

Required Scope

user-groups:read

Path Parameters

Parameter	Type	Required	Description
id	string	Yes	User group ID.

Request Body

This endpoint does not accept a request body.

Example Request

cURL

curl "https://api.crewsum.com/v1/user-groups/user-groups/36b735f8-4dd7-4c3c-836f-35d2fe84e872" \
  -H "x-api-key: $CREWSUM_API_KEY"

JavaScript

const response = await fetch(
  "https://api.crewsum.com/v1/user-groups/user-groups/36b735f8-4dd7-4c3c-836f-35d2fe84e872",
  {
    headers: {
      "x-api-key": process.env.CREWSUM_API_KEY,
    },
  },
);
const result = await response.json();

HTTP

GET /v1/user-groups/user-groups/36b735f8-4dd7-4c3c-836f-35d2fe84e872 HTTP/1.1
Host: api.crewsum.com
x-api-key: <your-api-key>

Response

On success, the API returns HTTP 200 OK.

Example Response

{
  "message": "Successfully fetched user group",
  "data": {
    "id": "36b735f8-4dd7-4c3c-836f-35d2fe84e872",
    "name": "Operations",
    "description": "Users who manage operations work.",
    "userCount": 1,
    "createdAt": "2026-05-27T18:00:00.000Z",
    "updatedAt": null,
    "assignments": [
      {
        "id": "project-mno123pqr4567890",
        "name": "Project Name",
        "source": { "type": "direct" },
        "groupSources": [],
        "tasks": [
          {
            "id": "task-pqr123stu4567890",
            "name": "Task Name",
            "source": { "type": "direct" },
            "groupSources": []
          }
        ]
      }
    ],
    "users": [
      {
        "userId": "user-a",
        "displayName": "User Display Name",
        "email": "placeholder@example.com",
        "systemRole": "assoc",
        "isArchived": false
      }
    ]
  }
}

Behavior

• users lists the group’s members, sorted by displayName. Each userId is the user ID without the tenant prefix.
• userCount is the number of users in the group.
• assignments lists the projects and tasks assigned to the group. Every member receives these assignments. In this response, source is always { "type": "direct" } and groupSources is always [].

Error Responses

Status	Meaning
400	"User group ID not found": the ID path segment was empty.
404	"Error fetching user group": returned for every failure, including an unknown group ID and internal errors.

Authentication and scope failures are described in Errors.

Related Webhooks

This endpoint does not trigger a webhook.