API reference · Ticket Categories
GET/api/v1/categories/ticket

List ticket categories

Returns paginated ticket categories. Requires ticket_settings:read permission.

RBAC · ticket_settings

Query parameters

pagestringOptional
limitstringOptional
sortstringOptional
orderstringOptional
searchstringOptional
created_fromstring <date-time>Optional
created_tostring <date-time>Optional
updated_fromstring <date-time>Optional
updated_tostring <date-time>Optional
category_namestringOptional
board_idstring <uuid>Optional
parent_categorystring <uuid>Optional
is_parentstringOptional
is_childstringOptional
depthstringOptional
activestringOptional
offsetstringOptional
sort_bystringOptional
sort_orderstringOptional
include_hierarchystringOptional
category_typestringOptional

Response body

Success response 200 · schema PaginatedTicketCategoryResponse

dataarray of TicketCategoryRequired
itemsobject
Ticket category resource from ticket_categories, including optional hierarchy fields.
category_idstring <uuid>Required
category_namestringRequired
parent_categorystring <uuid>Nullable
board_idstring <uuid>Required
descriptionstringNullable
created_bystring <uuid>Required
updated_bystring <uuid>Required
created_atstring <date-time>
updated_atstring <date-time>
tenantstring <uuid>Required
childrenarray of any
itemsany
depthnumber
pathstring
children_countnumber
paginationobjectRequired
pageintegerRequired
limitintegerRequired
totalintegerRequired
totalPagesintegerRequired
hasNextbooleanRequired
hasPrevbooleanRequired
metaobject

Response codes

200
Ticket categories returned successfully.
400
Invalid query parameters.
401
Authentication failed.
403
Authenticated user lacks ticket settings read permission.