Groups
Read and manage editorial groups.
List groups
query Parameters
page0-based page number for offset pagination. Mutually exclusive with cursor.
cursor^[A-Za-z0-9._~\-]*$Opaque cursor for keyset pagination. Mutually exclusive with page. Clients must not parse or construct it; pass the nextCursor value back unchanged. Current tokens use the shared v1.BASE64... format.
sizeRequested page size. Defaults to 20 and must not exceed 100.
includeDeletedInclude soft-deleted resources when true.
List groups › Responses
OK
Items returned in this response.
hasMoreWhether more results are available.
nextCursorCursor for the next page of results.
Page-based pagination metadata.
sizeRequested page size.
Create group
Creates a new group.
Create group › Request Body
nameGroup name.
externalIdGroup ID in the external system.
Omit or set null to leave it unset on create.
parentGroupIdParent group ID.
Omit or set null to create a top-level group.
Create group › Responses
Group created
deletedWhether the group is soft-deleted.
externalIdGroup ID in the external system.
idGroup ID.
nameGroup name.
Parent group.
positionPosition of the group within its parent group.
versionGroup version.
Get group by external ID
path Parameters
externalIdquery Parameters
includeDeletedGet group by external ID › Responses
OK
deletedWhether the group is soft-deleted.
externalIdGroup ID in the external system.
idGroup ID.
nameGroup name.
Parent group.
positionPosition of the group within its parent group.
versionGroup version.
Get group by ID
path Parameters
idquery Parameters
includeDeletedGet group by ID › Responses
OK
deletedWhether the group is soft-deleted.
externalIdGroup ID in the external system.
idGroup ID.
nameGroup name.
Parent group.
positionPosition of the group within its parent group.
versionGroup version.
Replace group by ID
Replaces the writable state of the addressed group.
path Parameters
idReplace group by ID › Request Body
nameGroup name.
null is invalid.
externalIdGroup ID in the external system.
Omit or set null to clear it.
Replace group by ID › Responses
OK
deletedWhether the group is soft-deleted.
externalIdGroup ID in the external system.
idGroup ID.
nameGroup name.
Parent group.
positionPosition of the group within its parent group.
versionGroup version.
Delete group by ID
Update group by ID
Partially updates the writable state of the addressed group.
path Parameters
idUpdate group by ID › Request Body
externalIdGroup ID in the external system.
Omit to leave it unchanged. Set null to clear it.
nameGroup name.
Omit to leave it unchanged. null is invalid.
Update group by ID › Responses
OK
deletedWhether the group is soft-deleted.
externalIdGroup ID in the external system.
idGroup ID.
nameGroup name.
Parent group.
positionPosition of the group within its parent group.
versionGroup version.