Skip to content

Get saved queries

GET /api/v1/saved-queries/{savedQueryId}: request fields and declared response contract.

GET/api/v1/saved-queries/{savedQueryId}

Authorization
Permissionsaved-query.read
Workspace scoperequired
Scope targetworkspace

Parameters

Path parameters
FieldTypeRequiredNullableDefault
savedQueryIdstringrequirednon-null—

Query parameters: none.

Response

200

Response fields
FieldTypeRequiredNullableDefault
dataobjectrequirednon-null—
data.idstringrequirednon-null—
data.definitionVersionunknownrequirednon-null—
data.revisionintegerrequirednon-null—
data.keystringrequirednon-null—
data.titlestringrequirednon-null—
data.descriptionstringoptionalnon-null—
data.kindstringrequirednon-null—
data.targetunknownrequirednon-null—
data.whereunknownoptionalnon-null—
data.compositeunknownoptionalnon-null—
data.sortarrayoptionalnon-null—
data.defaultLimitintegeroptionalnon-null—
data.tagsarrayrequirednon-null—
data.sourceobjectrequirednon-null—
data.source.kindstringrequirednon-null—
data.source.ownerTier"workspace" | "workspaceBlueprint" | "templateInstallation"requirednon-null—
data.source.sourceRefunknownoptionalnon-null—
data.source.packageKeystringoptionalnon-null—
data.source.namespacestringoptionalnon-null—
data.source.packageVersionstringoptionalnon-null—
data.source.sourceHashstringoptionalnon-null—
data.source.constructKeystringoptionalnon-null—
data.source.sourcePayloadunknownoptionalnon-null—
data.createdAtstringoptionalnon-null—
data.updatedAtstringoptionalnon-null—

Declared failures

Declared failures
SAVED_QUERY_NOT_FOUND404 — not retryable

Readback

This method returns the current state it read.

  • savedQueries.get

Request example

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

GET /api/v1/saved-queries/{savedQueryId} HTTP/1.1
Authorization: Bearer <token>
x-merulan-workspace-id: <workspace-id>