---
title: "Get group"
method: GET
path: "/groups/{group_id}"
tags: ["Groups"]
---

# Get group

`GET /groups/{group_id}`

Retrieves information about a group. Only members of this
group or users with admin-level permissions will be able to
use this API.

## Path parameters

- `group_id` string, required

## Query parameters

- `fields` string[]

## Response `200`

Returns the group object.

- GroupFull — A base representation of a group.
  - `id` string, required — The unique identifier for this object.
  - `type` 'group', required — The value will always be `group`.
  - `name` string — The name of the group.
  - `group_type` 'managed_group' | 'all_users_group' — The type of the group.
  - `created_at` string, date-time — When the group object was created.
  - `modified_at` string, date-time — When the group object was last modified.
  - `provenance` string — Keeps track of which external source this group is coming from (e.g. "Active Directory", "Google Groups", "Facebook Groups"). Setting this will also prevent Box users from editing the group name and its members directly via the Box web application. This is desirable for one-way syncing of groups.
  - `external_sync_identifier` string — An arbitrary identifier that can be used by external group sync tools to link this Box Group to an external group. Example values of this field could be an Active Directory Object ID or a Google Group ID. We recommend you use of this field in order to avoid issues when group names are updated in either Box or external systems.
  - `description` string — Human readable description of the group.
  - `invitability_level` 'admins_only' | 'admins_and_members' | 'all_managed_users' — Specifies who can invite the group to collaborate on items. When set to `admins_only` the enterprise admin, co-admins, and the group's admin can invite the group. When set to `admins_and_members` all the admins listed above and group members can invite the group. When set to `all_managed_users` all managed users in the enterprise can invite the group.
  - `member_viewability_level` 'admins_only' | 'admins_and_members' | 'all_managed_users' — Specifies who can view the members of the group (Get Memberships for Group). * `admins_only` - the enterprise admin, co-admins, group's group admin. * `admins_and_members` - all admins and group members. * `all_managed_users` - all managed users in the enterprise.
  - `permissions` object — Describes the permissions that the current user has for this group.
    - `can_invite_as_collaborator` boolean — Specifies if the user can invite the group to collaborate on any items.

## Other responses

- `default` — An unexpected client error.

---

[API](https://skmtc.net/box/apis/platform-api.md) · [All operations](https://skmtc.net/box/apis/platform-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/box/platform-api/revisions/ba8f087e1a4d/schema)
