Sign in
latestOpenAPI 3.0.12026-08-192092911.2 MB

916e669fc527

JobGroups

Get a list of job groups

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

get/v1/jobGroups

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>

Example:createdAt

The field to sort items in the page by

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>

Example:ascending

The direction to apply the sort

idinteger[]

Only return job groups where Id matches the value(s) provided (Max items: 50)

pageNumberinteger

The page number being requested (minimum: 1, maximum: 2147483)

pageSizeinteger

The page size being requested (minimum: 1, maximum: 1000)

Headers

Customer-Idinteger required

The customer identifier

Response

OK

pageNumberinteger

The page number of the response where 1 is the first page

pageSizeinteger

The number of items requested for the current page

pageItemCountinteger

The number of items returned in the current page

Example response

{
  "items": [
    {
      "id": 123456789,
      "reference": "ABC/12345",
      "contactId": 12345678,
      "contactName": "John Doe",
      "contactAddress": "3150 Century Way, Leeds LS15 6HU",
      "contactLocation": {
        "latitude": 51.31349,
        "longitude": -0.7464233
      },
      "personId": "123e4567-e89b-12d3-a456-426614174000",
      "personName": "Peter Brown",
      "title": "My Group Job",
      "areJobsLinked": true,
      "createdAt": "2025-01-24T12:00:00.0000000+00:00",
      "orderNumber": "ORD123456",
      "plannedStartOption": "onSetDate",
      "plannedStartAt": "2025-01-01T09:00:00.0000000+00:00",
      "plannedEndOption": "onSetDate",
      "plannedEndAt": "2025-01-01T09:00:00.0000000+00:00",
      "status": "unscheduled",
      "categoryId": 123456,
      "categoryName": "Global Solutions Ltd",
      "contractId": 123456,
      "linkedJobsResourceName": "John Doe",
      "linkedJobsResourceId": 1234567,
      "linkedJobsVehicleRegistration": "AB12 CDE",
      "linkedJobsVehicleId": 123456,
      "linkedJobsStartAt": "2025-01-01T09:00:00.0000000+00:00",
      "ownerId": 12345
    }
  ],
  "pageNumber": 2,
  "pageSize": 100,
  "pageItemCount": 55
}