Box Developer Documentation
Log in

Join BoxWorks 2024 to discover what's possible with content and AI!

Register now!

Get group membership

get
https://api.box.com/2.0
/group_memberships/:group_membership_id

Retrieves a specific group membership. Only admins 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
434534

The ID of the group membership.

Query Parameters

string arrayin queryoptional
id,type,name

A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response.

Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.

Response

application/jsonGroup membership

Returns the group membership object.

application/jsonClient error

An unexpected client error.

get
Get group membership
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/group_memberships/434534" \
     -H "authorization: Bearer <ACCESS_TOKEN>"
TypeScript Gen
await client.memberships.getGroupMembershipById(groupMembership.id!);
Python Gen
client.memberships.get_group_membership_by_id(group_membership.id)
.NET Gen
await client.Memberships.GetGroupMembershipByIdAsync(groupMembershipId: NullableUtils.Unwrap(groupMembership.Id));
Swift Gen (Beta)
try await client.memberships.getGroupMembershipById(groupMembershipId: groupMembership.id!)
Java
BoxGroupMembership membership = new BoxGroupMembership(api, id);
BoxGroupMembership.Info groupMembershipInfo = membership.getInfo();
Python
membership_id = '11111'
membership = client.group_membership(membership_id).get()
print(f'User "{membership.user.name}" is a member of the {membership.group.name} group')
Node
client.groups.getMembership('33333')
	.then(membership => {
		/* membership -> {
			type: 'group_membership',
			id: '33333',
			user: 
			{ type: 'user',
				id: '22222',
				name: 'Alison Wonderland',
				login: 'alice@example.com' },
			group: { type: 'group', id: '11111', name: 'Employees' },
			role: 'member',
			configurable_permissions: 
			{ can_run_reports: false,
				can_instant_login: false,
				can_create_accounts: false,
				can_edit_accounts: false },
			created_at: '2013-05-16T15:27:57-07:00',
			modified_at: '2013-05-16T15:27:57-07:00' }
		*/
	});
iOS
client.groups.getMembershipInfo(membershipId: "12345") { 
(result: Result<GroupMembership, BoxSDKError>) in
    guard case let .success(membership) = result else {
        print("Error retrieving group membership information")
        return
    }

    print("Group Membership for group \(membership.group?.name) was retrieved")
}

Response Example

{
  "id": "11446498",
  "type": "group_membership",
  "created_at": "2012-12-12T10:53:43-08:00",
  "group": {
    "id": "11446498",
    "type": "group",
    "group_type": "managed_group",
    "name": "Support"
  },
  "modified_at": "2012-12-12T10:53:43-08:00",
  "role": "member",
  "user": {
    "id": "11446498",
    "type": "user",
    "login": "ceo@example.com",
    "name": "Aaron Levie"
  }
}