Get Groups

Nothing Found

Help Center
API Feature Requests

Nothing Found

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.

SecurityAuthorization_Token

Request

query Parameters

team_id required	number <double> Workspace ID
group_ids	string Enter one or more User Group IDs to retrieve information about specific User Group.

Responses

200

get/v2/group

Request samples

Response samples

application/json

{"groups": [{"id": "4bfdfcec-6f4f-40a7-b0d6-22660d51870d",
"team_id": "123456",
"userid": 301123,
"name": "product managers",
"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://dev-attachments-public.clickup.com/profilePictures/profile.jpg"
}
],
"avatar": {"attachment_id": null,
"color": null,
"source": null,
"icon": null
}
}
]
}

© 2022 ClickUp
Security
Your Privacy
Terms