Retrieve list of users
Get users list filtered by query parameters. The main difference between this route and https://developers.kaiten.ru/company-users/get-list-of-users is that it does not require access to the members admin section, and if there is no access, it returns only users from shared spaces. The result of the request is displayed page by page (see details in the constraints of the parameters).
⚠️ Starting mid-July, the /api/users endpoint will return a maximum of 100 users per request. Please update your implementation to support pagination.
| Name | Type | Constraints | Description |
|---|---|---|---|
| type | string | Type of users to return | |
| query | string | Search query | |
| access_type_permissions | string | Use member to exclude guests before pagination for all, domain and shared types. For shared, member returns only users with paid access, even when include_inactive is true. The guest value applies to all and domain types. | |
| ids | string | Array of user ids separated by commas | |
| limit | integer | Default: 100 Max: 100 | Limit the number of users returned |
| offset | integer | Offset the number of users returned | |
| include_inactive | boolean | Include inactive users | |
| exclude_members_by_entity_uid | string | Exclude members of the specified entity in the current company, including direct, group and inherited membership, before pagination. Access for everyone alone does not count as membership. Applies to all, domain and shared types. | |
| exclude_directly_added_members_by_entity_uid | string | Exclude users directly invited to entity |
Responses
| Description | Response type | Example |
|---|---|---|
| Success | Array of objects |
| Name | Type | Description |
|---|---|---|
| id | integer | User id |
| full_name | string | User full name |
string | User email | |
| username | string | Username for mentions and login |
| avatar_initials_url | string | Default user avatar |
| avatar_uploaded_url | null | string | User uploaded avatar url |
| initials | string | User initials |
| avatar_type | enum | 1 – gravatar, 2 – initials, 3 - uploaded |
| lng | string | Language |
| timezone | string | Time zone |
| theme | string | light - light color theme, dark - dark color theme, auto - color theme based on OS settings |
| updated | string | Last update timestamp |
| created | string | Create date |
| activated | boolean | User activated flag |
| ui_version | integer | 1 - old ui. 2 - new ui |
| company_id | integer | Company id |
| user_id | integer | User id |
| default_space_id | null | integer | Default space |
| permissions | integer | User company permissions |
| role | enum | User role in company: 1 - owner, 2 - user, 3 - deactivated |
| email_frequency | enum | 1 - never, 2 – instantly |
| email_settings | object | Email settings |
| slack_id | null || integer | User slack id |
| slack_settings | null || object | Slack settings |
| notification_settings | null || object | Notification settings |
| notification_enabled_channels | array | List of enabled channels for notifications |
| slack_private_channel_id | null | integer | User slack private channel id |
| telegram_sd_bot_enabled | boolean | Telegram bot enable flag |
| invite_last_sent_at | string | Last invite date |
| apps_permissions | string | 0 - no access, 1 - full access to Kaiten, access to service desk denied. 2 - guest access to Kaiten, access to service desk denied. 4 - access only to service desk. 5 - full access to Kaiten and service desk. 6 - guest access to Kaiten, access to service desk |
| external | boolean | Is user external |
| last_request_date | null | string | Date of last request |
| last_request_method | null | string | Type of last request |
| include_inactive | boolean | Includes in the list of deactivated users |
| Description | Response type | Example |
|---|---|---|
| Validation error | Object |
| Name | Type | Description |
|---|---|---|
| message | string | Error message |
| Description | Response type | Example |
|---|---|---|
| Invalid token | String |
| Description | Response type | Example |
|---|---|---|
| Forbiden | Response body does not exist |
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/users' \
3 --header 'Accept: application/json' \
4 --header 'Content-Type: application/json'
5 Response
ClickTry It!to start a request and see the response here!