View as Markdown
Box icon

Box ACTION

List Collaborations

Lists the collaborations (users and groups with access, and their roles) on a Box file or folder. Use this to find a collaboration ID before calling Delete Collaboration, or to audit who has access to an item. Item Type must be file or folder. See the documentation.
  • Action
  • Read only
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Box account once, then configure and run List Collaborations from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "box-list-collaborations",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    box: { authProvisionId: "apn_xxxxxxx" },
    itemType: "Item Type",
    folderId: "Folder",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

List Collaborations inputs
Property Type Description
itemType Item Type string
The type of Box item. Valid values: file or folder.
Required
folderId Folder string
The folder to list collaborations for when Item Type is folder. When Item Type is file, use this as the parent folder ID to scope available file IDs. Use 0 for the root folder. Use the List Folders action to retrieve folder IDs.
Required Dynamic
fileId File string
The file to list collaborations for (e.g. 123456789). Required when Item Type is file. Use the List Folder Items action to retrieve file IDs.
Optional Dynamic

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
box-list-collaborations
Version
0.0.2
App
Box
Authentication
OAuth
Read-only
Yes
Destructive
No
Open world
Yes