List groups for enterprise
GET https://{{api.box.com}}/2.0/groups
Retrieves all of the groups for a given enterprise. The user
https://developer.box.com/reference/get-groups
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
filter_term | string | Limits the results to only groups whose name starts | |
| with the search term. | |||
fields | string | 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. |
| limit | number | | The maximum number of items to return per page. |
| offset | number | | The offset of the item at which to begin the response.
Queries with offset parameter value exceeding 10000 will be rejected with a 400 response. |
RESPONSES
status: OK
{"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","permissions":{"can_invite_as_collaborator":true}}]}