Skip to main content
POST
/
api
/
saved-views
/
v1
/
list
List
curl --request POST \
  --url https://developer.synq.io/api/saved-views/v1/list \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "scopes": [],
  "onlyPinned": true,
  "pagination": {
    "cursor": "<string>",
    "pageSize": 1
  }
}
'
{
  "views": [
    {
      "workspace": "<string>",
      "id": "<string>",
      "title": "<string>",
      "description": "<string>",
      "selection": {
        "entityQuery": {
          "resolverQl": "<string>",
          "renderedResolverQl": "<string>",
          "publicQuery": {
            "parts": [
              {
                "identifierList": {
                  "identifiers": [
                    {
                      "airflowDag": {
                        "integrationId": "<string>",
                        "dagId": "<string>"
                      }
                    }
                  ]
                }
              }
            ]
          }
        }
      },
      "config": {
        "cardFields": [
          "<string>"
        ]
      },
      "grants": [
        {
          "granteeIdentity": "<string>"
        }
      ],
      "owner": {
        "name": "<string>",
        "email": {
          "userEmail": "jsmith@example.com"
        }
      },
      "updatedBy": {
        "name": "<string>",
        "email": {
          "userEmail": "jsmith@example.com"
        }
      },
      "permissions": {
        "canEdit": true,
        "canDelete": true,
        "canManageGrants": true
      },
      "pinned": true,
      "etag": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "pageInfo": {
    "totalCount": 123,
    "count": 123,
    "lastId": "<string>"
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
scopes
enum<string>[]

Relationship buckets to include. Empty returns every view the caller can see. For example [SAVED_VIEW_RELATIONSHIP_MINE] returns only the caller's own views.

How a returned saved view relates to the calling user. Output-only: computed per request from the view's owner, visibility and grants against the caller's identity. Clients group their "views" UI by this value.

Available options:
SAVED_VIEW_RELATIONSHIP_UNSPECIFIED,
SAVED_VIEW_RELATIONSHIP_MINE,
SAVED_VIEW_RELATIONSHIP_WORKSPACE,
SAVED_VIEW_RELATIONSHIP_SHARED_TO_WORKSPACE,
SAVED_VIEW_RELATIONSHIP_SHARED_TO_ME
context
enum<string> | null

Restrict to a single surface. Omit to return views for all contexts.

Available options:
SAVED_VIEW_CONTEXT_UNSPECIFIED,
SAVED_VIEW_CONTEXT_CHECKS,
SAVED_VIEW_CONTEXT_ISSUES
onlyPinned
boolean | null

Restrict to views the caller has pinned.

pagination
Pagination · object

Pagination.

Response

200 - application/json

Success

views
SavedView · object[]

The matching views.

pageInfo
PageInfo · object

Pagination cursor for the next page.