Skip to navigation
Developer ReferenceAPI ReferenceStyle AgentTerminology

List Categories

List categories, optionally only those of one type.

Without category_type_id every category in the organization is returned and parent_id / root_only are ignored. List the category types first to find the type of languages, statuses or domains.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

category_type_idstring or nullOptionalformat: "uuid"
Filter by category type
parent_idstring or nullOptionalformat: "uuid"
Filter by parent
root_onlybooleanOptionalDefaults to false
Only categories without a parent

Response

Successful Response
idstringformat: "uuid"
Identifier used by this API.
typestringformat: "uuid"
Category type ID
namestring

Name, unique within the type; for languages, the language code such as en.

displaynamestring
issystemboolean
uuidstring
Stable identifier carried over from Acrolinx terminology.
external_idstring
parentstring or nullOptionalformat: "uuid"
priorityinteger or nullOptional

Errors

401
Unauthorized Error
403
Forbidden Error
422
Unprocessable Entity Error
500
Internal Server Error