Returns all project milestones the user is allowed to see.

GET

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

Play

200Retrieved

1 [
2   {
3     "name": "Internal Review",
4     "color": "green",
5     "dueDate": "2022-03-01T15:00:00Z",
6     "projectId": "123e4567-e89b-12d3-a456-426614174000",
7     "id": "123e4567-e89b-12d3-a456-426614174000",
8     "project": {
9       "name": "Website Design",
10       "isPrivate": false,
11       "description": "Sitemap, design, assets and implementation of the new online presence.",
12       "startDate": "2022-03-01T00:00:00Z",
13       "dueDate": "2022-05-01T00:00:00Z",
14       "companyId": "123e4567-e89b-12d3-a456-426614174000",
15       "timeBudget": 576000,
16       "isBillableByDefault": true,
17       "projectTypeId": "123e4567-e89b-12d3-a456-426614174000",
18       "color": "purple",
19       "deductNonBillableHours": false,
20       "projectStatusId": "123e4567-e89b-12d3-a456-426614174000",
21       "projectTemplateId": "123e4567-e89b-12d3-a456-426614174000",
22       "publicProjectTemplateId": "123e4567-e89b-12d3-a456-426614174000",
23       "id": "123e4567-e89b-12d3-a456-426614174000",
24       "hasImage": true,
25       "createdOn": "createdOn",
26       "createdBy": "123e4567-e89b-12d3-a456-426614174000",
27       "updatedOn": "updatedOn",
28       "updatedBy": "123e4567-e89b-12d3-a456-426614174000",
29       "closedOn": null,
30       "closedBy": "123e4567-e89b-12d3-a456-426614174000",
31       "createdByProjectTemplateId": "123e4567-e89b-12d3-a456-426614174000",
32       "projectType": {
33         "id": "123e4567-e89b-12d3-a456-426614174000",
34         "name": null,
35         "icon": null,
36         "isArchived": false
37       },
38       "projectStatus": {
39         "id": "123e4567-e89b-12d3-a456-426614174000",
40         "name": null,
41         "description": null,
42         "type": null,
43         "isArchived": false,
44         "typeOrder": 1,
45         "isExternal": true
46       },
47       "company": {
48         "id": "123e4567-e89b-12d3-a456-426614174000",
49         "name": null,
50         "hasImage": true,
51         "description": "A brand strategy and design agency",
52         "tags": [
53           {
54             "id": "123e4567-e89b-12d3-a456-426614174000",
55             "name": null,
56             "color": null,
57             "entityId": "123e4567-e89b-12d3-a456-426614174000"
58           }
59         ]
60       },
61       "tags": [
62         {
63           "id": "123e4567-e89b-12d3-a456-426614174000",
64           "name": "Design",
65           "color": "purple"
66         }
67       ],
68       "plannedDuration": 432000,
69       "tasksCount": 12,
70       "tasksDoneCount": 3,
71       "members": [
72         {
73           "id": "123e4567-e89b-12d3-a456-426614174000",
74           "userId": "123e4567-e89b-12d3-a456-426614174000",
75           "firstName": "Lisa",
76           "lastName": "Smith",
77           "hasImage": true,
78           "projectRoleId": "123e4567-e89b-12d3-a456-426614174000",
79           "projectRoleName": "Project Manager",
80           "isResponsible": true,
81           "isDeactivated": false,
82           "isExternal": true
83         }
84       ],
85       "trackedDuration": 72000,
86       "resourceVersion": 637825154598057900,
87       "teams": [
88         {
89           "id": "123e4567-e89b-12d3-a456-426614174000",
90           "name": "Designers",
91           "icon": "paintbrush",
92           "color": "purple"
93         }
94       ],
95       "isExternal": true,
96       "isRetainer": false
97     },
98     "createdOn": "createdOn",
99     "createdBy": "123e4567-e89b-12d3-a456-426614174000",
100     "updatedOn": "updatedOn",
101     "updatedBy": "123e4567-e89b-12d3-a456-426614174000"
102   }
103 ]

The user only gets returned all milestones of projects he has ‘read’ permissions of feature ‘project-planning-data’ for.

Required Permissions

Any authenticated user.

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

namestring or nullOptional>=0 characters<=255 characters

The name of the milestone.

colorstring or nullOptional>=0 characters<=14 characters

The color of the milestone.

dueDatedatetimeOptional

The date the milestone is due.

projectIdUUIDOptional

The id of the project the milestone is related to.

idUUIDOptional

projectobjectOptional

/// This class contains all information to handle projects.

createdOndatetimeOptional

The date this entity was created.

createdByUUIDOptional

The id of the user who created this entity.

updatedOndatetimeOptional

The date this entity was last modified.

updatedByUUIDOptional

The id of the user who last modified this entity.

Required Permissions

Headers

Query parameters

Response