clickup_get_custom_roles
List custom roles configured in a ClickUp workspace, including their base role and optionally assigned members.
Instructions
List the Custom Roles configured for a Workspace.
Calls GET /team/{team_id}/customroles (team_id = Workspace id; this
endpoint has no relation to User Groups/group_id). Custom Roles let a
Workspace define named permission tiers layered on top of ClickUp's base
roles (owner/admin/member/guest); each role's inherited_role shows
which base role it extends.
Note: Custom Roles are an Enterprise plan feature — this endpoint returns 403 on other plans.
When to Use:
To look up which Custom Role(s) exist, and who holds them, before assigning one to a user elsewhere.
When NOT to Use:
To list User Groups (an unrelated, non-permission concept), use
clickup_get_user_groups.
Returns:
A markdown (or JSON) list of roles with id, name, the base role they
extend, and (when include_members=True) member count.
Examples: params = {"team_id": "123456"} params = {"team_id": "123456", "include_members": false}
Error Handling: 403 on non-Enterprise plans; 404 if team_id is invalid.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| params | Yes |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |