Reference
Saved views
Save the search, filters, and columns of a list the product already shows.
A saved view is a named state of a grid, such as the company list or the deal pipeline. It is not a record-page layout and not a dashboard.
| Method | Path | What it does |
|---|---|---|
| GET | /api/v1/x/views | Views for a viewType |
| GET | /api/v1/x/views/{id} | One view she can see. Anything else is 404 |
| POST | /api/v1/x/views | Create. You are the owner |
| PUT | /api/v1/x/views/{id} | Replace the name, config, and visibility |
| DELETE | /api/v1/x/views/{id} | Remove it |
viewType is required on the list. It is a list the product renders, such as companies or deals. Any other string is rejected.
The body:
nameis required, max 200.configis the search, filters, sort, column visibility, column order, and a tab when that list has tabs. A filter or column must be a field that list already shows, including a custom field. An unknown key is 400 and nothing is stored.configmay be a JSON object or a JSON string.visibilityisprivate,shared, orpublic.sharedtakessharedWithUserIds.publicneedsviews.share_public.
Saving a view does not change the list for anyone else, and it does not change the page’s default columns. A public view is a choice on the view menu.