TRtrydock
Comments

List comments on a workspace

Returns comments on this workspace, scoped + filtered by query params. Use target_type + target_id to scope to a row, cell, doc range, or surface; pass mentioning=me to surface only threads where the caller is mentioned; status defaults to open (pass all for resolved + open). Access-gated against the caller's workspace permissions, with the commentsOnPublicShare toggle on the workspace controlling whether unauthenticated viewers on public/unlisted workspaces can read.

get/api/workspaces/{slug}/comments

Request

  • Base URL
    https://trydock.ai
  • Auth
    HTTP bearer

Path parameters

slugstring required

Query parameters

target_type'row' | 'cell' | 'doc_range' | 'html_element' | 'video_frame' | 'surface' | 'workspace' | 'file'
target_idstring
surfacestring
status'open' | 'resolved' | 'all'
mentioning'me'
authorstring
limitinteger
offsetinteger nullable

Response

Comment list.

totalinteger required

Example response

{
  "comments": [
    {
      "id": "cmt_01J5Z…"
    }
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.