Playground

Playground

Comment

/api/v1/work/comments

A polymorphic comment attached to any target.

listgetcreateupdatedelete

Schema

FieldTypeNotes
id*uuidServer-assigned ULID with type prefix (e.g. per_…).
tenant_id*stringTenant scope — auto-stamped from the caller's JWT.
app_idstringApp scope. Stamped ONLY when the caller's JWT was minted for a specific Application (integration API keys). Absent for human-user sessions. Filters reads when present.
created_at*date-timeServer stamp.
updated_at*date-timeServer stamp; updated on every patch.
created_byuuidPerson id from the caller's JWT (sub).
updated_byuuidPerson id from the last writer's JWT (sub).
sourcestringProvenance tag — defaults to 'edm'.
source_typeenumfrontend | backend | server | system | apiWhere the write originated. Defaults to 'api'.
is_deletedbooleanSoft-delete flag. Excluded from default list queries.
deleted_atdate-timeStamped when soft-deleted; null otherwise.
deleted_byuuidPerson id who soft-deleted; null otherwise.
schema_versionnumberDocument schema version. Bumped on incompatible writes.
entity_typestringThe EDM entity type this comment is attached to (e.g., 'task', 'project', 'risk_item', 'contract').
entity_iduuidUUID of the specific entity instance this comment belongs to.
author_iduuidUUID of the Person who authored this comment.
bodystringMarkdown-formatted body text of the comment.
parent_comment_iduuidUUID of the parent Comment when this is a threaded reply. Null for top-level comments.
resolved_atdate-timeISO 8601 timestamp when this comment thread was marked resolved. Null if unresolved.
resolved_by_iduuidUUID of the Person who resolved this comment. Null if unresolved.

API

client.work.comments.*
Loading manifest…