> For the complete documentation index, see [llms.txt](https://academy.shade.inc/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://academy.shade.inc/developers/organize/views.md).

# Views

Views are saved searches: a set of filters, a sort order, and display settings that stay up to date as files change.

## Get the dynamic views for a drive

> Get the dynamic views for a drive

```json
{"openapi":"3.1.0","info":{"title":"Shade API","version":"dev"},"tags":[{"name":"views","description":"Views are saved searches: a set of filters, a sort order, and display\nsettings that stay up to date as files change."}],"servers":[{"url":"https://api.shade.inc","description":"Production"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"apiKey","in":"header","name":"Authorization","description":"Your Shade API key, sent as-is with no `Bearer` prefix. Create one under\n**Settings → Integrate → API keys**.\n"}},"schemas":{"DynamicView":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"name":{"type":"string","title":"Name"},"filters":{"anyOf":[{"items":{"$ref":"#/components/schemas/AddedFilterForStorage"},"type":"array"},{"type":"null"}],"title":"Filters"},"columns":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Columns"},"user_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"User Id"},"is_locked":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Locked"},"is_private":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Private"},"display_settings":{"anyOf":[{"$ref":"#/components/schemas/DynamicViewDisplaySettings"},{"type":"null"}]},"icon":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Icon"},"icon_type":{"anyOf":[{"$ref":"#/components/schemas/DynamicViewIconType"},{"type":"null"}]},"sort":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sort"}},"type":"object","required":["id","name"],"title":"DynamicView"},"AddedFilterForStorage":{"properties":{"id":{"title":"Id"},"options":{"items":{"$ref":"#/components/schemas/FilterOption"},"type":"array","title":"Options"},"clause":{"$ref":"#/components/schemas/FilterClauseVal"},"ignore_options":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Ignore Options"}},"type":"object","required":["id","options","clause"],"title":"AddedFilterForStorage"},"FilterOption":{"properties":{"client_val":{"type":"string","title":"Client Val"},"server_val":{"type":"string","title":"Server Val"},"icon":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Icon"}},"type":"object","required":["client_val","server_val"],"title":"FilterOption"},"FilterClauseVal":{"type":"string","enum":["is","is any of","is not","is true","is false","is not true","is not false","has","doesn't have","before","after","between","is directly in","is under","is not in","<","< any of","<=","<= any of",">","> any of",">=",">= any of","hasn't started","in progress of","completed","failed","includes","does not include","contains","does not contain","does not start with","starts with","end with","is empty","is not empty"],"title":"FilterClauseVal","description":"Filter Clause Values Enum. Contains all filter clause values"},"DynamicViewDisplaySettings":{"properties":{"card_size":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Card Size"},"thumbnail_view":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Thumbnail View"},"thumbnail_size":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Thumbnail Size"},"view":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"View"},"metadata_attribute_ids":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Metadata Attribute Ids"},"flatten_directories":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Flatten Directories"},"tile_rounded":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Tile Rounded"}},"type":"object","title":"DynamicViewDisplaySettings"},"DynamicViewIconType":{"type":"string","enum":["color","emoji","url"],"title":"DynamicViewIconType"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}},"paths":{"/dynamic-views":{"get":{"tags":["views"],"summary":"Get the dynamic views for a drive","description":"Get the dynamic views for a drive","operationId":"listViews","parameters":[{"name":"drive_id","in":"query","required":true,"schema":{"type":"string","format":"uuid","title":"The drive id"},"description":"ID of the drive. List a workspace's drives with `GET /workspaces/{workspace_id}/drives`."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DynamicView"}}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}}
```

## POST /dynamic-views

> Add a dynamic view for a drive

```json
{"openapi":"3.1.0","info":{"title":"Shade API","version":"dev"},"tags":[{"name":"views","description":"Views are saved searches: a set of filters, a sort order, and display\nsettings that stay up to date as files change."}],"servers":[{"url":"https://api.shade.inc","description":"Production"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"apiKey","in":"header","name":"Authorization","description":"Your Shade API key, sent as-is with no `Bearer` prefix. Create one under\n**Settings → Integrate → API keys**.\n"}},"schemas":{"CreateViewRequest":{"properties":{"name":{"type":"string","title":"The dynamic view name","description":"The dynamic view name to update"},"display_settings":{"anyOf":[{"$ref":"#/components/schemas/DynamicViewDisplaySettings"},{"type":"null"}],"title":"The dynamic view display settings","description":"The dynamic view display settings to update"},"icon":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"The dynamic view icon","description":"The dynamic view icon to update"},"icon_type":{"anyOf":[{"$ref":"#/components/schemas/DynamicViewIconType"},{"type":"null"}],"title":"The dynamic view icon type","description":"The dynamic view icon type to update"},"is_locked":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Whether the dynamic view is locked","description":"If locked, other users cannot modify the dynamic view.","default":false},"is_private":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Whether the dynamic view is private","description":"If private, only the owner can see this dynamic view.","default":false},"filters":{"anyOf":[{"items":{"$ref":"#/components/schemas/AddedFilterForStorage"},"type":"array"},{"type":"null"}],"title":"The dynamic view filters","description":"The dynamic view filters to update","default":[]},"sort":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"The dynamic view sort","description":"The dynamic view sort to update (include '-' at beginning for descending)"}},"type":"object","required":["name"],"title":"CreateViewRequest"},"DynamicViewDisplaySettings":{"properties":{"card_size":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Card Size"},"thumbnail_view":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Thumbnail View"},"thumbnail_size":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Thumbnail Size"},"view":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"View"},"metadata_attribute_ids":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Metadata Attribute Ids"},"flatten_directories":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Flatten Directories"},"tile_rounded":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Tile Rounded"}},"type":"object","title":"DynamicViewDisplaySettings"},"DynamicViewIconType":{"type":"string","enum":["color","emoji","url"],"title":"DynamicViewIconType"},"AddedFilterForStorage":{"properties":{"id":{"title":"Id"},"options":{"items":{"$ref":"#/components/schemas/FilterOption"},"type":"array","title":"Options"},"clause":{"$ref":"#/components/schemas/FilterClauseVal"},"ignore_options":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Ignore Options"}},"type":"object","required":["id","options","clause"],"title":"AddedFilterForStorage"},"FilterOption":{"properties":{"client_val":{"type":"string","title":"Client Val"},"server_val":{"type":"string","title":"Server Val"},"icon":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Icon"}},"type":"object","required":["client_val","server_val"],"title":"FilterOption"},"FilterClauseVal":{"type":"string","enum":["is","is any of","is not","is true","is false","is not true","is not false","has","doesn't have","before","after","between","is directly in","is under","is not in","<","< any of","<=","<= any of",">","> any of",">=",">= any of","hasn't started","in progress of","completed","failed","includes","does not include","contains","does not contain","does not start with","starts with","end with","is empty","is not empty"],"title":"FilterClauseVal","description":"Filter Clause Values Enum. Contains all filter clause values"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}},"paths":{"/dynamic-views":{"post":{"tags":["views"],"summary":"Add a dynamic view for a drive","operationId":"createView","parameters":[{"name":"drive_id","in":"query","required":true,"schema":{"type":"string","format":"uuid","title":"The drive id"},"description":"ID of the drive. List a workspace's drives with `GET /workspaces/{workspace_id}/drives`."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateViewRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}}
```

## Update a dynamic view for a drive

> Modify a dynamic view for a drive

```json
{"openapi":"3.1.0","info":{"title":"Shade API","version":"dev"},"tags":[{"name":"views","description":"Views are saved searches: a set of filters, a sort order, and display\nsettings that stay up to date as files change."}],"servers":[{"url":"https://api.shade.inc","description":"Production"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"apiKey","in":"header","name":"Authorization","description":"Your Shade API key, sent as-is with no `Bearer` prefix. Create one under\n**Settings → Integrate → API keys**.\n"}},"schemas":{"UpdateViewRequest":{"properties":{"name":{"type":"string","title":"The dynamic view name","description":"The dynamic view name to update"},"filters":{"items":{"$ref":"#/components/schemas/AddedFilterForStorage"},"type":"array","title":"The dynamic view filters","description":"The dynamic view filters to update"},"columns":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"The dynamic view columns","description":"The dynamic view columns to update"},"display_settings":{"anyOf":[{"$ref":"#/components/schemas/DynamicViewDisplaySettings"},{"type":"null"}],"title":"The dynamic view display settings","description":"The dynamic view display settings to update"},"icon":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"The dynamic view icon","description":"The dynamic view icon to update"},"icon_type":{"anyOf":[{"$ref":"#/components/schemas/DynamicViewIconType"},{"type":"null"}],"title":"The dynamic view icon type","description":"The dynamic view icon type to update"},"sort":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"The dynamic view sort","description":"The dynamic view sort to update (include '-' at beginning for descending)"},"is_locked":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Whether the dynamic view is locked","description":"If locked, other users cannot modify the dynamic view.","default":false},"is_private":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Whether the dynamic view is private","description":"If private, only the owner can see this dynamic view.","default":false}},"type":"object","required":["name","filters"],"title":"UpdateViewRequest"},"AddedFilterForStorage":{"properties":{"id":{"title":"Id"},"options":{"items":{"$ref":"#/components/schemas/FilterOption"},"type":"array","title":"Options"},"clause":{"$ref":"#/components/schemas/FilterClauseVal"},"ignore_options":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Ignore Options"}},"type":"object","required":["id","options","clause"],"title":"AddedFilterForStorage"},"FilterOption":{"properties":{"client_val":{"type":"string","title":"Client Val"},"server_val":{"type":"string","title":"Server Val"},"icon":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Icon"}},"type":"object","required":["client_val","server_val"],"title":"FilterOption"},"FilterClauseVal":{"type":"string","enum":["is","is any of","is not","is true","is false","is not true","is not false","has","doesn't have","before","after","between","is directly in","is under","is not in","<","< any of","<=","<= any of",">","> any of",">=",">= any of","hasn't started","in progress of","completed","failed","includes","does not include","contains","does not contain","does not start with","starts with","end with","is empty","is not empty"],"title":"FilterClauseVal","description":"Filter Clause Values Enum. Contains all filter clause values"},"DynamicViewDisplaySettings":{"properties":{"card_size":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Card Size"},"thumbnail_view":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Thumbnail View"},"thumbnail_size":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Thumbnail Size"},"view":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"View"},"metadata_attribute_ids":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Metadata Attribute Ids"},"flatten_directories":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Flatten Directories"},"tile_rounded":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Tile Rounded"}},"type":"object","title":"DynamicViewDisplaySettings"},"DynamicViewIconType":{"type":"string","enum":["color","emoji","url"],"title":"DynamicViewIconType"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}},"paths":{"/dynamic-views/{dynamic_view_id}":{"put":{"tags":["views"],"summary":"Update a dynamic view for a drive","description":"Modify a dynamic view for a drive","operationId":"updateView","parameters":[{"name":"dynamic_view_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"The dynamic view id"}},{"name":"drive_id","in":"query","required":true,"schema":{"type":"string","format":"uuid","title":"The drive id"},"description":"ID of the drive. List a workspace's drives with `GET /workspaces/{workspace_id}/drives`."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateViewRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"null"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}}
```

## DELETE /dynamic-views/{dynamic\_view\_id}

> Delete Dynamic View Route

```json
{"openapi":"3.1.0","info":{"title":"Shade API","version":"dev"},"tags":[{"name":"views","description":"Views are saved searches: a set of filters, a sort order, and display\nsettings that stay up to date as files change."}],"servers":[{"url":"https://api.shade.inc","description":"Production"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"apiKey","in":"header","name":"Authorization","description":"Your Shade API key, sent as-is with no `Bearer` prefix. Create one under\n**Settings → Integrate → API keys**.\n"}},"schemas":{"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}},"paths":{"/dynamic-views/{dynamic_view_id}":{"delete":{"tags":["views"],"summary":"Delete Dynamic View Route","operationId":"deleteView","parameters":[{"name":"dynamic_view_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"The dynamic view id"}},{"name":"drive_id","in":"query","required":true,"schema":{"type":"string","format":"uuid","title":"The drive id"},"description":"ID of the drive. List a workspace's drives with `GET /workspaces/{workspace_id}/drives`."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"null"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}}
```

## GET /dynamic-views/{dynamic\_view\_id}/exports/{export\_format}

> Export dynamic view data

```json
{"openapi":"3.1.0","info":{"title":"Shade API","version":"dev"},"tags":[{"name":"views","description":"Views are saved searches: a set of filters, a sort order, and display\nsettings that stay up to date as files change."}],"servers":[{"url":"https://api.shade.inc","description":"Production"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"apiKey","in":"header","name":"Authorization","description":"Your Shade API key, sent as-is with no `Bearer` prefix. Create one under\n**Settings → Integrate → API keys**.\n"}},"schemas":{"ExportFormat":{"type":"string","enum":["csv","tsv","txt","ale","premiere","davinci","avid"],"title":"ExportFormat"},"OperatingSystem":{"type":"string","enum":["Windows","Linux","Debian","Fedora","Darwin"],"title":"OperatingSystem","description":"Operating System Enum from the result of platform.system()"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}},"paths":{"/dynamic-views/{dynamic_view_id}/exports/{export_format}":{"get":{"tags":["views"],"summary":"Export dynamic view data","operationId":"exportView","parameters":[{"name":"dynamic_view_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"The dynamic view id"}},{"name":"export_format","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ExportFormat","title":"The format"}},{"name":"drive_id","in":"query","required":true,"schema":{"type":"string","format":"uuid","title":"The drive id"},"description":"ID of the drive. List a workspace's drives with `GET /workspaces/{workspace_id}/drives`."},{"name":"os","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/OperatingSystem"},{"type":"null"}],"title":"The os to be exported to"}},{"name":"timezone","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"The timezone to be exported to (ex: 'America/New_York')"}}],"responses":{"200":{"description":"Successful Response","content":{"application/octet-stream":{"schema":{"type":"string"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://academy.shade.inc/developers/organize/views.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
