Join BoxWorks 2024 to discover what's possible with content and AI!
Register now!List user's groups
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>"TypeScript Gen
await client.memberships.getUserMemberships(user.id);Python Gen
client.memberships.get_user_memberships(user.id).NET Gen
await client.Memberships.GetUserMembershipsAsync(userId: user.Id);Swift Gen (Beta)
try await client.memberships.getUserMemberships(userId: user.id)Java
BoxUser user = new BoxUser(api, id);
Iterable<BoxGroupMembership.Info> memberships = user.getAllMemberships();
for (BoxGroupMembership.Info membershipInfo : memberships) {
// Do something with the membership.
}Python
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
BoxCollection<BoxGroupMembership> memberships = await client.GroupsManager
.GetAllGroupMembershipsForUserAsync(userId: "11111");Node
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 }
*/
});iOS
let iterator = client.groups.listMembershipsForUser(userId: "12345")
iterator.next { result in
switch results {
case let .success(page):
for membership in page.entries {
print("Group Membership with ID \(membership.id) was retrieved")
}
case let .failure(error):
print(error)
}
}Response Example
{
"entries": [
{
"id": "11446498",
"type": "group_membership",
"user": {
"id": "11446498",
"type": "user",
"name": "Aaron Levie",
"login": "ceo@example.com"
},
"group": {
"id": "11446498",
"type": "group",
"name": "Support",
"group_type": "managed_group"
},
"role": "member",
"created_at": "2012-12-12T10:53:43-08:00",
"modified_at": "2012-12-12T10:53:43-08:00"
}
],
"limit": 1000,
"offset": 2000,
"order": [
{
"by": "type",
"direction": "ASC"
}
],
"total_count": 5000
}