Sign in

v1

latestOpenAPI 3.0.0Proprietary2026-07-26130282259.8 KB
jobs

Get Job Milestone by ID

Get a single milestone information by id. For including statuses the company must have enabled custom workflows. Supported includes: status.

get/jobs/{jobId}/milestones/{milestoneId}

Path parameters

jobIdstring uuid required

The job's unique identifier

milestoneIdstring uuid required

The milestone unique identifier

Query parameters

includesstring

Optional fields to include in full with the response.

Response

OK

idstring uuid
_linkstring uri
name'Lead' | 'Prospect' | 'Approved' | 'Completed' | 'Invoiced' | 'Closed' | 'Cancelled'

This job's current milestone.

isCurrentboolean

Example response

{
  "name": "Prospect",
  "isCurrent": true,
  "duration": {
    "startDate": "2024-01-13T11:54:45Z",
    "endDate": "2024-01-13T11:54:45Z"
  },
  "statuses": [
    {
      "name": "Repair tools requirements",
      "duration": {
        "startDate": "2024-01-13T11:54:45Z",
        "endDate": "2024-01-13T11:54:45Z"
      }
    }
  ]
}