BIbigchange
JobGroups

Get a list of job group categories

Changed on

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

get/v1/jobGroups/categories

Request

  • Base URL
    https://api.bigchange.com
  • URL
    https://api.bigchange.com/v1/jobGroups/categories
  • Auth
    HTTP bearer

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

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": 12345,
      "name": "Reactive Maintenance",
      "isActive": true,
      "visibility": [
        "Job",
        "Group"
      ]
    }
  ],
  "pageNumber": 2,
  "pageSize": 100,
  "pageItemCount": 55
}

Changes