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

# GET /jobs

`GET /jobs`

Returns a list of jobs. The list can be filtered by job type.

## Query parameters

- `pageSize` integer
- `sortOrder` union
  - 'asc'
  - 'desc'
- `pageCursor` string
- `filterJobNo` string
- `filterJobStatus` union
  - 'Active'
  - 'Completed'
  - 'Estimate Rejected'
  - 'Estimate Sent'
  - 'Inactive'
  - 'Quote Sent'
  - 'Quote Rejected'
  - 'To Price'
- `filterJobType` union
  - 'Quote'
  - 'Estimate'
  - 'Charge Up'
- `filterCustomerId` number
- `filterSiteId` number
- `sortField` union
  - 'jobNo'
  - 'createdAt'
  - 'lastModified'
- `filterShowOnHold` boolean
- `filterShowArchived` boolean
- `filterSearchText` string

## Response `200`

Successful Response

- JobsResponse
  - `result` string, required
  - `data` Job[], required
    - `id` number, required
    - `jobNo` string, nullable, required
    - `jobNumber` string, nullable, required
    - `description` string, nullable, required
    - `longDescription` string, nullable, required
    - `createdAt` string, date-time, required
    - `lastModified` string, date-time, nullable, required
    - `jobType` string, required
    - `status` string, required
    - `assignedGroups` string[], required — Default group assigned to a job for easy tracking. This gets assigned automatically by default on new job phases.
    - `customer` JobCustomer, required
      - `id` number, required
      - `customerFullName` string, nullable, required
    - `siteAddress` JobSiteAddress, required
      - `id` number, required
      - `name` string, nullable, required
      - `firstName` string, nullable, required
      - `lastName` string, nullable, required
      - `address1` string, nullable, required
      - `address2` string, nullable, required
      - `addressSuburb` string, nullable, required
      - `addressCity` string, nullable, required
      - `addressRegion` string, nullable, required
      - `addressCountry` string, nullable, required
      - `addressPostcode` string, nullable, required
    - `mainContact` object, nullable, required
      - `id` number, required
      - `firstName` string, nullable, required
      - `lastName` string, nullable, required
      - `contactItems` ContactItem[], nullable, required
        - `id` number, required
        - `contactType` 'email' | 'phone' | 'mobile' | 'other' | 'fax' | 'website', required — The type of this contact item. It can be one of the following: email, phone, mobile, other, fax, website
        - `contactValue` string, required — The value of this contact item.
    - `activeQuote` object, nullable, required
      - `id` number, required
      - `versionNumber` number, required
      - `guid` string, nullable, required
      - `title` string, nullable, required
      - `description` string, nullable, required
      - `quoteDate` string, date-time, nullable, required
      - `isSent` boolean, required
      - `isAccepted` boolean, required
      - `isSuperseded` boolean, required
      - `isLocked` boolean, required
      - `voidedAt` string, date-time, nullable, required
      - `declinedAt` string, date-time, nullable, required
      - `createdAt` string, date-time, required
      - `lastModified` string, date-time, required
      - `publishedAt` string, date-time, nullable, required
      - `dueDate` string, date-time, nullable, required
      - `dueDays` string, nullable, required
      - `isDraft` boolean, required
      - `total` number, nullable
    - `onHold` boolean, required
    - `archived` boolean, required
    - `customerReference` string, nullable, required
    - `parentJobId` number, nullable, required — The id of the parent job when this job is a variant, otherwise null.
    - `jobVariants` number[], nullable, required — The ids of the variant (child) jobs when this job is a parent job, otherwise null.
    - `links` Links[], required
      - `href` string, required
      - `rel` string, required
      - `type` 'GET' | 'POST' | 'PUT' | 'PATCH', required
  - `paging` Pagination
    - `perPage` number, required
    - `pageCount` number, required
    - `links` object, required
      - `self` string, required
      - `previous` string, nullable, required
      - `next` string, nullable, required

## Other responses

- `4XX` — Client Request Errors
- `5XX` — Server Errors

---

[API](https://skmtc.dev/fergus/apis/fergus-api.md) · [All operations](https://skmtc.dev/fergus/apis/fergus-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/fergus/fergus-api/revisions/b4f232a22363/schema)