autessa.box
11 methods in the box namespace.
autessa.box.connectors.allREAD
autessa.box.connectors.all()List every Box connector you can access in your company.
Returns all Box connectors in your current company that you have at least READ access to, newest-relevant first. Use a connector's connectorId with the other box.connectors.* methods. Credentials are never included in the returned DTOs.
Request fields
No fields.
Response fields
- Name
errors- Type
- string[]
- Description
- Name
deprecationWarnings- Type
- string[]
- Description
- Name
sessionToken- Type
- string
- Description
- Name
connectors- Type
- BoxConnectorDto[]
- Description
autessa.box.connectors.deleteMUTATE
autessa.box.connectors.delete({ connectorId })Permanently delete a Box connector and its stored credential.
Removes the Box connector for connectorId, revoking every tool and script that relied on it. The stored credential is destroyed and cannot be recovered — reconnecting requires the full auth flow again. Requires WRITE (owner-level) access.
Request fields
- Name
connectorId- Type
- string (opaque id)
- Description
- References external connector by opaque id.
Response fields
- Name
errors- Type
- string[]
- Description
- Name
deprecationWarnings- Type
- string[]
- Description
- Name
sessionToken- Type
- string
- Description
- Name
message- Type
- string
- Description
autessa.box.connectors.getREAD
autessa.box.connectors.get({ connectorId })Fetch one Box connector by id.
Returns the full Box connector for connectorId, including its sharing/active state and the linked account metadata — but never the stored credential. Fails if you lack READ access to the connector.
Request fields
- Name
connectorId- Type
- string (opaque id)
- Description
- References external connector by opaque id.
Response fields
- Name
errors- Type
- string[]
- Description
- Name
deprecationWarnings- Type
- string[]
- Description
- Name
sessionToken- Type
- string
- Description
- Name
connector- Type
- BoxConnectorDto
- Description
autessa.box.connectors.getSharingDetailsREAD
autessa.box.connectors.getSharingDetails({ connectorId })Read the current sharing configuration of a Box connector.
Returns how the Box connector is shared: the overall sharingLevel, the companyPermissionLevel granted for COMPANY sharing, the explicit sharedWith members, and your own userAccessLevel. Use before share to see the current state.
Request fields
- Name
connectorId- Type
- string (opaque id)
- Description
- References external connector by opaque id.
Response fields
- Name
errors- Type
- string[]
- Description
- Name
deprecationWarnings- Type
- string[]
- Description
- Name
sessionToken- Type
- string
- Description
- Name
sharingLevel- Type
- "PRIVATE" | "SPECIFIC_MEMBER" | "COMPANY"
- Description
- Name
companyPermissionLevel- Type
- "READ" | "WRITE" | "PUBLISH" | "ADMIN"
- Description
- Name
sharedWith- Type
- UserShareWrapper[]
- Description
- Name
userAccessLevel- Type
- "READ" | "WRITE" | "PUBLISH" | "ADMIN"
- Description
autessa.box.connectors.syncFoldersMUTATE
autessa.box.connectors.syncFolders({ connectorId })Refresh a Box connector's folder mirror from the Box API.
Calls the Box API to fetch the connector's current folder tree and updates the mirrored copy in the database, adding any newly discovered folders. Returns how many new folders were added. New folders start disabled — enable them with updateAvailableFolders. Run this when folders have been created or moved in Box and viewAvailableFolders looks out of date.
Request fields
- Name
connectorId- Type
- string (opaque id)
- Description
- References external connector by opaque id.
Response fields
- Name
errors- Type
- string[]
- Description
- Name
deprecationWarnings- Type
- string[]
- Description
- Name
sessionToken- Type
- string
- Description
- Name
message- Type
- string
- Description
- Name
foldersAdded- Type
- number
- Description
autessa.box.connectors.updateMUTATE
autessa.box.connectors.update({ connectorId, connectorName, isActive })Rename a Box connector or toggle whether it is active.
Applies a sparse patch to the Box connector for connectorId: send connectorName to rename it, isActive to enable/disable it. This is a partial update — omit a field to leave it unchanged; sending null or an empty name is ignored. Does not touch the stored credential or sharing. Requires WRITE access.
Request fields
- Name
connectorId- Type
- string (opaque id)
- Description
- References external connector by opaque id.
- Name
connectorName- Type
- string
- Description
- Name
isActive- Type
- boolean
- Description
Response fields
- Name
errors- Type
- string[]
- Description
- Name
deprecationWarnings- Type
- string[]
- Description
- Name
sessionToken- Type
- string
- Description
- Name
message- Type
- string
- Description
- Name
connector- Type
- BoxConnectorDto
- Description
autessa.box.connectors.updateAvailableFoldersMUTATE
autessa.box.connectors.updateAvailableFolders({ connectorId, foldersToEnable, foldersToDisable })Enable or disable specific Box folders for a connector.
Toggles which of this connector's mirrored Box folders are available to tools. Pass folder ids in foldersToEnable to turn them on and in foldersToDisable to turn them off; only enabled folders can be read by tools that use this connector. Folders not named in either list are left unchanged. Returns the full folder list with the updated isEnabled flags.
Request fields
- Name
connectorId- Type
- string (opaque id)
- Description
- References external connector by opaque id.
- Name
foldersToEnable- Type
- string[]
- Description
- Name
foldersToDisable- Type
- string[]
- Description
Response fields
- Name
errors- Type
- string[]
- Description
- Name
deprecationWarnings- Type
- string[]
- Description
- Name
sessionToken- Type
- string
- Description
- Name
folders- Type
- FolderDto[]
- Description
autessa.box.connectors.viewAvailableFoldersREAD
autessa.box.connectors.viewAvailableFolders({ connectorId })List the Box folders stored for a connector.
Returns every Box folder currently mirrored in the database for this connector — both the folders that are enabled for use by tools and those that are disabled — without calling the Box API. Use it to see the current folder tree and each folder's isEnabled flag before changing them with updateAvailableFolders. Run syncFolders first if the mirror may be stale.
Request fields
- Name
connectorId- Type
- string (opaque id)
- Description
- References external connector by opaque id.
Response fields
- Name
errors- Type
- string[]
- Description
- Name
deprecationWarnings- Type
- string[]
- Description
- Name
sessionToken- Type
- string
- Description
- Name
folders- Type
- FolderDto[]
- Description
autessa.box.download.getByShortIdREAD
autessa.box.download.getByShortId()Resolve a Box short download id to its download page.
Public, unauthenticated endpoint. Resolves a short download id (issued elsewhere for a Box file) to an HTML page that redirects the browser to a time-limited Box download URL. It returns HTML, not JSON, so there is no structured response body; a 404 page is returned if the id is unknown or expired. This is meant to be opened in a browser and is rarely called from scripts.
Request fields
No fields.
Response fields
No fields.