Get User Groups
Get User Groups
Retrieves the Groups of a specified user.
This API can be used to create UI that displays user information, based on the target user's information.
When run in a guest space, only the Everyone/Administrator group is returned.
Function
kintone.user.getGroups(code)
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| code | String | The login name. If ignored, the logged-in user's information will be retrieved. |
Returns
A Promise object.
When the Promise object is fulfilled, an array of objects containing the following elements can be retrieved:
| Property | Type | Value & Description |
|---|---|---|
| id | String | Group ID |
| code | String | Group code |
| name | String | Group name |
Available Pages
However, it cannot be used on the following pages:
- Search results
- Marketplace
- Plug-in settings page
Notes
- This API retrieves data from the server at runtime. The retrieved data is cached until a screen transition occurs. If there are more than 50 data retrievals from the server per minute per user, the returned Promise object will be rejected.
- To retrieve other information about the group, use the following API:
Get Groups