--- title: "Get Job by ID" method: GET path: "/jobs/{jobId}" tags: ["jobs"] --- # Get Job by ID `GET /jobs/{jobId}` ## Request - Base URL: `https://api.acculynx.com/api/v2` - URL: `https://api.acculynx.com/api/v2/jobs/{jobId}` - Auth: HTTP bearer Use this endpoint to get details for a specific job. Unassigned leads or jobs will not be returned. **Supported includes:** `contact`, `initialAppointment`. ## Path parameters - `jobId` string, uuid, required ## Query parameters - `includes` string ## Response `200` OK - Job - `id` string, uuid: The job's unique ID. - `_link` string: The URI of this Job. - `contacts` JobContact[]: The contacts linked to this job, including relationship metadata for each entry. By default, the nested contact object contains only an ID and link reference. Specify `contact` in the `includes` query parameter to expand each nested contact with its full profile (name, phone numbers, and email addresses). - `id` string, uuid: The contact's unique ID. - `_link` string: The URI of this contact. - `isPrimary` boolean: Is this the primary contact for this job? - `relationToPrimary` string: how is this contact related to the primary contact? - `contact` union: ContactLink object is included by default. Specify includes=contact in the request to include the full Contact object. - Contact - `id` string, uuid: The unique GUID identifying this contact. - `_link` string: The unique URI for this resource. - `firstName` string: First name of the contact. - `lastName` string: Last name of the contact. - `salutation` string: Salutation of the contact. - `crossReference` string: CrossReference of the contact. - `companyName` string: CompanyName of the contact. - `phoneNumbers` PhoneNumberLink[] - `id` string, uuid: The GUID of the Phone Number. - `_link` string: The URI of the Phone Number. - `emailAddresses` EmailAddressLink[] - `id` string, uuid: The GUID of the Email Address. - `_link` string: The URI of the Email Address - `mailingAddress` Address - `street1` string - `street2` string - `city` string - `state` State - `id` integer: The id for the state. - `name` string: The name of the State. - `abbreviation` string: The 2 character abbreviation for the State. - `_link` string: The URI of the State. - `zipCode` string - `country` Country - `id` integer: The id for the Country. - `name` string: The name of the Country. - `abbreviation` string: The 2 character abbreviation for the Country. - `_link` string: The URI of the Country. - `billingAddress` Address - `street1` string - `street2` string - `city` string - `state` State - `id` integer: The id for the state. - `name` string: The name of the State. - `abbreviation` string: The 2 character abbreviation for the State. - `_link` string: The URI of the State. - `zipCode` string - `country` Country - `id` integer: The id for the Country. - `name` string: The name of the Country. - `abbreviation` string: The 2 character abbreviation for the Country. - `_link` string: The URI of the Country. - `createdDate` string, date-time, nullable: Date the contact was created, in ISO 8601 format. Null when unavailable. - `modifiedDate` string, date-time, nullable: Date the contact was last modified, in ISO 8601 format. Null when unavailable. - ContactLink - `id` string, uuid: The unique GUID identifying this contact. - `_link` string: The unique URI for this resource. - `locationAddress` Address - `street1` string - `street2` string - `city` string - `state` State - `id` integer: The id for the state. - `name` string: The name of the State. - `abbreviation` string: The 2 character abbreviation for the State. - `_link` string: The URI of the State. - `zipCode` string - `country` Country - `id` integer: The id for the Country. - `name` string: The name of the Country. - `abbreviation` string: The 2 character abbreviation for the Country. - `_link` string: The URI of the Country. - `geoLocation` GeoLocation - `latitude` number: latitude component of the map location - `longitude` number: longitude component of the map location - `tradeTypes` TradeType[]: The trade types assigned to this job. - `tradeId` string, uuid - `name` string: The name of the Trade. - `jobCategory` JobCategory - `id` integer: The category's unique identifier. - `name` string: The category's name. - `workType` WorkType - `id` integer: The Work Type unique identifier. - `_link` string: The URI of the Work Type. - `name` string: The name of the Work Type. - `systemDefault` boolean: Shows if the work type is a System Default item. - `leadSource` LeadSource - `id` string, uuid - `_link` string: The URI of the LeadSource. - `name` string - `children` LeadSourceChild[], nullable - `id` string, uuid - `name` string - `parentId` string, uuid - `_link` string: The URI of the LeadSource. - `initialAppointment` InitialAppointmentLink - `_link` string: The unique URI of the Initial Apppointment for the specified Job. - `leadDeadReason` string: The reason why the lead was marked as dead. - `milestoneDate` string, date-time: The date/time when the job entered its current milestone. - `createdDate` string, date-time: The date/time when this job was created. - `modifiedDate` string, 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. - `jobNumber` string: The human-readable reference number for this job. The format is configured in company settings. - `jobName` string: The full name for this job. - `priority` 'Normal' | 'High' | 'Urgent': The priority level assigned to this job. ## Other responses - `404`: The job specified by jobId was not found. ## Changes - **2026-11-03** `443924b00f43`: 5 breaking, 7 warning, 7 info - added `#/components/schemas/contact, #/components/schemas/contactLink` to the `allOf[subschema #2]/contacts/items/allOf[subschema #2]/contact` response property `oneOf` list for the response status `200` - the `allOf[subschema #2]/contacts/items/allOf[#/components/schemas/jobContactLink]/_link` response's property format changed from `uri` to no format for status `200` - the `allOf[subschema #2]/leadSource` response's property type changed from `object` to no type for status `200` - the `allOf[subschema #2]/locationAddress/state/_link` response's property format changed from `uri` to no format for status `200` - …15 more [Operation history](https://skmtc.dev/acculynx/apis/acculynx-api-v2/changes/jobs/:jobId/get.md) --- [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)