List document comments

GET/workspaces/{organizationId}/documents/{id}/comments

Path parameters

organizationIdstringrequired

idstringrequired

Responses

200Document comments

commentsobject[]required

Show properties

Array of object

idstringrequired

organizationIdstringrequired

issueIdstring | nullrequired

documentIdstring | nullrequired

authorIdstring | nullrequired

bodystringrequired

resolvedAtstring | nullrequired

resolvedByIdstring | nullrequired

createdAtstringrequired

updatedAtstringrequired

404Document not found

Try it

Server

Custom base URLOverrides the selected server when set.

Parameters

organizationIdpath*idpath*

Request

curl -X GET "/workspaces/string/documents/string/comments"

const response = await fetch("/workspaces/string/documents/string/comments", {
  method: "GET"
});

import requests

response = requests.get(
    "/workspaces/string/documents/string/comments",
)

Response

{
  "comments": [
    {
      "id": "string",
      "organizationId": "string",
      "issueId": "string",
      "documentId": "string",
      "authorId": "string",
      "body": "string",
      "resolvedAt": "string",
      "resolvedById": "string",
      "createdAt": "string",
      "updatedAt": "string"
    }
  ]
}