Returns all comments of the project with the specified id.

GET

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

Play

200Retrieved

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     "createdOn": "createdOn",
19     "createdBy": "123e4567-e89b-12d3-a456-426614174000",
20     "user": {
21       "id": "123e4567-e89b-12d3-a456-426614174000",
22       "firstName": null,
23       "lastName": null,
24       "hasImage": null,
25       "isExternal": false
26     },
27     "updatedOn": "updatedOn",
28     "updatedBy": "123e4567-e89b-12d3-a456-426614174000",
29     "mentions": {
30       "users": [
31         {
32           "id": "123e4567-e89b-12d3-a456-426614174000",
33           "firstName": null,
34           "lastName": null,
35           "hasImage": null,
36           "isExternal": false
37         }
38       ],
39       "everyUserHadPermissions": true
40     },
41     "reactions": [
42       {
43         "userId": "123e4567-e89b-12d3-a456-426614174000",
44         "emoji": "👍"
45       }
46     ],
47     "formattedMessage": "Hey team, the customer loved the latest designs!",
48     "plainFormattedMessage": "Hey team, the customer loved the latest designs!",
49     "resourceVersion": 637825154598057900,
50     "message": "Hey team, the customer loved the latest designs!",
51     "userId": "123e4567-e89b-12d3-a456-426614174000",
52     "previews": [
53       "https://www.awork.com/en/blog/automatic-project-management/"
54     ],
55     "isHiddenForConnectUsers": false
56   }
57 ]

Returns all comments of the project with the specified id.

Path parameters

projectIdUUIDRequired

The id of the project.

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

idUUIDOptional

The id of the comment.

entityIdUUIDOptional

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

createdOndatetimeOptional

The date this object was created.

createdByUUIDOptional

The id of the user who created this object.

userobjectOptional

updatedOndatetimeOptional

The date this object was last modified.

updatedByUUIDOptional

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 objectsOptional

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.

resourceVersionlongOptional

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.

userIdUUID or nullOptional

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

previewslist of stringsOptional

The preview URLs to show a preview for.

isHiddenForConnectUsersbooleanOptional

True if the comment should be hidden to connect users.