---
title: "Get a list of job types"
method: GET
path: "/v1/jobTypes"
tags: ["JobTypes"]
---

# Get a list of job types

`GET /v1/jobTypes`

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

## Query parameters

- `sortBy` 'name' — Represents the fields that can be used to sort job types<p>Possible values:</p><ul><li><b>name</b>: The name of the job type</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[]
- `isTasksEnabled` boolean
- `pageNumber` integer
- `pageSize` integer

## Headers

- `Customer-Id` integer, required

## Response `200`

OK

- PagedResponseReadJobTypeModel — A paged collection of items
  - `items` ReadJobTypeModel[] — The items returned for the requested page
    - `id` integer — The unique identifier of the job type
    - `name` string — The name of the job type
    - `description` string — The default textual description for jobs of this type
    - `plannedDuration` integer — The default planned duration for jobs of this type, specified in minutes
    - `categoryId` integer, nullable — The unique identifier of default category for jobs of this type
    - `isArchived` boolean — A flag determining if a type is archived - new jobs cannot be created against archived job types
    - `isOrderNumberRequired` boolean — A flag determining if an order number is required for jobs of this type
    - `isTasksEnabled` boolean — A flag determining if tasks are used for this job type
    - `positiveResults` string[], nullable — The result options for when a job is completed successfully
    - `negativeResults` string[], nullable — The result options for when a job is completed with issues. If null then jobs of this type will not be allowed to have the status of completedWithIssues
    - `customFieldDefinitions` CustomFieldDefinitionReadModel[] — The custom field definitions associated with this job type
      - `id` integer — The unique identifier of the custom field definition
      - `caption` string — The caption of a custom field
      - `type` 'boolean' | 'integer' | 'decimal' | 'text' | 'list' | 'statement' | 'date' | 'note' | 'time' | 'systemList' — The type of the custom field. New field types may be added in the future, so integrations should be resilient to this<p>Possible values:</p><ul><li><b>boolean</b>: Indicates a boolean field <i>(Example: "false")</i></li><li><b>integer</b>: Indicates an integer numeric field <i>(Example: "1001")</i></li><li><b>decimal</b>: Indicates a floating point numeric field <i>(Example: "1.42")</i></li><li><b>text</b>: Indicates an editable text field <i>(Example: "Purple")</i></li><li><b>list</b>: Indicates a field with a single value from a predefined list of options <i>(Example: "Purple")</i></li><li><b>statement</b>: Indicates a text field that cannot be edited. The value is always equal to the default value <i>(Example: "By signing this you agree to the following...")</i></li><li><b>date</b>: Indicates a date field, which will be represented as an RFC3339 formatted date string. The default value is not supported for this type and will always be null <i>(Example: "2024-01-31")</i></li><li><b>note</b>: Indicates a multiline, editable text field. Lines are seperated with a line feed character <i>(Example: "This is a note.")</i></li><li><b>time</b>: Indicates a time field, formatted as HH:mm. The default value is not supported for this type and will always be null <i>(Example: "10:30")</i></li><li><b>systemList</b>: Indicates the ID of a related resource, vehicle or web user <i>(Example: "228007")</i></li></ul>
      - `listOptions` string[], nullable — Shows the possible values for a list type custom field. Value will be null if type is not list
      - `isRequired` boolean — Indicates if the field is required in the UI. This is NOT enforced in the API
      - `isEditable` boolean — Indicates if the field is editable
      - `default` string, nullable — The default value of a custom field. Formatted in accordance with the rules of the field type
  - `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)