Retrieve list of document groups
GET
https://example.kaiten.ru/api/latest/document-groupsGet Document group list filtered by query parameters. If version is omitted or set to 1, see the version=1 / default response. If version=2, see the version=2 response.
| Name | Type | Constraints | Description |
|---|---|---|---|
| query | string | Search query string | |
| offset | integer | Number of records to skip for pagination. Default: 0 | |
| limit | integer | Maximum number of records to return. Default: 100 | |
| version | integer | Search version. Default: 1. Use version=2 to search via OpenSearch and enable the new response format with result and position fields | |
| condition | integer | Filter condition. Used with version=2 | |
| start_position | string | Search cursor for version=2 pagination. Pass the position value from the previous version=2 response | |
| role | integer | Filter by minimum user role. 1 — reader, 2 — writer, 3 — admin |
Responses
| Description | Response type | Example |
|---|---|---|
| Returned when version is omitted or set to 1 | Array of objects |
| Name | Type | Description |
|---|---|---|
| uid | string | Document group uid |
| id | integer | Document group id |
| title | string | Document group title |
| created | string | Create date |
| updated | string | Last update timestamp |
| archived | boolean | Document group archived flag |
| company_id | integer | Company id |
| author_id | integer | Author user id |
| parent_entity_uid | null | string | Parent tree entity uid |
parent_group_idDeprecated: use parent_entity_uid instead | null | string | Deprecated alias for parent_entity_uid |
| entity_type | string | Entity type. Always "document_group" |
| sort_order | number | Document group sort order |
| access | enum | Document group access type |
| for_everyone_access_role_id | null | string | Role id for everyone access |
| hostname | null | string | Custom hostname for public site |
| redirect_url | null | string | Redirect URL |
| key | null | string | Unique document group key within company |
| icon_type | null | string | Icon type. "material_icon" or null |
| icon_value | null | string | Icon value |
| icon_color | null | integer | Icon color |
| public | boolean | Is document group publicly available (legacy field) |
| news_feed | boolean | Is document group marked as news feed |
| hidden_on_public_site | boolean | Document group is hidden on public site |
| path | string | Inner path to entity in tree |
| index_document_uid | null | string | UID of the document used as the home page for this folder |
| Description | Response type | Example |
|---|---|---|
| Invalid token | String |
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.ru
1 curl --request GET \
2 --url 'https://example.kaiten.ru/api/latest/document-groups' \
3 --header 'Accept: application/json' \
4 --header 'Content-Type: application/json'
5 Response
ClickTry It!to start a request and see the response here!