Skip to content
Merulan

List surface views

GET /api/v1/surface-views: request fields and declared response contract.

GET/api/v1/surface-views

Authorization
PropertyValue
Permissionsettings.read
Workspace scoperequired
Scope targetworkspace

Parameters

Path parameters: none.

Query parameters
FieldTypeRequiredNullableDefault
targetunknownoptionalnon-null—

Response

200

Response fields
FieldTypeRequiredNullableDefault
dataarrayrequirednon-null—

Declared failures

Declared failures
PropertyValue
SAVED_SURFACE_VIEW_INVALID400 — not retryable
SAVED_SURFACE_VIEW_NOT_FOUND404 — not retryable
SAVED_SURFACE_VIEW_STORE_FAILED503 — retryable

Readback

This method returns the current state it read.

  • savedSurfaceViews.listScoped

Request example

Schematic only. Replace placeholders with real values and include all required nested fields.

GET /api/v1/surface-views HTTP/1.1
Authorization: Bearer <token>
x-merulan-workspace-id: <workspace-id>