Get group

get

https://api.box.com/2.0

/groups/:group_id

Retrieves information about a group.

Request

Content-Typeapplication/json

Path Parameters

group_id stringin pathrequired

example57645

The ID of the group.

Query Parameters

fieldsstring arrayin queryoptional

exampleid,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

200application/jsonGroup

Returns the group object

defaultapplication/jsonClient error

An unexpected client error.

get

Get group

You can now try out some of our APIs live, right here in the documentation.

Request Example

cURL

curl -X GET https://api.box.com/2.0/groups/57645 \
     -H 'Authorization: Bearer <ACCESS_TOKEN>'

.NET

BoxGroup group = await client.GroupsManager.GetGroupAsync("11111");

Java

String groupID = "92875";
BoxGroup.Info groupInfo = new BoxGroup(api, groupID).getInfo();

Python

group = client.group(group_id='11111').get()
print('Got group {0}'.format(group.name))

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.")
}