Retrieves all project milestones.

GET

https://api.awork.com/api/v1/projectmilestones

GET

/api/v1/projectmilestones

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

200Retrieved

[
  {
    "name": "Internal Review",
    "color": "green",
    "projectId": "123e4567-e89b-12d3-a456-426614174000",
    "dueDate": "2022-03-01T15:00:00Z",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "project": {
      "name": "Website Design",
      "isPrivate": false,
      "description": "Sitemap, design, assets and implementation of the new online presence.",
      "startDate": "2022-03-01T00:00:00Z",
      "dueDate": "2022-05-01T00:00:00Z",
      "companyId": "123e4567-e89b-12d3-a456-426614174000",
      "timeBudget": 576000,
      "isBillableByDefault": true,
      "projectTypeId": "123e4567-e89b-12d3-a456-426614174000",
      "color": "purple",
      "deductNonBillableHours": true,
      "isProjectKeyVisible": true,
      "projectStatusId": "123e4567-e89b-12d3-a456-426614174000",
      "projectTemplateId": "123e4567-e89b-12d3-a456-426614174000",
      "publicProjectTemplateId": "123e4567-e89b-12d3-a456-426614174000",
      "workflowId": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "projectKey": "string",
      "hasImage": true,
      "createdOn": "2024-01-15T09:30:00Z",
      "createdBy": "123e4567-e89b-12d3-a456-426614174000",
      "updatedOn": "2024-01-15T09:30:00Z",
      "updatedBy": "123e4567-e89b-12d3-a456-426614174000",
      "closedOn": null,
      "closedBy": "123e4567-e89b-12d3-a456-426614174000",
      "createdByProjectTemplateId": "123e4567-e89b-12d3-a456-426614174000",
      "projectType": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "Design",
        "icon": "thumb_up",
        "isArchived": false
      },
      "projectStatus": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "Design",
        "description": "Work in progress",
        "type": "todo",
        "isArchived": false,
        "typeOrder": 1,
        "isExternal": true
      },
      "company": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "Design",
        "hasImage": true,
        "description": "A brand strategy and design agency",
        "tags": [
          {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "name": "Design",
            "color": "purple",
            "entityId": "123e4567-e89b-12d3-a456-426614174000"
          }
        ]
      },
      "tags": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "Design",
          "color": "purple"
        }
      ],
      "totalPlannedDurationWithHierarchy": 432000,
      "tasksCount": 12,
      "tasksDoneCount": 3,
      "members": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "userId": "123e4567-e89b-12d3-a456-426614174000",
          "firstName": "Lisa",
          "lastName": "Smith",
          "hasImage": true,
          "projectRoleId": "123e4567-e89b-12d3-a456-426614174000",
          "projectRoleName": "Project Manager",
          "isResponsible": true,
          "isDeactivated": false,
          "isExternal": true
        }
      ],
      "trackedDuration": 72000,
      "customFields": [
        {
          "customFieldDefinitionId": "123e4567-e89b-12d3-a456-426614174000",
          "userIdValue": "123e4567-e89b-12d3-a456-426614174000",
          "clientIdValue": "123e4567-e89b-12d3-a456-426614174000",
          "numberValue": 123.45,
          "selectionOptionIdValue": "123e4567-e89b-12d3-a456-426614174000",
          "selectionOption": {
            "value": "Website Design",
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "color": "purple",
            "order": 0
          },
          "textValue": "S1: Business Critical",
          "dateValue": "2024-01-15T09:30:00Z",
          "booleanValue": true
        }
      ],
      "resourceVersion": 637825154598057900,
      "teams": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "Designers",
          "icon": "paintbrush",
          "color": "purple"
        }
      ],
      "isExternal": true,
      "isRetainer": true,
      "isMultiAssignmentAllowed": true,
      "plannedDuration": 432000
    },
    "createdOn": "2024-01-15T09:30:00Z",
    "createdBy": "123e4567-e89b-12d3-a456-426614174000",
    "updatedOn": "2024-01-15T09:30:00Z",
    "updatedBy": "123e4567-e89b-12d3-a456-426614174000"
  }
]

Required Permissions

Any authenticated user.

<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.

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

namestring0-255 characters

The name of the milestone.

colorenum

The color of the milestone.

projectIdstringformat: "uuid"

The id of the project the milestone is related to.

dueDatestringOptionalformat: "date-time"

The date the milestone is due.

idstringOptionalformat: "uuid"

projectobjectOptional

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

createdOnstringOptionalformat: "date-time"

The date this entity was created.

createdBystringOptionalformat: "uuid"

The id of the user who created this entity.

updatedOnstringOptionalformat: "date-time"

The date this entity was last modified.

updatedBystringOptionalformat: "uuid"

The id of the user who last modified this entity.