​
Get list of custom directories
GET
https://example.kaiten.ru/api/latest/company/custom-directoriesReturns directories list. Use query parameters to include related fields, author and records_count.
| Name | Value |
|---|---|
| Content-Type | application/json |
| Name | Type | Constraints | Description |
|---|---|---|---|
| include_fields | boolean | Include directory fields | |
| include_author | boolean | Include author user object | |
| include_records_count | boolean | Include records_count in each directory | |
| limit | number | Default: 200 Max: 200 | Maximum number of directories in response |
| offset | number | Number of records to skip | |
| query | string | Search by directory name (case-insensitive) | |
| conditions | array of strings | Filter by condition values: active | inactive | removed |
Responses
| Description | Response type | Example |
|---|---|---|
| Success | Array of objects |
| Name | Type | Description |
|---|---|---|
| id | string | Directory ID (UUID) |
| name | string | Directory name |
| description | null | string | Directory description |
| condition | enum | Directory condition: active | inactive | removed |
| settings | object | Directory settings |
| records_count | integer | Records count (only when include_records_count=true) |
| fields | array of objects | Directory fields (only when include_fields=true) |
| author | object | Author user object (only when include_author=true) |
| Description | Response type | Example |
|---|---|---|
| Invalid token | String |
A schema has not been defined for this response code.
| Description | Response type | Example |
|---|---|---|
| Forbidden | Response body does not exist |
A schema has not been defined for this response code.
Kaiten
If you have any questions or need help with integration feel free to write us at support@kaiten.io
1 curl --request GET \
2 --url 'https://example.kaiten.ru/api/latest/company/custom-directories' \
3 --header 'Accept: application/json' \
4 --header 'Content-Type: application/json'
5 Response
ClickTry It!to start a request and see the response here!