Skip to content

listCollaborations.md

Latest commit

 

History

History
138 lines (89 loc) · 4.33 KB

listCollaborations.md

File metadata and controls

138 lines (89 loc) · 4.33 KB
Raw

ListCollaborationsManager

List file collaborations

Retrieves a list of pending and active collaborations for a file. This returns all the users that have access to the file or have been invited to the file.

This operation is performed by calling function getFileCollaborations.

See the endpoint docs at API Reference.

await client.listCollaborations.getFileCollaborations(file.id);

Arguments

  • fileId string
    • The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/files/123 the file_id is 123. Example: "12345"
  • optionalsInput GetFileCollaborationsOptionalsInput

Returns

This function returns a value of type Collaborations.

Returns a collection of collaboration objects. If there are no collaborations on this file an empty collection will be returned.

This list includes pending collaborations, for which the status is set to pending, indicating invitations that have been sent but not yet accepted.

List folder collaborations

Retrieves a list of pending and active collaborations for a folder. This returns all the users that have access to the folder or have been invited to the folder.

This operation is performed by calling function getFolderCollaborations.

See the endpoint docs at API Reference.

await client.listCollaborations.getFolderCollaborations(folder.id);

Arguments

  • folderId string
    • The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/folder/123 the folder_id is 123. Example: "12345"
  • optionalsInput GetFolderCollaborationsOptionalsInput

Returns

This function returns a value of type Collaborations.

Returns a collection of collaboration objects. If there are no collaborations on this folder an empty collection will be returned.

This list includes pending collaborations, for which the status is set to pending, indicating invitations that have been sent but not yet accepted.

List pending collaborations

Retrieves all pending collaboration invites for this user.

This operation is performed by calling function getCollaborations.

See the endpoint docs at API Reference.

await client.listCollaborations.getCollaborations({
  status: 'pending' as GetCollaborationsQueryParamsStatusField,
} satisfies GetCollaborationsQueryParams);

Arguments

  • queryParams GetCollaborationsQueryParams
    • Query parameters of getCollaborations method
  • optionalsInput GetCollaborationsOptionalsInput

Returns

This function returns a value of type CollaborationsOffsetPaginated.

Returns a collection of pending collaboration objects.

If the user has no pending collaborations, the collection will be empty.

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.

This operation is performed by calling function getGroupCollaborations.

See the endpoint docs at API Reference.

await client.listCollaborations.getGroupCollaborations(group.id);

Arguments

  • groupId string
    • The ID of the group. Example: "57645"
  • optionalsInput GetGroupCollaborationsOptionalsInput

Returns

This function returns a value of type CollaborationsOffsetPaginated.

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