|
Http Verb |
GET |
|---|---|
|
Url |
/documents/r1/categories |
|
Permissions required |
|
|
Personally Identifiable Information (PII) |
No |
|
Sensitive Information |
No |
|
Last Modified Version |
r1 |
|
Released since |
2025 W2 (FSM 20.0) |
|
Deprecated since |
|
|
Removed since |
|
|
Tech Tags |
PAGINATION ORDERING-SERVER-SIDE MULTILANGUAGE-FIELDS |
Business Logic
This API returns a list of document categories filtered by the input criteria.
Query String Parameters
Filter ℹ️
|
Field |
Validations |
Note |
|---|---|---|
|
id |
|
Collection of ids |
|
description |
Max length: 80 |
Multi Language |
|
active |
|
|
|
mobileSynchronizationMode |
|
Values:
|
|
entityTypeId |
|
Collection of ids |
|
externalCode |
Max length: 10 |
|
Order ℹ️
Default Order
id (ASC)
Page ℹ️
Default.
Fields ℹ️
Default.
Header Parameters
Default.
Response documentation
Response payload fields
|
Field |
Note |
|---|---|
|
id |
|
|
description |
|
|
active |
|
|
mobileSynchronizationMode |
|
|
entityTypeId |
|
|
externalCode |
|