Box Developer Documentation
Latest version

List user's groups

get
https://api.box.com/2.0
/users/:user_id/memberships

This endpoint is in the version 2024.0. No changes are required to continue using it. For more details, see Box API versioning.

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
12345

The ID of the user.

Query Parameters

integer (int64)in queryoptional
1000
1000

The maximum number of items to return per page.

integer (int64)in queryoptional
1000
0

The 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.

get
List user's groups
You can now try out some of our APIs live, right here in the documentation.
Log in

Request Example

Learn more about Box SDK versionig strategy.


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 v4
BoxUser user = new BoxUser(api, id);
Iterable<BoxGroupMembership.Info> memberships = user.getAllMemberships();
for (BoxGroupMembership.Info membershipInfo : memberships) {
    // Do something with the membership.
}
Python v3
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 v5
BoxCollection<BoxGroupMembership> memberships = await client.GroupsManager
    .GetAllGroupMembershipsForUserAsync(userId: "11111");
Node v3
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
}