Groups and folders
Groups and folder nodes organise members into a navigable hierarchy.
Object schema
Fields returned by Get group. Individual endpoint pages document their complete response shapes.
| Name | Type | Required | Description |
|---|---|---|---|
parentId | string | Optional | Parent resource identifier. |
icon | string | Optional | Icon. |
iconColorPreset | string | Optional | Icon Color Preset. |
createdAt | number | Optional | Creation time. |
updatedAt | number | Optional | Most recent update time. |
version | number | Required | Version used for optimistic concurrency checks. |
sideSystemId | string | Optional | Side System Id. |
subSystemId | string | Optional | Sub System Id. |
deletedAt | number | Optional | Deletion time; null when active. |
purgeAt | number | Optional | Purge At. |
originalParentId | string | Optional | Original Parent Id. |
archivedAt | number | Optional | Archiving time; null when active. |
description | string | Optional | Description of the resource. |
_id | string | Required | Unique identifier. |
userId | string | Required | Owning account identifier. |
name | string | Required | Name of the resource. |
Endpoints
8 operations
PATCHUpdate group icon
/api/v1/groups/{groupId}/iconGETGet group path/api/v1/groups/{groupId}/pathGETGet group/api/v1/groups/{groupId}PATCHUpdate group/api/v1/groups/{groupId}DELETEDelete group/api/v1/groups/{groupId}GETList groups/api/v1/groupsPOSTCreate group/api/v1/groupsGETGroup tree/api/v1/groups/tree