- Omni
- Document APIs
- Storage
- Category
- Document
- Sharing
List Category
Developing
preprod
preprod
GET
/categories/
Last modified:2025-03-16 08:15:11
Request
Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.Example:
Authorization: Bearer ********************Query Params
page_size
number
optional
Default:
15
page
number
optional
Default:
1
Request samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/categories/?page_size&page'Responses
🟢200Success
application/json
Body
count
integer
required
total_pages
integer
required
current_page
integer
required
has_previous
boolean
required
has_next
boolean
required
previous_page
integer | null
optional
next_page
integer | null
optional
results
array[object (Category) {9}]
required
id
string
required
Match pattern:
^[a-zA-Z0-9._-]{8,40}$
tenant_id
string
required
Match pattern:
^[a-zA-Z0-9._-]{8,40}$
created_by
string <uuid>
required
updated_by
string <uuid>
required
created_at
string <date-time>
required
updated_at
string <date-time>
required
name
string
required
<= 100 characters
description
string
optional
<= 255 characters
parent
string | null
optional
Example
{
"count": 3,
"total_pages": 3,
"current_page": 2,
"has_previous": true,
"has_next": true,
"previous_page": 1,
"next_page": 3,
"results": [
{
"id": "01JPEZ0PYHEM884BWRRHPBR7HG",
"tenant_id": "59ecf94e-054d-43ee-83db-b158ab9d7f67",
"created_by": "cffe818a-5003-4116-9104-069f7e062bb4",
"updated_by": "",
"created_at": "2025-03-16T13:22:09.944094Z",
"updated_at": "2025-03-16T13:22:09.944219Z",
"name": "KYC2",
"description": "All KYC Documents",
"parent": "None"
}
]
}