Get list of users
GET
https://example.kaiten.ru/api/latest/company/usersGet Company Users list filtered by query parameters. To use this route you need access to the Administrative section "Members".
⚠️ Starting October 1, 2026, this endpoint returns a maximum of 100 users per request. Until that date the default, only_paid and for_members_section lists return the whole list when no pagination parameters are passed; the only_virtual list is already paginated. The applied page size is always returned in X-Pagination-Limit, and a request without pagination parameters also gets X-Pagination-Message. Use limit and offset to page through the result. Public API pages are ordered by id.
| Name | Type | Constraints | Description |
|---|---|---|---|
| invitesOnly | boolean | Filter to return only invites | |
| withTransferAccessStatus | boolean | Data about the user rights transfer process is added | |
| for_members_section | boolean | When this flag is enabled, users for the "Members" administrative section are returned. The result is displayed page by page when limit or offset is passed, and always starting October 1, 2026 (See limit and offset params). | |
| owner_only | boolean | When this flag is enabled the company owner is returned | |
| only_paid | boolean | Only users with paid access are returned | |
| only_records_count | boolean | Only the number of users is returned. Works only with the for_members_section or only_virtual parameters | |
| only_virtual | boolean | Only virtual users are returned and result of the request is displayed page by page (See limit and offset params). | |
| offset | integer | Number of records to skip. Does not apply when exporting users. Must be a non negative integer. Default is 0 | |
| limit | integer | Default: 100 Max: 100 | Maximum amount of users in response. Does not apply when exporting users. Must be a positive integer; a value greater than 100 is treated as 100. Starting October 1, 2026 an omitted value means 100 users are returned |
| query | string | Filter by email and full_name. Works only with for_members_section parameter | |
| access_type_permissions | string | Filter by access to Kaiten. Works only with for_members_section parameter | |
| sd_access_type | string | Filter by access to Service Desk. Works only with for_members_section parameter | |
| take_licence | string | Filter by users consuming the license. Works only with for_members_section parameter | |
| temporarily_inactive_status | string | Filter by temporarily inactive users. Works only with for_members_section parameter | |
| group_ids | array | Filter by group ids. Works only with for_members_section parameter | |
| permissions | array | Filter by access granted to users. Works only with for_members_section parameter |
Responses
| Description | Response type | Example |
|---|---|---|
| Success | Array of object |
| Name | Type | Description |
|---|---|---|
| id | integer | Id |
| uid | string | Uid |
| full_name | string | User full name |
string | User email | |
| avatar_initials_url | string | Default user avatar url |
| avatar_uploaded_url | string | null | 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 |
| virtual | boolean | Is user virtual |
| email_blocked | null | string | Email blocked timestamp |
| email_blocked_reason | null | string | Email blocked reason |
| delete_requested_at | null | string | Timestamp of delete request |
| permissions | integer | User company permissions(with inherited permissions through groups) |
| own_permissions | integer | User personal company permissions |
| user_id | integer | User id |
| company_id | integer | Company id |
| default_space_id | null | integer | Default space |
| role | enum | User role in company: 1 - owner, 2 - user, 3 - deactivated |
| email_frequency | enum | 1 - never, 2 – instantly |
| email_settings | null | object | Email settings |
| slack_id | null || integer | User slack id |
| slack_settings | null || object | Slack settings |
| notification_settings | 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 |
| apps_permissions | integer | 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 |
| invite_last_sent_at | null | string | Last invite date |
| external | boolean | Is user external |
| last_request_date | null | string | Date of last request |
| last_request_method | null | string | Type of last request |
| work_time_settings | object | Work time settings |
| personal_settings | null | object | Personal settings |
| locked | boolean | Is user locked for update |
| take_licence | boolean | Flag indicating whether the user holds the company's license |
| spaces | array of objects | Spaces where the user is invited |
| groups | array of objects | User groups |
| 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 |
| Description | Response type | Example |
|---|---|---|
| Not found | 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/company/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!