Box
Configuration
Box source connector integrates with the Box API to extract and synchronize data.
Connects to your Box account and syncs folders, files, comments, users, and collaborations.
Source Code: View on GitHub
Authentication
This connector uses OAuth 2.0 authentication. You can connect through the Graffo UI or API using the OAuth flow.
Supported authentication methods:
OAuth Browser Flow (recommended for UI)
OAuth Token (for programmatic access)
Auth Provider (enterprise SSO)
Configuration Options
The following configuration options are available for this connector:
Data Models
The following data models are available for this connector:
BoxUserEntity
Schema for Box user entities.
user_id
str
Box user ID
name
str
Display name of the user
created_at
Optional[str]
When the user was created
updated_at
Optional[str]
When the user was last modified
login
Optional[str]
Login email address of the user
status
Optional[str]
Status of the user (active, inactive, etc.)
job_title
Optional[str]
Job title of the user
phone
Optional[str]
Phone number of the user
address
Optional[str]
Address of the user
language
Optional[str]
Language of the user
timezone
Optional[str]
Timezone of the user
space_amount
Optional[int]
Total storage space available to the user in bytes
space_used
Optional[int]
Storage space used by the user in bytes
max_upload_size
Optional[int]
Maximum file size the user can upload in bytes
avatar_url
Optional[str]
URL to the user's avatar image
BoxFolderEntity
Schema for Box folder entities.
folder_id
str
Box folder ID
name
str
Folder name
created_at
Optional[str]
When the folder was created
updated_at
Optional[str]
When the folder was last modified
description
Optional[str]
Description of the folder
size
Optional[int]
Size of the folder in bytes
path_collection
List[Dict]
Path of parent folders from root to this folder
content_created_at
Optional[Any]
When the content in this folder was originally created
content_modified_at
Optional[Any]
When the content in this folder was last modified
created_by
Optional[Dict]
User who created this folder
modified_by
Optional[Dict]
User who last modified this folder
owned_by
Optional[Dict]
User who owns this folder
parent_id
Optional[str]
ID of the parent folder
parent_name
Optional[str]
Name of the parent folder
item_status
Optional[str]
Status of the folder (active, trashed, deleted)
shared_link
Optional[Dict]
Shared link information for this folder
folder_upload_email
Optional[Dict]
Email address that can be used to upload files to this folder
tags
List[str]
Tags associated with this folder
has_collaborations
Optional[bool]
Whether this folder has collaborations
permissions
Optional[Dict]
Permissions the current user has on this folder
permalink_url
Optional[str]
Direct link to view the folder in Box
etag
Optional[str]
Entity tag for versioning
sequence_id
Optional[str]
Sequence ID for the most recent user event
BoxFileEntity
Schema for Box file entities.
file_id
str
Box file ID
name
str
File name
created_at
Optional[str]
When the file was created
updated_at
Optional[str]
When the file was last modified
description
Optional[str]
Description of the file
parent_folder_id
str
ID of the parent folder
parent_folder_name
str
Name of the parent folder
path_collection
List[Dict]
Path of parent folders from root to this file
sha1
Optional[str]
SHA1 hash of the file contents
extension
Optional[str]
File extension
version_number
Optional[str]
Version number of the file
comment_count
Optional[int]
Number of comments on this file
content_created_at
Optional[Any]
When the content of this file was originally created
content_modified_at
Optional[Any]
When the content of this file was last modified
created_by
Optional[Dict]
User who created this file
modified_by
Optional[Dict]
User who last modified this file
owned_by
Optional[Dict]
User who owns this file
item_status
Optional[str]
Status of the file (active, trashed, deleted)
shared_link
Optional[Dict]
Shared link information for this file
tags
List[str]
Tags associated with this file
has_collaborations
Optional[bool]
Whether this file has collaborations
permissions
Optional[Dict]
Permissions the current user has on this file
lock
Optional[Dict]
Lock information if the file is locked
permalink_url
Optional[str]
Direct link to view the file in Box
etag
Optional[str]
Entity tag for versioning
sequence_id
Optional[str]
Sequence ID for the most recent user event
BoxCommentEntity
Schema for Box comment entities.
comment_id
str
Box comment ID
name
str
Comment preview or identifier
created_at
Optional[str]
When the comment was created
updated_at
Optional[str]
When the comment was last modified
file_id
str
ID of the file this comment is on
file_name
str
Name of the file
message
str
Content of the comment
created_by
Dict
User who created this comment
is_reply_comment
bool
Whether this comment is a reply to another comment
tagged_message
Optional[str]
Tagged version of the message with user mentions
BoxCollaborationEntity
Schema for Box collaboration entities.
collaboration_id
str
Box collaboration ID
name
str
Collaboration display label
created_at
Optional[str]
When the collaboration was created
updated_at
Optional[str]
When the collaboration was last modified
role
str
Role of the collaborator (editor, viewer, previewer, etc.)
accessible_by
Dict
User or group that this collaboration applies to
item
Dict
File or folder that is being collaborated on
item_id
str
ID of the item being collaborated on
item_type
str
Type of the item (file or folder)
item_name
str
Name of the item being collaborated on
status
str
Status of the collaboration (accepted, pending, etc.)
created_by
Optional[Dict]
User who created this collaboration
expires_at
Optional[Any]
When this collaboration expires
is_access_only
Optional[bool]
Whether this is an access-only collaboration
invite_email
Optional[str]
Email address invited to collaborate
acknowledged_at
Optional[Any]
When the collaboration was acknowledged
Last updated
