Returns all comments of the document with the specified id.

GET

https://api.awork.com/api/v1/documents/:documentId/comments

GET

/api/v1/documents/:documentId/comments

$ curl https://api.awork.com/api/v1/documents/documentId/comments \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json"

1 [
2   {
3     "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
4     "entityId": "a3bb189e-8bf9-3888-9912-ace4e6543002",
5     "entityType": "tasks",
6     "entity": {
7       "id": "a3bb189e-8bf9-3888-9912-ace4e6543002",
8       "name": "Design Homepage"
9     },
10     "project": {
11       "id": "b1a7f8d2-4c3e-4f9a-9c3d-1a2b3c4d5e6f",
12       "name": "Website Redesign"
13     },
14     "task": {
15       "id": "a3bb189e-8bf9-3888-9912-ace4e6543002",
16       "name": "Design Homepage"
17     },
18     "document": {
19       "id": "d9b2d63d-a233-4123-847a-7a79a1f9a1a3",
20       "name": "Homepage Wireframe"
21     },
22     "createdOn": "2024-01-15T09:30:00Z",
23     "createdBy": "c56a4180-65aa-42ec-a945-5fd21dec0538",
24     "user": {
25       "id": "c56a4180-65aa-42ec-a945-5fd21dec0538",
26       "firstName": "Carla",
27       "lastName": "Creative",
28       "hasImage": true,
29       "isExternal": false
30     },
31     "agentId": "e7d13b5a-9f3b-4c2a-8f7d-1a2b3c4d5e6f",
32     "agentNameSnapshot": "AutoCommentBot",
33     "updatedOn": "2024-01-15T10:00:00Z",
34     "updatedBy": "c56a4180-65aa-42ec-a945-5fd21dec0538",
35     "mentions": {
36       "users": [
37         {
38           "id": "d4e5f6a7-b8c9-4d0e-9f1a-2b3c4d5e6f7a",
39           "firstName": "John",
40           "lastName": "Doe",
41           "hasImage": false,
42           "isExternal": false
43         }
44       ],
45       "agentIds": [
46         "e7d13b5a-9f3b-4c2a-8f7d-1a2b3c4d5e6f"
47       ],
48       "everyUserHadPermissions": true
49     },
50     "reactions": [
51       {
52         "userId": "d4e5f6a7-b8c9-4d0e-9f1a-2b3c4d5e6f7a",
53         "emoji": "👍"
54       }
55     ],
56     "formattedMessage": "Hey team, the customer loved the latest designs!",
57     "plainFormattedMessage": "Hey team, the customer loved the latest designs!",
58     "resourceVersion": 637825154598057900,
59     "message": "Hey team, the customer loved the latest designs!",
60     "userId": "c56a4180-65aa-42ec-a945-5fd21dec0538",
61     "previews": [
62       "https://www.awork.com/en/blog/automatic-project-management/"
63     ],
64     "isHiddenForConnectUsers": false,
65     "isResolved": true,
66     "inReplyToCommentId": "f47ac10b-58cc-4372-a567-0e02b2c3d478"
67   }
68 ]

Returns all comments of the document with the specified id. The user needs read permissions on the document.

Required Permissions

Any authenticated user.

Returns all comments of the document with the specified id. The user needs read permissions on the document. <Check title="Required Permissions" icon="key">Any authenticated user.</Check>

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

documentIdstringRequiredformat: "uuid"

The id of the document.

Query parameters

pageintegerOptionalDefaults to 1

Page number for pagination

pageSizeintegerOptionalDefaults to 10

Number of items per page

orderbystringOptional

The properties to order by

filterbystringOptional

The filter expression to filter by

Response

idstringOptionalformat: "uuid"

The id of the comment.

entityIdstringOptionalformat: "uuid"

The id of the entity of the comment. Required.

entityTypestring or nullOptional

The type of the entity of the comment. Can be "projects", "tasks". Required.

entityobjectOptional

projectobjectOptional

taskobjectOptional

documentobjectOptional

createdOnstringOptionalformat: "date-time"

The date this object was created.

createdBystringOptionalformat: "uuid"

The id of the user who created this object.

userobjectOptional

agentIdstring or nullOptionalformat: "uuid"

The agent that visibly authored this comment, when it was created by an agent run.

agentNameSnapshotstring or nullOptional

The agent name captured when the comment was created.

updatedOnstringOptionalformat: "date-time"

The date this object was last modified.

updatedBystringOptionalformat: "uuid"

The id of the user who last modified this object.

mentionsobjectOptional

A mention is the tag of a user on a specific comment, so the user is notified.

reactionslist of objects or nullOptional

The reactions on a comment.

formattedMessagestring or nullOptional

The formatted and proccessed version of the comment message. E.g. mentions are in a human readable format. The formatted comment message is styled with html.

plainFormattedMessagestring or nullOptional

The formatted and proccessed version of the comment message. E.g. mentions are in a human readable format. The formatted comment message is not styled.

resourceVersionlongOptionalRead-only

The version of the entity, updated on every modification, to the ticks in UTC. Not identical to UpdatedOn.

messagestring or nullOptional

The message of the comment.

userIdstring or nullOptionalformat: "uuid"

The id of the user who created the comment. Optional. If not set, defaults to the current user.

previewslist of strings or nullOptional

The preview URLs to show a preview for.

isHiddenForConnectUsersbooleanOptional

True if the comment should be hidden to connect users.

isResolvedboolean or nullOptional

Whether the comment has been resolved. Only available for comments on documents.

inReplyToCommentIdstring or nullOptionalformat: "uuid"

The parent comment this comment is a reply to.

Errors

400

Bad Request Error

401

Unauthorized Error