v1

latestOpenAPI 3.0.0Proprietary2026-07-26130282259.8 KB

jobs

Get Job by ID

Use this endpoint to get details for a specific job. Unassigned leads or jobs will not be returned. Supported includes: contact, initialAppointment.

get/jobs/{jobId}

Path parameters

jobIdstring uuid required

The job's unique identifier

Query parameters

includesstring

Optional fields to include in full with the response.

Response

idstring uuid

The job's unique ID.

_linkstring

The URI of this Job.

leadDeadReasonstring

The reason why the lead was marked as dead.

milestoneDatestring date-time

The date/time when the job entered its current milestone.

createdDatestring date-time

The date/time when this job was created.

modifiedDatestring date-time

The date/time when this job was last modified (touched).

This job's current milestone. This field is Read Only.

jobNumberstring

The alphanumeric identifier for the job, as definied by the company settings.

jobNamestring

The full name for this job.

priority'Normal' | 'High' | 'Urgent'

The job assigned priority

Example response

{
  "id": "e591bf22-9828-4144-bca8-42cbb8c6e2c0",
  "_link": "https://api.acculynx.com/api/v2/jobs/e591bf22-9828-4144-bca8-42cbb8c6e2c0",
  "geoLocation": {
    "latitude": 40.689,
    "longitude": -74.044
  },
  "initialAppointment": {
    "_link": "https://api.acculynx.com/api/v2/jobs/3bd1f24d-44f9-4633-83a1-5ff4f3921a01/initial-appointment"
  },
  "leadDeadReason": "Declined",
  "milestoneDate": "2021-01-20T21:18:25Z",
  "createdDate": "2021-01-20T21:18:25Z",
  "modifiedDate": "2021-01-20T21:18:25Z",
  "currentMilestone": "Prospect",
  "jobNumber": "JK-2964",
  "jobName": "JK-2964: John Smith",
  "priority": "Urgent"
}