jobs

Get Current Job Milestone

Get the current milestone information. For including statuses the company must have enabled custom workflows. Supported includes: status.

get/jobs/{jobId}/milestones/current

Request

  • Base URL
    https://api.acculynx.com/api/v2
  • URL
    https://api.acculynx.com/api/v2/jobs/{jobId}/milestones/current
  • Auth
    HTTP bearer

Path parameters

jobIdstring uuid required

The job's unique identifier

Query parameters

includesstring

A comma-separated list of related resources to expand inline in the response. Valid values vary by endpoint and are documented in each operation description.

Response

OK

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

This job's current milestone.

isCurrentboolean

Example response

{
  "id": "40be7484-ece1-4a01-9b4c-2de030d0c841",
  "_link": "https://api.acculynx.com/api/v2/jobs/40be7484-ece1-4a01-9b4c-2de030d0c841",
  "name": "Prospect",
  "isCurrent": true,
  "duration": {
    "startDate": "2024-01-13T11:54:45Z",
    "endDate": "2024-01-13T11:54:45Z"
  },
  "statuses": [
    {
      "id": "40be7484-ece1-4a01-9b4c-2de030d0c841",
      "_link": "https://api.acculynx.com/api/v2/jobs/40be7484-ece1-4a01-9b4c-2de030d0c841",
      "name": "Repair tools requirements",
      "duration": {
        "startDate": "2024-01-13T11:54:45Z",
        "endDate": "2024-01-13T11:54:45Z"
      },
      "workflowStatus": {
        "id": "85ef9e16-07cf-41a7-be04-533204d7c71a",
        "name": "Repair tools requirements"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.