v4

latestOpenAPI 3.0.22026-07-3188146256.6 KB

Saved Views

listSavedViews

Get the Saved Views based on the schema

get/v1/entity/views

Query parameters

slugstring

URL-friendly identifier for the entity schema

Example:contact

Return views belonging to this schema

sortstring

The sort key to use if present

frominteger

sizeinteger

Number of saved views to return

qstring

Free-text search on the saved view name (case-insensitive)

fieldsstring[]

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.

[
  "_id",
  "_title",
  "first_name",
  "account",
  "!account.*._files",
  "**._product"
]

Response

Success

hitsnumber

Example response

{
  "hits": 1,
  "results": [
    {
      "slug": [
        "contact"
      ],
      "name": "View listing German",
      "org": "66",
      "shared": true,
      "isFavoritedBy": [
        "11701"
      ],
      "created_by": {
        "user_id": "10598",
        "org_id": "739224"
      },
      "ui_config": {
        "filters": {
          "customer_name": "suresh test",
          "_tags": "360"
        },
        "table_layout": {
          "opportunity": {
            "page": 1,
            "sort": "_created_at:desc",
            "pageSize": 25,
            "columnSettings": []
          }
        }
      },
      "shared_with": [
        "112233"
      ]
    }
  ]
}