---
title: "Categories Collection"
method: GET
path: "/workorders/categories"
tags: ["WorkOrders"]
---

# Categories Collection

`GET /workorders/categories`

## Request

- Base URL: `https://sb2api.servicechannel.com/v3`
- URL: `https://sb2api.servicechannel.com/v3/workorders/categories`
- Auth: OAuth 2
  - Authorization code: `https://sb2login.servicechannel.com/oauth/authorize`
  - Token URL: `https://sb2login.servicechannel.com/oauth/token`
- TypeScript: <https://skmtc.dev/servicechannel/apis/servicechannel-api-v-3/docs/workorders/categories/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieves list of all Work order categories.

## Query parameters

- `subscriberId` integer
- `sortExpr` string

## Response `200`

Indicates that the request succeeded and that the requested information is in the response.

- ServiceChannelServicesMessagingCategoryCategoryResponse[]
  - `Id` integer: Category ID.
  - `SubscriberId` integer: Unique numeric subscriber ID.
  - `Name` string: Category name.
  - `HasDependency` boolean: Parameter is not populated. The only value is "false".
  - `PrimaryCategoryID` integer: Primary category ID.
  - `PrimaryCategoryName` string: Primary category name.

## Other responses

- `400`: Bad Request - the request could not be understood or was missing required parameters. <br/>Error codes: <br/> 503 - Request data is empty; <br/>SubscriberId is incorrect;
- `401`: Indicates that the requested resource requires authentication. <br/>Error codes: <br/> 504 - API call rejected by security permissions;

---

[API](https://skmtc.dev/servicechannel/apis/servicechannel-api-v-3.md) - [All operations](https://skmtc.dev/servicechannel/apis/servicechannel-api-v-3/llms.txt) - [OpenAPI document](https://skmtc.dev/servicechannel/apis/servicechannel-api-v-3/revisions/d490d6596809?raw)