---
title: "Retrieve categories"
method: GET
path: "/categories"
tags: ["Categories"]
---

# Retrieve categories

`GET /categories`

## Request

- Base URL: `https://sb2api.servicechannel.com/v3`
- URL: `https://sb2api.servicechannel.com/v3/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/categories/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns a list of available work order categories for one or several subscribers. Only a parent subscriber can get categories for child subscribers.
            <br />You can create a new category via the [POST /categories](/swagger/ui/index#/Categories/POSTv3_categories) method.

## Query parameters

- `subscriberIds` integer[]

## Response `200`

The requested list of categories 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`: The request is not accepted due to bad syntax, missing parameters, insufficient data, etc. <br/>Error codes: 401 — Invalid subscriber ID
- `401`: The request is not authorized. <br/>Error codes: 504 — API call rejected by security permissions
- `403`: You are not authorized to request this resource, or the resource is unavailable for some reason. <br/>Error codes: 100 — User has no rights to perform this action
- `500`: The server was unable to complete the request due to an internal error.

---

[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)
