Set List Items
Ask
List set list items
GET/v1/teams/{teamId}/set-list-itemsLists reusable set list library items for a team.
Required scopes: set_list_item:read
Parameters
path.teamIdrequired | string:uuidTeam identifier. |
|---|---|
query.limit | integerMaximum number of records to return. Defaults to 50 and is capped at 200. |
query.cursor | stringOpaque cursor returned by page.nextCursor. Reuse the same credential, endpoint, and filters within 24 hours; restart pagination after expiration or credential changes. |
Response 200
data | object[] |
|---|---|
data[].title | stringReusable set list item title. |
data[].durationSeconds | integerDefault duration in seconds for this reusable set list item. |
data[].printTitle | stringOptional title to use on printed set list output. |
data[].notes | stringOptional notes for the set list item. |
data[].id | string:uuidSet list item identifier. |
data[].orgId | string:uuidTeam identifier that owns this reusable set list item. |
data[].isRetired | booleanWhether this reusable item is hidden from active use. |
data[].retiredAt | string:date-timeISO 8601 timestamp when the item was retired. |
data[].retiredBy | stringUser identifier that retired this item. |
data[].isDeleted | booleanWhether this reusable item has been deleted. |
data[].version | integerCurrent set list item aggregate version. |
data[].createdAt | string:date-timeISO 8601 timestamp when the item was created. |
data[].createdBy | stringUser identifier that created this item. |
data[].updatedAt | string:date-timeISO 8601 timestamp when the item was last updated. |
data[].updatedBy | stringUser identifier that last updated this item. |
data[].cursor | integerLatest cursor projected into this set list item record. |
page | object |
page.limit | integerMaximum number of records returned in this page. |
page.nextCursor | string | nullOpaque cursor to pass as the next request's cursor query parameter with the same credential, endpoint, and filters within 24 hours, or null when there are no more results. Restart pagination after expiration or credential changes. |
meta | object |
meta.cursor | number | nullHighest record cursor represented by this response. |
Create a set list item
POST/v1/teams/{teamId}/set-list-itemsAccepts a command to create a reusable set list library item.
Required scopes: set_list_item:write
Parameters
path.teamIdrequired | string:uuidTeam identifier. |
|---|---|
header.Idempotency-Key | string:uuidOptional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request. |
Request body (application/json)
titlerequired | stringReusable set list item title. |
|---|---|
durationSecondsrequired | integerDefault duration in seconds for this reusable set list item. |
printTitle | stringOptional title to use on printed set list output. |
notes | stringOptional notes for the set list item. |
id | string:uuidOptional caller-supplied set list item ID. RoadOps generates one when omitted. |
Response 202
commandId | string:uuidCommand identifier accepted into the RoadOps command ledger. |
|---|---|
resourceId | string:uuidIdentifier of the resource targeted by the command. |
resourceType | stringResource type targeted by the command. |
status | "applied"Command dispatch status. |
aggregateVersion | integerAggregate version produced by the accepted command. |
cursor | integerCursor for the accepted update. Refetch until returned records reach this cursor. |
links | object |
links.refetch | stringRelative URL to refetch the affected resource. |
Retrieve a set list item
GET/v1/teams/{teamId}/set-list-items/{setListItemId}Returns one reusable set list library item by ID.
Required scopes: set_list_item:read
Parameters
path.teamIdrequired | string:uuidTeam identifier. |
|---|---|
path.setListItemIdrequired | string:uuidSet list item identifier. |
Response 200
data | object |
|---|---|
data.title | stringReusable set list item title. |
data.durationSeconds | integerDefault duration in seconds for this reusable set list item. |
data.printTitle | stringOptional title to use on printed set list output. |
data.notes | stringOptional notes for the set list item. |
data.id | string:uuidSet list item identifier. |
data.orgId | string:uuidTeam identifier that owns this reusable set list item. |
data.isRetired | booleanWhether this reusable item is hidden from active use. |
data.retiredAt | string:date-timeISO 8601 timestamp when the item was retired. |
data.retiredBy | stringUser identifier that retired this item. |
data.isDeleted | booleanWhether this reusable item has been deleted. |
data.version | integerCurrent set list item aggregate version. |
data.createdAt | string:date-timeISO 8601 timestamp when the item was created. |
data.createdBy | stringUser identifier that created this item. |
data.updatedAt | string:date-timeISO 8601 timestamp when the item was last updated. |
data.updatedBy | stringUser identifier that last updated this item. |
data.cursor | integerLatest cursor projected into this set list item record. |
meta | object |
meta.cursor | integerHighest record cursor represented by this response. |
Update a set list item
PATCH/v1/teams/{teamId}/set-list-items/{setListItemId}Accepts a command to update reusable set list library item fields.
Required scopes: set_list_item:write
Parameters
path.teamIdrequired | string:uuidTeam identifier. |
|---|---|
path.setListItemIdrequired | string:uuidSet list item identifier. |
header.Idempotency-Key | string:uuidOptional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request. |
Request body (application/json)
expectedVersion | integerOptional aggregate version guard. |
|---|---|
updatesrequired | objectSet list library item fields to update. |
updates.title | stringReusable set list item title. |
updates.durationSeconds | integerDefault duration in seconds for this reusable set list item. |
updates.printTitle | stringOptional title to use on printed set list output. |
updates.notes | stringOptional notes for the set list item. |
Response 202
commandId | string:uuidCommand identifier accepted into the RoadOps command ledger. |
|---|---|
resourceId | string:uuidIdentifier of the resource targeted by the command. |
resourceType | stringResource type targeted by the command. |
status | "applied"Command dispatch status. |
aggregateVersion | integerAggregate version produced by the accepted command. |
cursor | integerCursor for the accepted update. Refetch until returned records reach this cursor. |
links | object |
links.refetch | stringRelative URL to refetch the affected resource. |
Delete a set list item
DELETE/v1/teams/{teamId}/set-list-items/{setListItemId}Accepts a command to delete a reusable set list library item.
Required scopes: set_list_item:write
Parameters
path.teamIdrequired | string:uuidTeam identifier. |
|---|---|
path.setListItemIdrequired | string:uuidSet list item identifier. |
header.Idempotency-Key | string:uuidOptional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request. |
Response 202
commandId | string:uuidCommand identifier accepted into the RoadOps command ledger. |
|---|---|
resourceId | string:uuidIdentifier of the resource targeted by the command. |
resourceType | stringResource type targeted by the command. |
status | "applied"Command dispatch status. |
aggregateVersion | integerAggregate version produced by the accepted command. |
cursor | integerCursor for the accepted update. Refetch until returned records reach this cursor. |
links | object |
links.refetch | stringRelative URL to refetch the affected resource. |
Retire a set list item
POST/v1/teams/{teamId}/set-list-items/{setListItemId}/retireAccepts a command to retire a reusable set list library item without deleting it.
Required scopes: set_list_item:write
Parameters
path.teamIdrequired | string:uuidTeam identifier. |
|---|---|
path.setListItemIdrequired | string:uuidSet list item identifier. |
header.Idempotency-Key | string:uuidOptional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request. |
Request body (application/json)
expectedVersion | integerOptional aggregate version guard. |
|---|---|
timestamp | string:date-timeOptional ISO 8601 timestamp to use for the lifecycle transition. |
Response 202
commandId | string:uuidCommand identifier accepted into the RoadOps command ledger. |
|---|---|
resourceId | string:uuidIdentifier of the resource targeted by the command. |
resourceType | stringResource type targeted by the command. |
status | "applied"Command dispatch status. |
aggregateVersion | integerAggregate version produced by the accepted command. |
cursor | integerCursor for the accepted update. Refetch until returned records reach this cursor. |
links | object |
links.refetch | stringRelative URL to refetch the affected resource. |
Restore a set list item
POST/v1/teams/{teamId}/set-list-items/{setListItemId}/restoreAccepts a command to restore a retired reusable set list library item.
Required scopes: set_list_item:write
Parameters
path.teamIdrequired | string:uuidTeam identifier. |
|---|---|
path.setListItemIdrequired | string:uuidSet list item identifier. |
header.Idempotency-Key | string:uuidOptional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request. |
Request body (application/json)
expectedVersion | integerOptional aggregate version guard. |
|---|---|
timestamp | string:date-timeOptional ISO 8601 timestamp to use for the lifecycle transition. |
Response 202
commandId | string:uuidCommand identifier accepted into the RoadOps command ledger. |
|---|---|
resourceId | string:uuidIdentifier of the resource targeted by the command. |
resourceType | stringResource type targeted by the command. |
status | "applied"Command dispatch status. |
aggregateVersion | integerAggregate version produced by the accepted command. |
cursor | integerCursor for the accepted update. Refetch until returned records reach this cursor. |
links | object |
links.refetch | stringRelative URL to refetch the affected resource. |