API endpoints
Glean crawls and indexes Box content using the Box API endpoints below. All calls are read-only GET requests, except the OAuth token refresh.
Authentication
| Endpoint | Purpose | Reference |
|---|---|---|
POST /oauth2/token | Refresh the access token using the client ID, secret, and refresh token. | Refresh access token |
Identity
| Endpoint | Purpose | Reference |
|---|---|---|
GET /2.0/users | List enterprise users to determine which users and content to index. | List enterprise users |
GET /2.0/users/me | Get the authenticated service account's own user information. | Get current user |
GET /2.0/groups | List enterprise groups, used for permission modeling. | List groups for enterprise |
GET /2.0/groups/{group_id}/memberships | List the members of a group, used for permission modeling. | List members of group |
Content
| Endpoint | Purpose | Reference |
|---|---|---|
GET /2.0/folders/{folder_id} | Get folder metadata. | Get folder information |
GET /2.0/folders/{folder_id}/items | List the items within a folder for indexing. | List items in folder |
GET /2.0/folders/{folder_id}/collaborations | List a folder's collaborations, used for permission modeling. | List folder collaborations |
GET /2.0/files/{file_id} | Get file metadata. | Get file information |
GET /2.0/files/{file_id}/content | Download file content for indexing. | Download file |
GET /2.0/files/{file_id}/collaborations | List a file's collaborations, used for permission modeling. | List file collaborations |
GET /2.0/search | Locate content and folders by query. | Search for content |
GET /2.0/shared_items | Resolve a shared item from its shared link. | Get shared item |
Activity
| Endpoint | Purpose | Reference |
|---|---|---|
GET /2.0/events | Fetch enterprise and user events to keep content and permissions fresh. | List enterprise events |