Skip to main content
Get a shared View

Authorizations

Authorization
string
header
required

Personal API key sent as a bearer token, together with X-Organization-Id. The key must have at least the access level the endpoint requires (read, write or admin).

Headers

X-Organization-Id
string

The organization to act in. Required for personal API keys; list the organizations you can access with GET /v1/organizations.

Path Parameters

id
string<uuid>
required

Query Parameters

fields
string[]

Return only these fields; use dots for nested fields, such as references.id. id is always returned. Fields: id, name, references, filter, filter_restricted, created_at, updated_at.

Response

The View with its saved filter.

id
string<uuid>
required
name
string
required
references
object[]
required
filter
any
required

A saved View filter, returned as stored for unrestricted callers; it may be null or no longer valid. A restricted caller receives null with filter_restricted=true when the definition contains unavailable references or cannot be safely read. To replace it, send a filter in the shape the View create and update requests accept.

created_at
string<date-time>
required
updated_at
string<date-time>
required
filter_restricted
boolean

True when the saved filter is withheld because of current access. The stored filter still applies; null does not mean the View is empty.