Skip to main content
GET
Document categories as a tree.

Headers

Range
string

Limiting and Pagination

Range-Unit
string
default:items

Limiting and Pagination

Prefer
enum<string>

Preference

Available options:
count=none

Query Parameters

id
string
parent_id
string
parent_name
string
code
string
name
string
requires_approval
string
requires_expiry
string
default_retention_policy_id
string
retention_policy
string
action_at_expiry
string
is_active
string
depth
string
documents
string
row_version
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

Response

OK

action_at_expiry
string<character varying>
Maximum string length: 20
code
string<character varying>
Maximum string length: 60
default_retention_policy_id
string<uuid>

Note: This is a Foreign Key to retention_policy_settings.id.

depth
integer<integer>
documents
integer<bigint>
id
string<uuid>

Note: This is a Primary Key.

is_active
boolean<boolean>
name
string<character varying>
Maximum string length: 200
parent_id
string<uuid>

Note: This is a Foreign Key to document_category_settings.id.

parent_name
string<character varying>
Maximum string length: 200
requires_approval
boolean<boolean>
requires_expiry
boolean<boolean>
retention_policy
string<character varying>
Maximum string length: 200
row_version
integer<bigint>