JobTypes

Retrieve a list of Job Types

Changed on

Retrieves a paginated list of Job Types.

get/v2/jobtypes

Request

Query parameters

pageSizenumber
Example:10

Number of records to return per page.

pagenumber
Example:1

The page index.

disabledboolean

Filter by disabled state. When true, returns only disabled job types; when false, returns only enabled job types.

Headers

Authorizationstring required
Example:Bearer <token>

Bearer Token

Response

A paginated list of Job Types.

pageSizenumber

The maximum number of items returned per page.

pagenumber

The current page number.

totalResultsnumber

The total number of results.

hasMoreboolean

Whether there are more results.

Example response

{
  "pageSize": 10,
  "page": 1,
  "totalResults": 50,
  "hasMore": true,
  "data": [
    {
      "id": "JT-8718036049ec4c4d",
      "name": "Cleaning",
      "avgDuration": 60,
      "displayOrder": 1
    }
  ]
}

Changes

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the new optional query request parameter disabled

    • info

      added the non-success response with the status