Task Notes
Ask
List task notes
GET/v1/teams/{teamId}/days/{dayId}/tasks/{taskId}/notesLists the flat note thread for a visible Task.
Required scopes: task_note:read
Parameters
path.teamIdrequired | string:uuidTeam identifier. |
|---|---|
path.dayIdrequired | string:uuidDay identifier. |
path.taskIdrequired | string:uuidTask 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[].id | string:uuidTask note identifier. |
data[].orgId | string:uuidOrganization identifier. |
data[].taskId | string:uuidParent Task identifier. |
data[].dayId | string:uuidAssociated Day identifier used for activity and sync. |
data[].body | stringPlain-text Task note body. |
data[].authorId | string:uuidRoadOps user ID of the note author. |
data[].createdAt | string:date-timeUTC note creation timestamp. |
data[].updatedAt | string:date-timeUTC timestamp of the latest note change. |
data[].isDeleted | booleanSoft-delete flag. |
data[].version | integerCurrent note aggregate version. |
data[].cursor | integerLatest cursor projected into this note. |
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. |
Add a task note
POST/v1/teams/{teamId}/days/{dayId}/tasks/{taskId}/notesAdds a plain-text note to a visible Task.
Required scopes: task_note:write
Parameters
path.teamIdrequired | string:uuidTeam identifier. |
|---|---|
path.dayIdrequired | string:uuidDay identifier. |
path.taskIdrequired | string:uuidTask 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)
id | string:uuid |
|---|---|
bodyrequired | stringPlain-text Task note body. |
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. |
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.teamIdrequired | string:uuidTeam identifier. |
|---|---|
path.dayIdrequired | string:uuidDay identifier. |
path.taskIdrequired | string:uuidTask identifier. |
path.noteIdrequired | string:uuidNote 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 | integer |
|---|---|
bodyrequired | stringPlain-text Task note body. |
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 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.teamIdrequired | string:uuidTeam identifier. |
|---|---|
path.dayIdrequired | string:uuidDay identifier. |
path.taskIdrequired | string:uuidTask identifier. |
path.noteIdrequired | string:uuidNote 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. |