Returns all comments of the document with the specified id. | awork API

1 curl https://api.awork.com/api/v1/documents/documentId/comments \ 2 -H "Authorization: Bearer <token>"

1 [ 2 { 3 "id": "123e4567-e89b-12d3-a456-426614174000", 4 "entityId": "123e4567-e89b-12d3-a456-426614174000", 5 "entityType": "tasks", 6 "entity": { 7 "id": "123e4567-e89b-12d3-a456-426614174000", 8 "name": null 9 }, 10 "project": { 11 "id": "123e4567-e89b-12d3-a456-426614174000", 12 "name": null 13 }, 14 "task": { 15 "id": "123e4567-e89b-12d3-a456-426614174000", 16 "name": null 17 }, 18 "document": { 19 "id": "123e4567-e89b-12d3-a456-426614174000", 20 "name": null 21 }, 22 "createdOn": "createdOn", 23 "createdBy": "123e4567-e89b-12d3-a456-426614174000", 24 "user": { 25 "id": "123e4567-e89b-12d3-a456-426614174000", 26 "firstName": null, 27 "lastName": null, 28 "hasImage": null, 29 "isExternal": false 30 }, 31 "updatedOn": "updatedOn", 32 "updatedBy": "123e4567-e89b-12d3-a456-426614174000", 33 "mentions": { 34 "users": [ 35 { 36 "id": "123e4567-e89b-12d3-a456-426614174000", 37 "firstName": null, 38 "lastName": null, 39 "hasImage": null, 40 "isExternal": false 41 } 42 ], 43 "everyUserHadPermissions": true 44 }, 45 "reactions": [ 46 { 47 "userId": "123e4567-e89b-12d3-a456-426614174000", 48 "emoji": "👍" 49 } 50 ], 51 "formattedMessage": "Hey team, the customer loved the latest designs!", 52 "plainFormattedMessage": "Hey team, the customer loved the latest designs!", 53 "resourceVersion": 637825154598057900, 54 "message": "Hey team, the customer loved the latest designs!", 55 "userId": "123e4567-e89b-12d3-a456-426614174000", 56 "previews": [ 57 "https://www.awork.com/en/blog/automatic-project-management/" 58 ], 59 "isHiddenForConnectUsers": false, 60 "isResolved": null, 61 "inReplyToCommentId": "123e4567-e89b-12d3-a456-426614174000" 62 } 63 ]

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

Path parameters

documentIdUUIDRequired

The id of the document.

Headers

AuthorizationstringRequired

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

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

idUUID or null

The id of the comment.

entityIdUUID or null

The id of the entity of the comment. Required.

entityTypestring or null

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

entityobject or null

projectobject or null

taskobject or null

documentobject or null

createdOndatetime or null

The date this object was created.

createdByUUID or null

The id of the user who created this object.

userobject or null

updatedOndatetime or null

The date this object was last modified.

updatedByUUID or null

The id of the user who last modified this object.

mentionsobject or null

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

reactionslist of objects or null

The reactions on a comment.

formattedMessagestring or null

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 null

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.

resourceVersionlong or null

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

messagestring or null

The message of the comment.

userIdUUID or null

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

previewslist of strings or null

The preview URLs to show a preview for.

isHiddenForConnectUsersboolean or null

True if the comment should be hidden to connect users.

isResolvedboolean or null

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

inReplyToCommentIdUUID or null

The parent comment this comment is a reply to.