GET [ document-categories ]
Production Endpoint: https://app.complyflow.com.au/app/public/index.php/api/acu/document-categories
Test Endpoint: https://test.complyflow.com.au/app/public/index.php/api/acu/document-categories
Overview
This endpoint returns the list of document categories in current Organisation in the ComplyFlow system.
Authentication instructions
Refer to the Authentication method for Authentication Methods (for Login and Logout).
Permissions Required
The user should pass both below permissions:
API User
User is Staff
Please also refer to the Permissions Overview guide.
Query parameters
FIELD | TYPE | DESCRIPTION | Example | REQUIRED | DEFAULT | PATTERN |
- | - | - | - | - | - | - |
Request Example
curl --location 'http://test.complyflow.com.au/app/public/index.php/api/acu/document-categories' \
--header 'Authorization: [...]' \
--header 'Cookie: [...]'
Response Example
The API Request returns list of document categories in current organisation.
{
"token": "",
"data": [
{
"id": 189,
"name": "aaa",
"qual_num": "custom"
},
{
"id": 163,
"name": "DocA"
}
]
}
qual_num field only available if Custom Field on Document Category Configuration already filled