Sample - Box Platform API
GET/groups/{group_id}/collaborations

List group collaborations

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

Each collaboration object has details on which files or folders the group has access to and with what role.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

3 parameters
group_idstringrequired
The ID of the group.
limitintegeroptional
The maximum number of items to return per page.
offsetintegeroptional
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.
Default:0

2 status codes
200Returns a collection of collaboration objects. If there are no collaborations, an empty collection will be returned.
total_countintegeroptional
One greater than the offset of the last entry in the entire collection. The total number of entries in the collection may be less than `total_count`. This field is only returned for calls that use offset-based pagination. For marker-based paginated APIs, this field will be omitted.
limitintegeroptional
The limit that was used for these entries. This will be the same as the `limit` query parameter unless that value exceeded the maximum value allowed. The maximum value varies by API.
offsetintegeroptional
The 0-based offset of the first entry in this set. This will be the same as the `offset` query parameter. This field is only returned for calls that use offset-based pagination. For marker-based paginated APIs, this field will be omitted.
entriesarray<Collaboration>optional
A list of collaborations.
defaultAn unexpected client error.
typestringoptional
The value will always be `error`.
Allowed:error
statusintegeroptional
The HTTP status of the response.
codestringoptional
A Box-specific error code.
Allowed:createdacceptedno_contentredirectnot_modifiedbad_requestunauthorizedforbiddennot_foundmethod_not_allowedconflictprecondition_failed
messagestringoptional
A short message describing the error.
context_infoobjectoptional
A free-form object that contains additional context about the error. The possible fields are defined on a per-endpoint basis. `message` is only one example.
help_urlstringoptional
A URL that links to more information about why this error occurred.
request_idstringoptional
A unique identifier for this response, which can be used when contacting Box support.

Error handling

Any other status is an error: An unexpected client error.