Skip to content
For LLMsView as Markdown·

Box

Manage files, folders, and collaborations on Box cloud storage.

DetailValue
CategoryProductivity
Base URLhttps://api.box.com/2.0
AuthenticationOAuth2
Endpoints6
Connector keybox

Using Box in a workflow

  1. Go to Connections and click New Connection.
  2. Pick Box from the marketplace.
  3. Enter your credentials (see Authentication above for what's expected).
  4. In a workflow, drop an API Call node and select this connection.
  5. Pick the operation you need from the Operation dropdown — the full list is below.

Available endpoints

EndpointSummary
GET /folders/{folder_id}Get a folder
GET /folders/{folder_id}/itemsList items in a folder
GET /files/{file_id}Get file info
POST /files/contentUpload a file
GET /searchSearch for content
POST /collaborationsAdd a collaborator

Each endpoint is documented in full below. Use the outline on the right to jump to one.

GET /folders/{folder_id}

Get a folder

DetailValue
Operation IDstorage.getFolder
MethodGET
Path/folders/{folder_id}

Parameters

NameLocationTypeRequired
folder_idpathstringYes

Using this endpoint in a workflow

  1. Add an API Call node to your workflow.
  2. Pick your Box connection from the Connection dropdown.
  3. In the Operation dropdown, select storage.getFolder.
  4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

Required fields are marked — fill them or the call will fail at runtime.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Box API reference.

GET /folders/{folder_id}/items

List items in a folder

DetailValue
Operation IDstorage.listFolderItems
MethodGET
Path/folders/{folder_id}/items

Parameters

NameLocationTypeRequired
folder_idpathstringYes
limitqueryintegerNo

Using this endpoint in a workflow

  1. Add an API Call node to your workflow.
  2. Pick your Box connection from the Connection dropdown.
  3. In the Operation dropdown, select storage.listFolderItems.
  4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

Required fields are marked — fill them or the call will fail at runtime.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Box API reference.

GET /files/{file_id}

Get file info

DetailValue
Operation IDstorage.getFile
MethodGET
Path/files/{file_id}

Parameters

NameLocationTypeRequired
file_idpathstringYes

Using this endpoint in a workflow

  1. Add an API Call node to your workflow.
  2. Pick your Box connection from the Connection dropdown.
  3. In the Operation dropdown, select storage.getFile.
  4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

Required fields are marked — fill them or the call will fail at runtime.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Box API reference.

POST /files/content

Upload a file

DetailValue
Operation IDstorage.uploadFile
MethodPOST
Path/files/content

Parameters

No parameters.

Request Body

FieldType
namestring
parentobject

Using this endpoint in a workflow

  1. Add an API Call node to your workflow.
  2. Pick your Box connection from the Connection dropdown.
  3. In the Operation dropdown, select storage.uploadFile.
  4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

Required fields are marked — fill them or the call will fail at runtime.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Box API reference.

Search for content

DetailValue
Operation IDstorage.search
MethodGET
Path/search

Parameters

NameLocationTypeRequired
queryquerystringYes

Using this endpoint in a workflow

  1. Add an API Call node to your workflow.
  2. Pick your Box connection from the Connection dropdown.
  3. In the Operation dropdown, select storage.search.
  4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

Required fields are marked — fill them or the call will fail at runtime.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Box API reference.

POST /collaborations

Add a collaborator

DetailValue
Operation IDstorage.addCollaborator
MethodPOST
Path/collaborations

Parameters

No parameters.

Request Body

FieldType
itemobject
accessible_byobject
rolestring

Using this endpoint in a workflow

  1. Add an API Call node to your workflow.
  2. Pick your Box connection from the Connection dropdown.
  3. In the Operation dropdown, select storage.addCollaborator.
  4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

Required fields are marked — fill them or the call will fail at runtime.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Box API reference.