Box Developer Documentation
Log in
Latest version

Get group

get
https://api.box.com/2.0
/groups/:group_id

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

Retrieves information about a group. 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
57645

The ID of the group.

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 (Full)

Returns the group object

application/jsonClient error

An unexpected client error.

get
Get 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" \
     -H "authorization: Bearer <ACCESS_TOKEN>"
TypeScript Gen
await client.groups.getGroupById(group.id, {
  queryParams: {
    fields: [
      'id' as string,
      'name' as string,
      'description' as string,
      'group_type' as string,
    ],
  } satisfies GetGroupByIdQueryParams,
} satisfies GetGroupByIdOptionalsInput);
Python Gen
client.groups.get_group_by_id(
    group.id, fields=["id", "name", "description", "group_type"]
)
.NET Gen
await client.Groups.GetGroupByIdAsync(groupId: group.Id, queryParams: new GetGroupByIdQueryParams() { Fields = Array.AsReadOnly(new [] {"id","name","description","group_type"}) });
Swift Gen (Beta)
try await client.groups.getGroupById(groupId: group.id, queryParams: GetGroupByIdQueryParams(fields: ["id", "name", "description", "group_type"]))
Java
String groupID = "92875";
BoxGroup.Info groupInfo = new BoxGroup(api, groupID).getInfo();
Python
group = client.group(group_id='11111').get()
print(f'Got group {group.name}')
.NET
BoxGroup group = await client.GroupsManager.GetGroupAsync("11111");
Node
client.groups.get('11111')
	.then(group => {
		/* group -> {
			type: 'group',
			id: '11111',
			name: 'Everyone',
			created_at: '2014-09-15T13:15:35-07:00',
			modified_at: '2014-09-15T13:15:35-07:00' }
		*/
	});
iOS
client.groups.get(groupId: "12345") {
(result: Result<Group, BoxSDKError>) in
    guard case let .success(group) = result else {
        print("Error getting group information")
        return
    }

    print("Group with name \(group.name) was retrieved.")
}

Response Example

{
  "id": "11446498",
  "type": "group",
  "created_at": "2012-12-12T10:53:43-08:00",
  "description": "Support Group - as imported from Active Directory",
  "external_sync_identifier": "AD:123456",
  "group_type": "managed_group",
  "invitability_level": "admins_only",
  "member_viewability_level": "admins_only",
  "modified_at": "2012-12-12T10:53:43-08:00",
  "name": "Support",
  "permissions": {
    "can_invite_as_collaborator": true
  },
  "provenance": "Active Directory"
}