---
title: "Get Jobs"
method: GET
path: "/jobs"
tags: ["jobs"]
---

# Get Jobs

`GET /jobs`

Use this endpoint to get a listing of Jobs.

When startDate and endDate are specified, jobs returned will be filtered to the given date range (inclusive).

The date field to filter on is given with dateFilterType which defaults to CreatedDate.

Optionally use milestones to limit the jobs to those in the listed milestones.

Optionally use sortBy to sort jobs by either CreatedDate, MilestoneDate, or ModifiedDate. CreatedDate is the default.

Optionally use sortOrder to indicate newest to oldest (Descending) ordering or oldest to newest (Ascending) ordering. Ascending is the default.

The pageStartIndex parameter to start looking for records should not exceed 100000

**To Get Jobs:**

**Supported includes:** `contact`, `initialAppointment`.

Example: return the jobs (including initial appointment) that are prospects and were modified in April sorted most recent first (descending ModifiedDate).

*/jobs?pageSize=25&includes=initialAppointment&filterByDate=ModifiedDate&startDate=2021-04-01&endDate=2021-04-30&sortBy=ModifiedDate&sortOrder=Descending*


**To Get Unassigned Jobs:**

**Supported includes:** `contact`.

Example: return the unassigned jobs (including contacts) that were modified in March sorted most recent first (descending ModifiedDate)

*/jobs?assignment=unassigned&pageSize=25&includes=contacts&filterByDate=ModifiedDate&startDate=2025-03-01&endDate=2025-03-30&sortBy=ModifiedDate&sortOrder=Descending*

*jobs?assignment=unassigned&milestones=Lead&pageSize=25&includes=contacts&filterByDate=ModifiedDate&startDate=2025-03-01&endDate=2025-03-30*


Example: return the unassigned jobs (including contacts) that were marked as Dead

*/jobs?assignment=unassigned&milestones=Dead&pageSize=25&includes=contacts&filterByDate=ModifiedDate&startDate=2025-03-01&endDate=2025-03-30*

## Query parameters

- `pageSize` integer
- `recordStartIndex` integer
- `includes` string
- `startDate` string, date
- `endDate` string, date
- `dateFilterType` 'CreatedDate' | 'MilestoneDate' | 'ModifiedDate'
- `milestones` string
- `sortBy` 'CreatedDate' | 'MilestoneDate' | 'ModifiedDate'
- `sortOrder` 'Ascending' | 'Descending'
- `assignment` 'assigned' | 'unassigned'

## Response `200`

OK

- JobCollection — Base structure for all paginated collection responses. This provides consistent pagination metadata across all collection endpoints.
  - `count` integer — The total number of items available across all pages. Use this to calculate the total number of pages available.
  - `pageSize` integer — The number of items per page in this response. This reflects either your requested page size or the default value.
  - `pageStartIndex` integer — The starting index of this page of results. Use with pageSize to track your position in the overall result set.
  - `items` Job[]
    - `id` string, uuid — The job's unique ID.
    - `_link` string — The URI of this Job.
    - `contacts` JobContact[] — The contact's default properties can be included with optional include parameter.
      - `id` string, uuid
      - `_link` string, uri
      - `contact` Contact
        - `id` string, uuid
        - `_link` string, uri
        - `companyName` string — The company name of given contact.
        - `crossReference` string — The cross reference of given contact.
        - `firstName` string — The first name of given contact.
        - `lastName` string — The last name of given contact.
        - `salutation` string — The salutation of given contact.
      - `isPrimary` boolean — Indicates if the contact is the primary contact related to a given Lead/Job.
    - `locationAddress` Address
      - `city` string — Municipality name for the physical address
      - `country` Country
        - `id` integer — The id for the Country.
        - `_link` string — The URI of the Country.
        - `abbreviation` string — The 2 character abbreviation for the Country.
      - `state` State
        - `id` number — The id for the state.
        - `_link` string, uri — The URI of the State.
        - `abbreviation` string — The 2 character abbreviation for the State.
      - `street1` string — Primary street address line
      - `street2` string — Secondary street address line
      - `zipCode` string — Postal code for the address
    - `geoLocation` GeoLocation
      - `latitude` number — latitude component of the map location
      - `longitude` number — longitude component of the map location
    - `tradeTypes` TradeType[] — The list of trades assigned
      - `id` string, uuid — Unique identifier that represents the trade type
      - `name` string — Name of the specified trade type
    - `jobCategory` JobCategory
      - `id` integer
      - `name` string
    - `workType` WorkType
      - `id` integer
      - `name` string
      - `systemDefault` boolean
    - `leadSource` LeadSource
      - `id` string, uuid
      - `_link` string, uri — The unique URI of the lead source.
      - `name` string
    - `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/time when this job was last modified (touched).
    - `currentMilestone` 'Lead' | 'Prospect' | 'Approved' | 'Completed' | 'Invoiced' | 'Closed' | 'Cancelled' — This job's current milestone. This field is Read Only.
    - `jobNumber` string — The alphanumeric identifier for the job, as definied by the company settings.
    - `jobName` string — The full name for this job.
    - `priority` 'Normal' | 'High' | 'Urgent' — The job assigned priority

## Other responses

- `400` — Bad Request - The server cannot process the request due to a client error. Common causes: - Invalid request format - Missing required fields - Validation errors in the request data
- `401` — Unauthorized - Authentication is required or has failed. Common causes: - Missing API key - Invalid API key - Expired or deactivated API key
- `416` — Range Not Satisfiable - The requested page of results is not available. Common causes: - pageStartIndex is beyond the available data range - Invalid pagination parameters

---

[API](https://skmtc.net/acculynx/apis/acculynx-api-v2.md) · [All operations](https://skmtc.net/acculynx/apis/acculynx-api-v2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/acculynx/acculynx-api-v2/revisions/3a9e3886e400/schema)