Sample - Box Platform API
GET/collaborations/{collaboration_id}

Get a collaboration

Retrieves a specific collaboration and its access permissions for a file or folder. Use fields to request additional attributes; when supplied, only the requested fields and the standard mini representation are returned.

2 parameters
collaboration_idstringrequired
The string identifier of the collaboration to retrieve.
fieldsarray<string>optional
A comma-separated list of collaboration attributes to include in the response; specifying this replaces the standard fields with the requested fields and the mini representation.

2 status codes
200Returns a collaboration object containing its identifier, access grantee, assigned role, status, item, and collaboration timestamps.
idstringrequired
The unique identifier for this collaboration.
typestringrequired
The value will always be `collaboration`.
Allowed:collaboration
itemobjectoptional
app_itemobjectoptional
accessible_byobjectoptional
The user or group that is granted access.
invite_emailstringoptional
The email address used to invite an unregistered collaborator, if they are not a registered user.
rolestringoptional
The level of access granted.
Allowed:editorviewerprevieweruploaderpreviewer uploaderviewer uploaderco-ownerowner
expires_atstringoptional
When the collaboration will expire, or `null` if no expiration date is set.
is_access_onlybooleanoptional
If set to `true`, collaborators have access to shared items, but such items won't be visible in the All Files list. Additionally, collaborators won't see the path to the root folder for the shared item.
statusstringoptional
The status of the collaboration invitation. If the status is `pending`, `name` returns an empty string.
Allowed:acceptedpendingrejected
acknowledged_atstringoptional
When the `status` of the collaboration object changed to `accepted` or `rejected`.
created_byobjectoptional
created_atstringoptional
When the collaboration object was created.
modified_atstringoptional
When the collaboration object was last modified.
acceptance_requirements_statusobjectoptional
defaultReturned for an 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

collaboration_id must identify an existing collaboration. If you provide fields, use a comma-separated list of collaboration attributes to include in the response.