RoadOps Developer Docs

List task notes

GET/v1/teams/{teamId}/days/{dayId}/tasks/{taskId}/notes

Lists the flat note thread for a visible Task.

Required scopes: task_note:read

Parameters

`path.teamId`required	`string:uuid` Team identifier.
`path.dayId`required	`string:uuid` Day identifier.
`path.taskId`required	`string:uuid` Task identifier.
`query.limit`	`integer` Maximum number of records to return. Defaults to 50 and is capped at 200.
`query.cursor`	`string` Cursor returned by page.nextCursor from the previous list response.

Response 200

`data`	`object[]`
`data[].id`	`string:uuid` Task note identifier.
`data[].orgId`	`string:uuid` Organization identifier.
`data[].taskId`	`string:uuid` Parent Task identifier.
`data[].dayId`	`string:uuid` Associated Day identifier used for activity and sync.
`data[].body`	`string` Plain-text Task note body.
`data[].authorId`	`string:uuid` RoadOps user ID of the note author.
`data[].createdAt`	`string:date-time` UTC note creation timestamp.
`data[].updatedAt`	`string:date-time` UTC timestamp of the latest note change.
`data[].isDeleted`	`boolean` Soft-delete flag.
`data[].version`	`integer` Current note aggregate version.
`data[].cursor`	`integer` Latest cursor projected into this note.
`page`	`object`
`page.limit`	`integer` Maximum number of records returned in this page.
`page.nextCursor`	`string \| null` Cursor to pass as the next request's cursor query parameter, or null when there are no more results.

Add a task note

POST/v1/teams/{teamId}/days/{dayId}/tasks/{taskId}/notes

Adds a plain-text note to a visible Task.

Required scopes: task_note:write

Parameters

`path.teamId`required	`string:uuid` Team identifier.
`path.dayId`required	`string:uuid` Day identifier.
`path.taskId`required	`string:uuid` Task identifier.
`header.Idempotency-Key`	`string:uuid` Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.

Request body (application/json)

`id`	`string:uuid`
`body`required	`string` Plain-text Task note body.

Response 202

`commandId`	`string:uuid` Command identifier accepted into the RoadOps command ledger.
`resourceId`	`string:uuid` Identifier of the resource targeted by the command.
`resourceType`	`string` Resource type targeted by the command.
`status`	`"applied"` Command dispatch status.
`aggregateVersion`	`integer` Aggregate version produced by the accepted command.
`cursor`	`integer` Cursor for the accepted update. Refetch until returned records reach this cursor.
`links`	`object`
`links.refetch`	`string` Relative URL to refetch the affected resource.

Update a task note

PATCH/v1/teams/{teamId}/days/{dayId}/tasks/{taskId}/notes/{noteId}

Updates a Task note subject to author or Manage All rules.

Required scopes: task_note:write

Parameters

`path.teamId`required	`string:uuid` Team identifier.
`path.dayId`required	`string:uuid` Day identifier.
`path.taskId`required	`string:uuid` Task identifier.
`path.noteId`required	`string:uuid` Note identifier.
`header.Idempotency-Key`	`string:uuid` Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.

Request body (application/json)

`expectedVersion`	`integer`
`body`required	`string` Plain-text Task note body.

Response 202

`commandId`	`string:uuid` Command identifier accepted into the RoadOps command ledger.
`resourceId`	`string:uuid` Identifier of the resource targeted by the command.
`resourceType`	`string` Resource type targeted by the command.
`status`	`"applied"` Command dispatch status.
`aggregateVersion`	`integer` Aggregate version produced by the accepted command.
`cursor`	`integer` Cursor for the accepted update. Refetch until returned records reach this cursor.
`links`	`object`
`links.refetch`	`string` Relative URL to refetch the affected resource.

Delete a task note

DELETE/v1/teams/{teamId}/days/{dayId}/tasks/{taskId}/notes/{noteId}

Deletes a Task note subject to author or Manage All rules.

Required scopes: task_note:write

Parameters

`path.teamId`required	`string:uuid` Team identifier.
`path.dayId`required	`string:uuid` Day identifier.
`path.taskId`required	`string:uuid` Task identifier.
`path.noteId`required	`string:uuid` Note identifier.
`header.Idempotency-Key`	`string:uuid` Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.

Response 202

`commandId`	`string:uuid` Command identifier accepted into the RoadOps command ledger.
`resourceId`	`string:uuid` Identifier of the resource targeted by the command.
`resourceType`	`string` Resource type targeted by the command.
`status`	`"applied"` Command dispatch status.
`aggregateVersion`	`integer` Aggregate version produced by the accepted command.
`cursor`	`integer` Cursor for the accepted update. Refetch until returned records reach this cursor.
`links`	`object`
`links.refetch`	`string` Relative URL to refetch the affected resource.

Task Notes

List task notes

Parameters

Response 200

Add a task note

Parameters

Request body (application/json)

Response 202

Update a task note

Parameters

Request body (application/json)

Response 202

Delete a task note

Parameters

Response 202