v1
latestOpenAPI 3.1.02026-07-24172151607.6 KBUser Groups
Get Groups
This endpoint is used to view User Groups in your Workspace.
In our API documentation, team_id refers to the ID of a Workspace, and group_id refers to the ID of a User Group.
get/v2/group
Query parameters
team_idnumber required
Example:123
Workspace ID. Note: For this endpoint, `team_id`` is a required query parameter.
group_idsstring[]
Enter one or more User Group IDs to retrieve information about specific User Group(s).
For example:
?team_id=12456&group_ids=ABC12345&group_ids=DEF98765
Response
Example response
{
"groups": [
{
"id": "4bfdfcec-6f4f-40a7-b0d6-22660d51870d",
"team_id": "123456",
"userid": 301123,
"name": "product team",
"handle": "product",
"date_created": "1640122639829",
"initials": "PT",
"members": [
{
"id": 183,
"username": "Jerry",
"email": "jerry@example.com",
"color": "#40BC86",
"initials": "J",
"profilePicture": null
},
{
"id": 184,
"username": "Sam",
"email": "sam@example.com",
"color": "#FF8600",
"initials": "S",
"profilePicture": null
}
],
"avatar": {
"attachment_id": null,
"color": null,
"source": null,
"icon": null
}
},
{
"id": "fd31be63-41f2-4320-9043-9786fdf643d6",
"team_id": "301540",
"userid": 301828,
"name": "HR department",
"handle": "hr-dept",
"date_created": "1627087990293",
"initials": "HD",
"members": [
{
"id": 183,
"username": "Jerry",
"email": "jerry@example.com",
"color": "#40BC86",
"initials": "J",
"profilePicture": "https://attachments.clickup.com/profilePictures/profile.jpg"
}
],
"avatar": {
"attachment_id": null,
"color": null,
"source": null,
"icon": null
}
}
]
}