Docs
Get Drive
GET /drives/{eventId}
GET
/drives/{eventId}Required Tokens
| Field | Type | Required | Description |
|---|---|---|---|
| Bearer | Authorization: Bearer <api-key> | Optional | Your API key. Pass it as the Bearer token on every request. |
| Event token | x-Event-Token | Optional | Run **Get Tokens** in the Authorization folder, or call `GET /Events/{eventId}/authorize` manually. |
Returns the files and folders at a specific path within a partition. This is the primary endpoint for browsing the drive.
Paths are ID-based. The root is /. Navigate into folders by appending their ID: /{folderId}, then /{folderId}/{subfolderId}, etc. Use Get Folder Tree to discover folder paths without browsing manually.
Partitions determine which scoped section of the drive to browse. Pass the partition id from Get Partitions as partitionKey. If omitted, defaults to the event-level partition (same as passing the event ID).
Path Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| driveId | Guid | Required | The event ID. |
Query Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| partitionKey | Guid | Optional | The partition to browse. Pass a collaborator ID, area ID, or event ID. Defaults to the event-level partition when omitted. |
| path | string | Optional | The path to browse (e.g., `/`, `/{folderId}`, `/{folderId}/{subfolderId}`). Defaults to `/`. |
Response Fields
| Field | Type | Description |
|---|---|---|
| files | array | Files at the current path. See **Item Fields**. |
| folders | array | Folders at the current path. See **Item Fields**. |
| permissions | array | The current user's permissions at this path. |
| path | string | The path that was browsed. |
Item Fields
| Field | Type | Description |
|---|---|---|
| id | Guid | Unique ID. |
| type | string | `"File"`, `"Deliverable"`, or `"Folder"`. |
| name | string | Display name. |
| description | string | Optional description. |
| status | string| null | File status (`null` for folders). |
| path | string | Parent path. |
| fullPath | string | Full path including the item's own ID. |
| assignedToId | Guid | Collaborator ID assigned to deliverables (`Guid.Empty` for regular files). |
| dueDate | DateTime | Due date for deliverables. |
| permissions | array | Current user's permissions on this item. |
| associations | object | `collaborators`, `areas`, and `users` arrays, each with `id` and `name`. |
| versions | array | Version tags for files (e.g., `["Version 1"]`). Empty for folders. |
Error Codes
| Code | HTTP Status | Description |
|---|---|---|
UNAUTHORIZED | 401 | Missing or invalid token, or no access to the specified partition or path. |
NOT_FOUND | 404 | Drive not found. |