external_collaborators
Enumerate external collaborators on Box folders by walking accessible folders, reporting outside-org collaborators and pending invites for access review.
Instructions
List external collaborators on Box folders (current state, enumeration).
Walks folders the authenticating co-admin user can see (default from the root "All Files") and reports collaborations whose collaborator is outside the org domain allowlist — accepted external users or pending external invites. Useful to review who outside the organization has standing access.
Args:
root_folder_id: Folder to start from ("0" = the user's root).
max_folders: Cap on folders visited (default 150); capped discloses
when coverage was cut short.
max_depth: Folder recursion depth (default 1 = top-level folders only).
Externally-owned folders (this org is only a guest, not the owner) are out
of scope and skipped — we cannot govern their collaborations, and their
"external collaborators" are just the owner's own org accounts. They are
reported separately under skipped_externally_owned (never silently
dropped) and do not consume the max_folders budget.
Coverage note: limited to content the co-admin user can access (not provably
100% of the enterprise) and to the depth/folders caps. Returns
folders_scanned, capped, fetch_errors (count of folders whose
lookup hit an API error that outlasted the client's retries, e.g. a persistent
403 or a sustained throttle — coverage is complete only when capped is false
AND fetch_errors is 0), count,
external_collaborators (folder, owner, collaborator, role, status,
expires_at), and skipped_externally_owned (folder_id, folder_name,
owner). On failure returns {"error": ...}.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| max_depth | No | ||
| max_folders | No | ||
| root_folder_id | No | 0 |