Box

Node: box · Full type: n8n-nodes-base.box · Version: 1

Credentials

boxOAuth2Api (alias: @box)

CREDENTIAL @box = boxOAuth2Api "My Box"

Operations

Resource: file

copy

Parameter	Type	Default	Details
fileId	string	""	required
parentId	string	""
additionalFields	collection	{}	keys: fields, name, version

delete

Parameter	Type	Default	Details
fileId	string	""

download

Parameter	Type	Default	Details
fileId	string	""
binaryPropertyName	string	"data"	required

get

Parameter	Type	Default	Details
fileId	string	""
additionalFields	collection	{}	keys: fields

search

Parameter	Type	Default	Details
query	string	""
returnAll	boolean	false
limit	number	100
additionalFields	collection	{}	keys: contet_types, createdRangeUi, direction, fields, file_extensions, ancestor_folder_ids, ...

share

Parameter	Type	Default	Details
fileId	string	""
accessibleBy	options	""	group, user
useEmail	boolean	true
email	string	""
userId	string	""
groupId	string	""
role	options	"editor"	coOwner, editor, previewer, previewerUploader, uploader, viewer, viewerUploader
options	collection	{}	keys: can_view_path, expires_at, fields, notify

upload

Parameter	Type	Default	Details
fileName	string	""
binaryData	boolean	false	required
fileContent	string	""	required
binaryPropertyName	string	"data"	required
parentId	string	""

Resource: folder

create

Parameter	Type	Default	Details
name	string	""	required
parentId	string	""
options	collection	{}	keys: access, fields

delete

Parameter	Type	Default	Details
folderId	string	""
recursive	boolean	false

get

Parameter	Type	Default	Details
folderId	string	""

search

Parameter	Type	Default	Details
query	string	""
returnAll	boolean	false
limit	number	100
additionalFields	collection	{}	keys: contet_types, createdRangeUi, direction, fields, file_extensions, ancestor_folder_ids, ...

share

Parameter	Type	Default	Details
folderId	string	""
accessibleBy	options	"user"	user, group
useEmail	boolean	true
email	string	""
userId	string	""
groupId	string	""
role	options	"editor"	coOwner, editor, previewer, previewerUploader, uploader, viewer, viewerUploader
options	collection	{}	keys: can_view_path, expires_at, fields, notify

update

Parameter	Type	Default	Details
folderId	string	""	required
updateFields	collection	{}	keys: can_non_owners_invite, can_non_owners_view_collaborators, description, fields, is_collaboration_restricted_to_enterprise, name, ...

Parameter Details

additionalFields children:

Parameter	Type	Default	Details
fields	string	""
name	string	""
version	string	""

options children:

Parameter	Type	Default	Details
can_view_path	boolean	false
expires_at	dateTime	""
fields	string	""
notify	boolean	false

updateFields children:

Parameter	Type	Default	Details
can_non_owners_invite	boolean	false
can_non_owners_view_collaborators	boolean	false
description	string	""
fields	string	""
is_collaboration_restricted_to_enterprise	boolean	false
name	string	""
parentId	string	""
shared_link	collection	{}	keys: access, password, permissions, tags

Example

NODE "box" @box AS "Box" {
  resource: "file",
  operation: "get",
  fileId: {{ $json.fileId }},
  binaryPropertyName: {{ $json.binaryPropertyName }},
  fileContent: {{ $json.fileContent }}
}