Box Developer Documentation
Log in
Latest version

List members of group

get
https://api.box.com/2.0
/groups/:group_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 members for a group. Only members of this group or users with admin-level permissions will be able to use this API.

Related Guides

Request

bearer [ACCESS_TOKEN]
application/json

Path Parameters

stringin pathrequired
57645

The ID of the group.

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 members of group
You can now try out some of our APIs live, right here in the documentation.
Log in

Request Example

cURL
curl -i -X GET "https://api.box.com/2.0/groups/57645/memberships" \
     -H "authorization: Bearer <ACCESS_TOKEN>"
TypeScript Gen
await client.memberships.getGroupMemberships(group.id);
Python Gen
client.memberships.get_group_memberships(group.id)
.NET Gen
await client.Memberships.GetGroupMembershipsAsync(groupId: group.Id);
Swift Gen (Beta)
try await client.memberships.getGroupMemberships(groupId: group.id)
Java
BoxGroup group = new BoxGroup(api, id);
Iterable<BoxGroupMembership.Info> memberships = group.getAllMemberships();
for (BoxGroupMembership.Info membershipInfo : memberships) {
    // Do something with the membership.
}
Python
group_memberships = client.group(group_id='11111').get_memberships()
for membership in group_memberships:
    print(f'{membership.user.name} is a {membership.role} of the {membership.group.name} group')
.NET
BoxCollection<BoxGroupMembership> memberships = await client.GroupsManager
    .GetAllGroupMembershipsForGroupAsync("11111");
Node
client.groups.getMemberships('11111')
	.then(memberships => {
		/* memberships -> {
			total_count: 2,
			entries: 
			[ { type: 'group_membership',
				id: '44444',
				user: 
					{ type: 'user',
					id: '22222',
					name: 'Alice',
					login: 'alice@example.com' },
				group: { type: 'group', id: '11111', name: 'Employees' },
				role: 'member' },
				{ type: 'group_membership',
				id: '55555',
				user: 
					{ type: 'user',
					id: '66666',
					name: 'White Rabbit',
					login: 'rabbit@example.com' },
				group: { type: 'group', id: '11111', name: 'Employees' },
				role: 'member' } ],
			offset: 0,
			limit: 100 }

		*/
	});
iOS
let iterator = client.groups.listMembership(groupId: "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": [
    {
      "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
}