Retrieve users list
GET
https://example.kaiten.ru/api/latest/cards/{card_id}/allowed-usersReturns a list of users with access to card
| Name | Type | Reference |
|---|---|---|
| card_idrequired | integer | Card ID |
| Name | Value |
|---|---|
| Content-Type | application/json |
| Name | Type | Constraints | Description |
|---|---|---|---|
| type | enum | sd-owners virtual-users mention | sd-owner - returns a list of company users with access to service-desk. virtual-users - returns a list of company virtual users. |
| search | string | Filter by full_name, email or username | |
| orderBy | string | Default: id | The field to sort by |
| role | integer | Filter by role | |
| limit | integer | Maximum amount of users in response. | |
| offset | integer | Number of records to skip |
Responses
| Description | Response type | Example |
|---|---|---|
| Success | Object |
| 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 | enum | 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 | enum | 1 - old ui. 2 - new ui |
| 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.
| 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
Path Parameters
1 curl --request GET \
2 --url 'https://example.kaiten.ru/api/latest/cards/{card_id}/allowed-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!