List User Groups

Get a list of all user groups in the workspace

Retrieve a list of all user groups in the workspace.

Response

userGroups · array

List of user groups

Show User Group properties

id · string

Unique identifier for the user group

name · string

Name of the user group

createdAt · string

ISO8601 timestamp when the group was created

memberCount · number

Number of members in the group

Example Request

curl -X GET 'https://api.caret.so/v1/workspace/groups' \
  -H 'Authorization: Bearer {api_key}'

Example Response

{
  "userGroups": [
    {
      "id": "01887270-67cd-7da0-c95d-9a9e9ebc6f12",
      "name": "Sales Team",
      "createdAt": "2023-04-15T08:30:00Z",
      "memberCount": 5
    },
    {
      "id": "01887270-89ef-7da0-c95d-9a9e9ebc7g34",
      "name": "Engineering",
      "createdAt": "2023-04-16T09:45:00Z",
      "memberCount": 12
    },
    {
      "id": "01887270-01ab-7da0-c95d-9a9e9ebc8h56",
      "name": "Product Management",
      "createdAt": "2023-04-17T10:15:00Z",
      "memberCount": 3
    }
  ]
}