jobs

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}

Request

  • Base URL
    https://api.acculynx.com/api/v2
  • URL
    https://api.acculynx.com/api/v2/jobs/{jobId}
  • 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

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 and time when this job was last modified.

currentMilestone'Lead' | 'Prospect' | 'Approved' | 'Completed' | 'Invoiced' | 'Closed' | 'Cancelled'

The job's current workflow milestone.

jobNumberstring

The human-readable reference number for this job. The format is configured in company settings.

jobNamestring

The full name for this job.

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

The priority level assigned to this job.

Example response

{
  "id": "e591bf22-9828-4144-bca8-42cbb8c6e2c0",
  "_link": "https://api.acculynx.com/api/v2/jobs/e591bf22-9828-4144-bca8-42cbb8c6e2c0",
  "contacts": [
    {
      "id": "989ea7b8-f579-4db3-8417-bae1b3a8cd21",
      "_link": "https://api.acculynx.com/api/v2/jobs/e591bf22-9828-4144-bca8-42cbb8c6e2c0/contact/989ea7b8-f579-4db3-8417-bae1b3a8cd21",
      "relationToPrimary": "Cousin",
      "contact": {
        "id": "61370abe-3534-4ba8-b2f2-2ff56cdd5e02",
        "_link": "https://api.acculynx.com/v2/contacts/61370abe-3534-4ba8-b2f2-2ff56cdd5e02",
        "firstName": "John",
        "lastName": "Smith",
        "salutation": "Mr.",
        "companyName": "Acme Roofing Inc.",
        "phoneNumbers": [
          {
            "id": "b2830ef6-c5ff-44ca-a3b9-aa767f50a04b",
            "_link": "https://api.acculynx.com/api/v2/contacts/7f008cca-9789-44c3-afdf-7ec2e005c267/phone-numbers/b2830ef6-c5ff-44ca-a3b9-aa767f50a04b"
          }
        ],
        "emailAddresses": [
          {
            "id": "40ac2713-13eb-4c69-8780-eee57fc71cba",
            "_link": "https://api.acculynx.com/api/v2/contacts/d0b29a1b-6023-4a27-b028-25e85796c40b/email-addresses/40ac2713-13eb-4c69-8780-eee57fc71cba"
          }
        ],
        "mailingAddress": {
          "street1": "123 Main St.",
          "street2": "Apt 2",
          "city": "Peoria",
          "state": {
            "id": 43,
            "name": "Texas",
            "abbreviation": "TX",
            "_link": "https://api.acculynx.com/api/v2/acculynx/countries/1/states/43"
          },
          "zipCode": "61603",
          "country": {
            "id": 1,
            "name": "United States",
            "abbreviation": "US",
            "_link": "https://api.acculynx.com/api/v2/acculynx/countries/1"
          }
        },
        "billingAddress": {
          "street1": "123 Main St.",
          "street2": "Apt 2",
          "city": "Peoria",
          "state": {
            "id": 43,
            "name": "Texas",
            "abbreviation": "TX",
            "_link": "https://api.acculynx.com/api/v2/acculynx/countries/1/states/43"
          },
          "zipCode": "61603",
          "country": {
            "id": 1,
            "name": "United States",
            "abbreviation": "US",
            "_link": "https://api.acculynx.com/api/v2/acculynx/countries/1"
          }
        },
        "createdDate": "2024-03-15T10:30:00Z",
        "modifiedDate": "2025-06-20T14:00:00Z"
      }
    }
  ],
  "locationAddress": {
    "street1": "123 Main St.",
    "street2": "Apt 2",
    "city": "Peoria",
    "state": {
      "id": 43,
      "name": "Texas",
      "abbreviation": "TX",
      "_link": "https://api.acculynx.com/api/v2/acculynx/countries/1/states/43"
    },
    "zipCode": "61603",
    "country": {
      "id": 1,
      "name": "United States",
      "abbreviation": "US",
      "_link": "https://api.acculynx.com/api/v2/acculynx/countries/1"
    }
  },
  "geoLocation": {
    "latitude": 40.689,
    "longitude": -74.044
  },
  "tradeTypes": [
    {
      "tradeId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "Windows"
    }
  ],
  "jobCategory": {
    "id": 1,
    "name": "Residential"
  },
  "workType": {
    "id": 2,
    "_link": "https://api.acculynx.com/api/v2/company-settings/job-file-settings/work-types/2",
    "name": "Insurance"
  },
  "leadSource": {
    "id": "f29b31a2-607e-4550-ab0b-8ff48f532253",
    "name": "Lead source",
    "_link": "https://api.acculynx.com/api/v2/company-settings/leads/lead-sources/f29b31a2-607e-4550-ab0b-8ff48f532253"
  },
  "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"
}

Changes

    • breaking

      added to the //// response property oneOf list for the response status

    • breaking

      the /////// response's property format changed from uri to no format for status

    • breaking

      the / response's property type changed from object to no type for status

    • breaking

      the /// response's property format changed from uri to no format for status

    • breaking

      the / response's property type changed from object to no type for status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added subschema #2 to the / response property allOf list for the response status

    • info

      added subschema #2 to the / response property allOf list for the response status

    • info

      removed subschema #2 from the //// response property allOf list for the response status