---
title: "listSavedViews"
method: GET
path: "/v1/entity/views"
tags: ["Saved Views"]
---

# listSavedViews

`GET /v1/entity/views`

Get the Saved Views based on the schema

## Query parameters

- `slug` string — URL-friendly identifier for the entity schema
- `sort` string
- `from` integer
- `size` integer
- `q` string
- `fields` string[] — List of entity fields to include or exclude in the response Use ! to exclude fields, e.g. `!_id` to exclude the `_id` field. Globbing and globstart (**) is supported for nested fields.

## Response `200`

Success

- ListSavedViewsResults
  - `hits` number
  - `results` SavedViewItem[]
    - `id` string, uuid — Generated uuid for a saved view
    - `created_at` string
    - `updated_at` string
    - `slug` EntitySlug[], required — list of schemas a view can belong to
    - `name` string, required — User-friendly identifier for the saved view
    - `org` string — Organisation ID a view belongs to
    - `shared` boolean — boolean property for if a view is shared with organisation
    - `isFavoritedBy` string[] — List of users (IDs) that have favorited the view
    - `created_by` union
      - object — A user that created the view
        - `user_id` string
        - `org_id` string — The organization ID of the user who created the view. Used for partner access control.
      - object — A system-created view
        - `source` 'SYSTEM' | 'BLUEPRINT'
    - `ui_config` object, required
    - `shared_with` string[] — List of users ('${userId}'), user groups ('group_${groupId}'), or partner users ('${partnerOrgId}_${partnerUserId}') that the view is shared with

---

[API](https://skmtc.net/epilot/apis/entity-api.md) · [All operations](https://skmtc.net/epilot/apis/entity-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/epilot/entity-api/revisions/3020984570dc/schema)