List Collaborations
box.list_collaborations
ActionFiles & storageconnection required
Calls the Box API with the connection's credentials.
List who has been given access to a file or folder, and with which role.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- OAuth 2.0
- Providers
- Box
- Secret shape
- {"client_id": "…", "client_secret": "…", "box_subject_type": "enterprise|user", "box_subject_id": "…"} for a server-authentication app, or {"client_id": "…", "client_secret": "…", "refresh_token": "…"} for OAuth2
- Resolved by
- config.connection_id, else node.connection_id
Configuration
4 fields, 1 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
item_type Whether the item is a file or a folder — Box uses a different path for each. | string | No | file | one of "file", "folder" | — |
item_id The id of the file or folder to act on. | string | Yes | — | — | — |
limit How many collaborations to return on this page. | number | No | — | 1–1000 | — |
marker The next_marker from a previous page, to continue the listing. | string | No | — | — | — |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"item_type": "file"
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
entries The collaboration objects on this page. | array | — |
count How many entries this page carries. | number | — |
next_marker Pass this back as 'marker' for the next page. | string | — |
{
"count": 0,
"entries": [],
"next_marker": ""
}Notes
- Uploads go to upload.box.com and everything else to api.box.com; the nodes pick the right host for you.
- Use a Box server-authentication (Client Credentials) app for anything unattended: its credential can be exchanged for a token indefinitely. A plain OAuth2 refresh token is spent by its first use, so that connection needs re-authorising.
- The root folder always has the id '0'.
See List Collaborations run in a workflow.
In a technical demo we add the Box connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.