Skip to main content

Box

The Box Connector enables seamless data extraction from Box, allowing users to list, access, and synchronize files or folders from their Box cloud storage. This connector helps automate workflows by integrating Box data with other tools, ensuring efficient file management and analysis

Authentication​

This connector uses Box's Client Credentials Grant (CCG) server authentication. Follow the setup guide:

  1. In the Box Developer Console, create a Platform App of type Server Authentication (Client Credentials Grant) and copy its Client ID and Client Secret from the Configuration tab.
  2. Authorize the app. On an enterprise account, submit the app for approval and have an admin authorize it in Admin Console > Apps > Custom Apps Manager. Re-authorize the app after every change to its configuration.
  3. Pick the subject the connector authenticates as (Subject Type):
    • enterprise — authenticate as the app's Service Account. Works with the default App Access Only level; set User ID or Enterprise ID to your enterprise ID (Admin Console > Account & Billing).
    • user — authenticate as a Managed User or Admin. The app's App Access Level must be App + Enterprise Access and Generate User Access Tokens must be enabled; set User ID or Enterprise ID to the user's ID.

If check fails with 400 Bad Request from https://api.box.com/oauth2/token, Box rejected the grant (invalid_grant - Grant credentials are invalid): the client ID/secret are wrong or belong to different apps, the app is not authorized in the Admin Console, or the chosen Subject Type is not allowed by the app's access level. See Box's common errors.

Configuration​

InputTypeDescriptionDefault Value
client_idstringOAuth Client ID.
client_secretstringOAuth Client Secret.
usernumberBox user ID (Subject Type user) or enterprise ID (Subject Type enterprise) to authenticate as.
box_subject_typestringSubject Type: user or enterprise.user

Streams​

Stream NamePrimary KeyPaginationSupports Full SyncSupports Incremental
eventsDefaultPaginator✅❌
sign_templatesidDefaultPaginator✅❌
collectionsidDefaultPaginator✅❌
collection_itemsidDefaultPaginator✅❌
sign_requestidDefaultPaginator✅❌
admin_logsevent_idDefaultPaginator✅❌
filesidDefaultPaginator✅❌
file_collaborationsidDefaultPaginator✅❌
file_commentsidDefaultPaginator✅❌
file_tasksidNo pagination✅❌
foldersidDefaultPaginator✅❌
folder_collaborationsidDefaultPaginator✅❌
recent_itemsidDefaultPaginator✅❌
trashed_itemsidDefaultPaginator✅❌
usersidDefaultPaginator✅❌

IP allow list​

If you use Airbyte Cloud and your organization restricts access to specific IPs, add the Airbyte Cloud IP addresses to your allow list.

Reference​

Config fields reference

Field
Type
Property name
OAuth Client ID
required
string
client_id
OAuth Client Secret
required
string
client_secret
number
user
string
box_subject_type

Changelog​

Expand to review
VersionDatePull RequestSubject
0.0.222026-10-0788216Add optional box_subject_type (user/enterprise) so the CCG token request can authenticate as the app Service Account; document Box app setup
0.0.212026-04-2176536Update dependencies
0.0.202025-05-2460665Update dependencies
0.0.192025-04-2658701Update dependencies
0.0.182025-04-1958259Update dependencies
0.0.172025-04-0557131Update dependencies
0.0.162025-03-2256147Update dependencies
0.0.152025-03-0855361Update dependencies
0.0.142025-03-0154833Update dependencies
0.0.132025-02-2254236Update dependencies
0.0.122025-02-1553877Update dependencies
0.0.112025-02-0853399Update dependencies
0.0.102025-02-0152888Update dependencies
0.0.92025-01-2552167Update dependencies
0.0.82025-01-1851757Update dependencies
0.0.72025-01-1151291Update dependencies
0.0.62024-12-2850497Update dependencies
0.0.52024-12-2150209Update dependencies
0.0.42024-12-1449580Update dependencies
0.0.32024-12-1249276Update dependencies
0.0.22024-12-1148933Starting with this version, the Docker image is now rootless. Please note that this and future versions will not be compatible with Airbyte versions earlier than 0.64
0.0.12024-10-24Initial release by @bishalbera via Connector Builder
Was this page helpful?