Manage Applications

    List enterprise groups

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

    Retrieves all of the groups for a given enterprise. The user must have admin permissions to inspect enterprise's groups.

    Request

    application/json

    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.

    integer / int64in queryoptional
    10001000-1000

    The maximum number of items to return per page.

    integer / int64in queryoptional
    10000

    The offset of the item at which to begin the response.

    Response

    application/jsonGroups

    Returns a collection of group objects. If there are no groups, an empty collection will be returned.

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

    Request Example

    cURL
    curl -X GET https://api.box.com/2.0/groups \
         -H "Authorization: Bearer <ACCESS_TOKEN>"
    .NET
    BoxCollection<BoxGroup> groups = await client.GroupsManager.GetAllGroupsAsync();
    Java
    Iterable<BoxGroup.Info> groups = BoxGroup.getAllGroups(api);
    for (BoxGroup.Info groupInfo : groups) {
        // Do something with the group.
    }
    Python
    groups = client.get_groups()
    for group in groups:
        print('Group "{0}" has ID "{1}"'.format(group.name, group.id))
    Node
    client.groups.getAll()
    	.then(groups => {
    		/* groups -> {
    			total_count: 1,
    			entries: [ { type: 'group', id: '1786931', name: 'friends' } ],
    			limit: 100,
    			offset: 0 }
    		*/
    	});

    Response Example

    {
      "total_count": 5000,
      "limit": 1000,
      "offset": 2000,
      "order": [
        {
          "by": "type",
          "direction": "ASC"
        }
      ],
      "entries": [
        {
          "id": 11446498,
          "type": "group",
          "name": "Support",
          "group_type": "managed_group",
          "created_at": "2012-12-12T10:53:43-08:00",
          "modified_at": "2012-12-12T10:53:43-08:00",
          "provenance": "Active Directory",
          "external_sync_identifier": "AD:123456",
          "description": "Support Group - as imported from Active Directory",
          "invitability_level": "admins_only",
          "member_viewability_level": "admins_only"
        }
      ]
    }