Latest version
List user's groups
API version 2024.0
Retrieves all the groups for a user. Only members of this group or users with admin-level permissions will be able to use this API.
Request
bearer [ACCESS_TOKEN]
application/json
Path Parameters
stringin pathrequired
12345The ID of the user.
Query Parameters
integer (int64)in queryoptional
10001000The maximum number of items to return per page.
integer (int64)in queryoptional
10000The offset of the item at which to begin the response.
Queries with offset parameter value exceeding 10000 will be rejected with a 400 response.
Response
application/jsonGroup memberships
Returns a collection of membership objects. If there are no memberships, an empty collection will be returned.
application/jsonClient error
An unexpected client error.
Request Example
cURL
curl -i -X GET "https://api.box.com/2.0/users/12345/memberships" \
-H "authorization: Bearer <ACCESS_TOKEN>"Node/TypeScript v10
await client.memberships.getUserMemberships(user.id);Python v10
client.memberships.get_user_memberships(user.id).NET v10
await client.Memberships.GetUserMembershipsAsync(userId: user.Id);Swift v10
try await client.memberships.getUserMemberships(userId: user.id)Java v10
client.getMemberships().getUserMemberships(user.getId())Java v5
BoxUser user = new BoxUser(api, id);
Iterable<BoxGroupMembership.Info> memberships = user.getAllMemberships();
for (BoxGroupMembership.Info membershipInfo : memberships) {
// Do something with the membership.
}Python v4
user_memberships = client.user(user_id='33333').get_group_memberships()
for membership in user_memberships:
print(f'User is in the {membership.group.name} group').NET v6
BoxCollection<BoxGroupMembership> memberships = await client.GroupsManager
.GetAllGroupMembershipsForUserAsync(userId: "11111");Node v4
var userID = '22222';
client.users.getGroupMemberships(userID)
.then(memberships => {
/* memberships -> {
total_count: 1,
entries:
[ { type: 'group_membership',
id: '12345',
user:
{ type: 'user',
id: '22222',
name: 'Alison Wonderland',
login: 'alice@example.com' },
group: { type: 'group', id: '11111', name: 'Employees' },
role: 'member' } ],
limit: 100,
offset: 0 }
*/
});Response Example
{
"entries": [
{
"created_at": "2012-12-12T10:53:43-08:00",
"group": {
"id": "11446498",
"type": "group",
"group_type": "managed_group",
"name": "Support"
},
"id": "11446498",
"modified_at": "2012-12-12T10:53:43-08:00",
"role": "member",
"type": "group_membership",
"user": {
"id": "11446498",
"type": "user",
"login": "ceo@example.com",
"name": "Aaron Levie"
}
}
],
"limit": 1000,
"offset": 2000,
"order": [
{
"by": "type",
"direction": "ASC"
}
],
"total_count": 5000
}