Sign in
latestOpenAPI 3.0.12026-08-192092911.2 MB

916e669fc527

JobGroups

Get a list of job group categories

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

get/v1/jobGroups/categories

Query parameters

namestring
Example:Maintenance

Filter to job categories whose name contains this value. Case-insensitive, partial match

isActiveboolean
Example:true

Filter to active or inactive job categories only. Omit to return both

pageNumberinteger
Example:1

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

pageSizeinteger
Example:100

The page size being requested. Default is 100, maximum is 1000 (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": 12345,
      "name": "Reactive Maintenance",
      "isActive": true,
      "visibility": [
        "Job",
        "Group"
      ]
    }
  ],
  "pageNumber": 2,
  "pageSize": 100,
  "pageItemCount": 55
}