Get list of groups
GET
https://example.kaiten.ru/api/latest/company/groupsGet groups list filtered by query params. The result of the request is displayed page by page if limit or offset presented and with_tree_entities is false (see details in the constraints of the parameters).
| Name | Type | Constraints | Description |
|---|---|---|---|
| with_tree_entities | boolean | Add tree entities for each group | |
| with_users_count | boolean | Add users count for each group | |
| with_sync_group_attribute | boolean | Add sync attribute for each group | |
| condition | enum | 1 - active, 2 - inactive | |
| query | string | Search query | |
| limit | integer | Default: 100 | Maximum amount of records |
| offset | integer | Number of records to skip |
Responses
| Description | Response type | Example |
|---|---|---|
| Success | Array of objects |
| Name | Type | Description |
|---|---|---|
| name | string | Group name |
| permissions | integer | Group permissions |
| updated | string | Last update timestamp |
| created | string | Create date |
| id | integer | Group id |
| uid | string | Group uid |
| add_to_cards_and_spaces_enabled | boolean | Ability to add all users of the group to cards, placed in group spaces. Ability to filter logs by group in «Timesheets» |
| Description | Response type | Example |
|---|---|---|
| Invalid token | String |
A schema has not been defined for this response code.
| Description | Response type | Example |
|---|---|---|
| Forbiden | Response body does not exist |
A schema has not been defined for this response code.
| Description | Response type | Example |
|---|---|---|
| Not found | 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/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!