---
title: "Get Milestones"
method: GET
path: "/company-settings/job-file-settings/workflow-milestones"
tags: ["company"]
---

# Get Milestones

`GET /company-settings/job-file-settings/workflow-milestones`

## Request

- Base URL: `https://api.acculynx.com/api/v2`
- URL: `https://api.acculynx.com/api/v2/company-settings/job-file-settings/workflow-milestones`
- Auth: HTTP bearer

Get milestones related to company. For including statuses, the company must have enabled custom workflows.
**Supported includes:** `status`.

## Query parameters

- `includes` string

## Response `200`

OK

- WorkflowMilestoneCollection
  - `items` WorkflowMilestoneItem[]
    - `id` integer: The unique identifier of the milestone.
    - `name` 'Lead' | 'Prospect' | 'Approved' | 'Completed' | 'Invoiced' | 'Closed' | 'Dead' | 'Deleted'
    - `statuses` WorkflowMilestoneStatusItem[]
      - `id` string, uuid: The unique identifier of the status.
      - `name` string: The descriptive name of this status.

## Other responses

- `400`: The request was malformed or contained invalid field values. Check the error response body for details.
- `401`: The API key provided is missing, invalid, or has been deactivated. Verify your API key and try again.
- `403`: The API key does not have permission to perform this operation. Contact your administrator to request the required access.
- `404`: The requested resource was not found. Verify the ID in the request path is correct and that the resource exists.
- `412`: The request could not be completed due to the failure of a required precondition.

---

[API](https://skmtc.dev/acculynx/apis/acculynx-api-v2.md) - [All operations](https://skmtc.dev/acculynx/apis/acculynx-api-v2/llms.txt) - [OpenAPI document](https://skmtc.dev/acculynx/apis/acculynx-api-v2/revisions/443924b00f43?raw)