Skip to content

Get request writeback

GET /api/v1/writeback/requests/{requestId}: request fields and declared response contract.

GET/api/v1/writeback/requests/{requestId}

Authorization
Permissionwriteback.read
Workspace scoperequired
Scope targetworkspace

Parameters

Path parameters
FieldTypeRequiredNullableDefault
requestIdstringrequirednon-null—

Query parameters: none.

Response

200

Response fields
FieldTypeRequiredNullableDefault
dataunknownrequirednon-null—

Declared failures

Declared failures
WRITEBACK_GET_REQUEST_FAILED500 — retryable

Readback

This method returns the current state it read.

  • writeback.getRequest

Request example

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

GET /api/v1/writeback/requests/{requestId} HTTP/1.1
Authorization: Bearer <token>
x-merulan-workspace-id: <workspace-id>