API Endpoints

Glean leverages the following endpoints of the Box API to crawl and index content. All connectivity is made through the Glean app available in the Box App Center.

Authentication Endpoints

Endpoint	Use Case	Documentation Link
Refresh access token `https://api.box.com/oauth2/token`	Refresh an Access Token using its client ID, secret, and refresh token.	Refresh access token - Box API

Endpoint	Use Case	Documentation Link
List enterprise users `https://api.box.com/2.0/users`	Determine which users (and associated content) need to be indexed.	List enterprise users - Box API
List groups for enterprise `https://api.box.com/2.0/groups`	Fetch all groups within a tenant (for permissions).	List groups for enterprise - Box API
List Enterprise Users `https://api.box.com/2.0//:group_id/memberships`	Determine which users are a member of which group (for permissions).	List members of group - Box API

Endpoint	Use Case	Documentation Link
List items in folder `https://api.box.com/2.0/folders/:folder_id/items`	List all items and content within a folder for indexing.	List items in folder - Box API
Get file information `https://api.box.com/2.0/files/:file_id`	Retrieve metadata for each specific item for indexing.	Get file information - Box API
List file collaborations `https://api.box.com/2.0/files/:file_id/collaborations`	Retrieve a list of all users with access to an item (for permissions).	List file collaborations - Box API
Download file `https://api.box.com/2.0/files/:file_id/content`	Fetch the contents of an item to index its body	Download file - Box API

Endpoint	Use Case	Documentation Link
List user and enterprise events `https://api.box.com/2.0/events`	Fetch activity data for each user for ranking signals (12 months limit).	List user and enterprise events - Box API