---
title: "Get a list of job groups"
method: GET
path: "/v1/jobGroups"
tags: ["JobGroups"]
---

# Get a list of job groups

`GET /v1/jobGroups`

Retrieve a paged collection of job groups (required scope jobs:read)

## Query parameters

- `sortBy` 'createdAt' — Represents the fields that can be used to sort job groups<p>Possible values:</p><ul><li><b>createdAt</b>: Sort by created at date</li></ul>
- `direction` 'ascending' | 'descending' — Represents the direction in which sorting should be applied<p>Possible values:</p><ul><li><b>ascending</b>: Indicates ascending sorting order</li><li><b>descending</b>: Indicates descending sorting order</li></ul>
- `id` integer[]
- `pageNumber` integer
- `pageSize` integer

## Headers

- `Customer-Id` integer, required

## Response `200`

OK

- PagedResponseReadJobGroupModel — A paged collection of items
  - `items` ReadJobGroupModel[] — The items returned for the requested page
    - `id` integer — The unique identifier of the job group
    - `reference` string — The internal reference of a job group - should usually be unique
    - `contactId` integer — The unique identifier of the contact the job group is for
    - `contactName` string, nullable — The name of the contact the job group is for
    - `contactAddress` string, nullable — The postal address of the contact the job group is for
    - `contactLocation` Location — Represents a geographical location
      - `latitude` number, double, required — Latitude of the center of the location
      - `longitude` number, double, required — Longitude of the center of the location
    - `personId` string, uuid, nullable — The unique uuid identifier of the person who will serve as primary point of contact for the job
    - `personName` string, nullable — The name of the person who will serve as primary point of contact for the job
    - `title` string — The title of the job group
    - `isShownOnDevice` boolean — Indicates whether the job group is shown on the device
    - `areJobsLinked` boolean — Indicates whether the jobs in the group are linked
    - `createdAt` string, date-time — The UTC timestamp for when the job group was created
    - `orderNumber` string, nullable — The order number associated with the job group
    - `plannedStartOption` 'onSetDate' | 'dateOfFirstJob' — Represents the options for setting the planned start date of a job group<p>Possible values:</p><ul><li><b>onSetDate</b>: On a specific date</li><li><b>dateOfFirstJob</b>: The date of the first job in the job group</li></ul>
    - `plannedStartAt` string, date-time, nullable — The UTC Timestamp for when the job group is planned to start. Only set if the BigChange.BO.RestApi.Application.JobGroups.Models.ReadJobGroupModel.PlannedStartOption is BigChange.BO.RestApi.Application.JobGroups.Enumerations.JobGroupPlannedStartOptions.OnSetDate
    - `plannedEndOption` 'onSetDate' | 'dateOfLastJob' — Represents the options for setting the planned end date of a job group<p>Possible values:</p><ul><li><b>onSetDate</b>: On a specific date</li><li><b>dateOfLastJob</b>: The date of the last job in the job group</li></ul>
    - `plannedEndAt` string, date-time, nullable — The UTC timestamp for when the job group should be ended. Only set if the BigChange.BO.RestApi.Application.JobGroups.Models.ReadJobGroupModel.PlannedEndOption is BigChange.BO.RestApi.Application.JobGroups.Enumerations.JobGroupPlannedEndOptions.OnSetDate
    - `status` 'unscheduled' | 'partScheduled' | 'scheduled' | 'inProgress' | 'completed' | 'financiallyCompleted' — Represents the status of a job group<p>Possible values:</p><ul><li><b>unscheduled</b>: Job group is unscheduled</li><li><b>partScheduled</b>: Part of the job group is scheduled</li><li><b>scheduled</b>: Job group is scheduled</li><li><b>inProgress</b>: Job group is in progress</li><li><b>completed</b>: Job group is completed</li><li><b>financiallyCompleted</b>: Job group is financially completed</li></ul>
    - `categoryId` integer, nullable — The unique identifier of the category that the job group is assigned to
    - `categoryName` string, nullable — The name of the category that the job group is assigned to
    - `contractId` integer, nullable — The unique identifier of the contract that the job group is associated with
    - `linkedJobsResourceName` string, nullable — The name of the resource associated with the job group. Should only be set when BigChange.BO.RestApi.Application.JobGroups.Models.ReadJobGroupModel.AreJobsLinked is `true`
    - `linkedJobsResourceId` integer, nullable — The unique identifier of the resource who will be actioning the job group. Should only be set when BigChange.BO.RestApi.Application.JobGroups.Models.ReadJobGroupModel.AreJobsLinked is `true`
    - `linkedJobsVehicleRegistration` string, nullable — The registration number of the vehicle associated with the job group. Should only be set when BigChange.BO.RestApi.Application.JobGroups.Models.ReadJobGroupModel.AreJobsLinked is `true`
    - `linkedJobsVehicleId` integer, nullable — The unique identifier of the vehicle associated with the job group. Should only be set when BigChange.BO.RestApi.Application.JobGroups.Models.ReadJobGroupModel.AreJobsLinked is `true`
    - `linkedJobsStartAt` string, date-time, nullable — The UTC timestamp for when the job group is started. Should only be set when BigChange.BO.RestApi.Application.JobGroups.Models.ReadJobGroupModel.AreJobsLinked is `true`
    - `ownerId` integer, nullable — The unique identifier of the user who owns the job group
  - `pageNumber` integer — The page number of the response where 1 is the first page
  - `pageSize` integer — The number of items requested for the current page
  - `pageItemCount` integer — The number of items returned in the current page

## Other responses

- `400` — Bad Request
- `403` — Forbidden
- `500` — Internal Server Error

---

[API](https://skmtc.net/bigchange/apis/bigchange-dx.md) · [All operations](https://skmtc.net/bigchange/apis/bigchange-dx/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/bigchange/bigchange-dx/revisions/916e669fc527/schema)