Docs

Get View

GET /views/{viewId}

GET/views/{viewId}

Required Tokens

FieldTypeRequiredDescription
BearerAuthorization: Bearer <api-key>OptionalYour API key. Pass it as the Bearer token on every request.

Returns a single view by ID.

Requesting another user's private view returns 404, indistinguishable from a view that does not exist. The same is true of PUT and DELETE, so no verb confirms whether a given id belongs to someone else.

Path Parameters

FieldTypeRequiredDescription
viewIdGuidRequiredThe ID of the view to retrieve. Replace `{{viewId}}` in the URL.

Response

FieldTypeDescription
idGuidView ID.
namestringDisplay name.
indexintSort order.
entityIdGuidThe entity this view belongs to.
tableIdstringThe table this view applies to.
isDefaultboolWhether this is the default view for the table.
configurationstringSerialized view configuration (JSON string).
isPrivatebool`true` when the view belongs privately to the calling user. Derived — the owner's user id is never exposed.