Skip to content

Read canvas triggers

GET /api/v1/laboratory/canvas-triggers/{id}: request fields and declared response contract.

GET/api/v1/laboratory/canvas-triggers/{id}

Authorization
PropertyValue
Permissionlab.read
Workspace scoperequired
Scope targetworkspace

Parameters

Path parameters
FieldTypeRequiredNullableDefault
idstringrequirednon-null—

Query parameters: none.

Response

200

Response fields
FieldTypeRequiredNullableDefault
dataobjectrequirednon-null—
data.idstringrequirednon-null—
data.generationintegerrequirednon-null—
data.status"active" | "paused" | "revoked"requirednon-null—
data.definitionobjectrequirednon-null—
data.definition.companyIdstringrequirednon-null—
data.definition.workspaceIdstringrequirednon-null—
data.definition.actorMemberIdstringrequirednon-null—
data.definition.targetunknownrequirednon-null—
data.definition.sourceunknownrequirednon-null—
data.lastDeliveryobjectoptionalnon-null—
data.lastDelivery.scheduledAtstringrequirednon-null—
data.lastDelivery.outcome"accepted" | "expired"requirednon-null—
data.lastDelivery.reasonstringoptionalnon-null—

Declared failures

Declared failures
PropertyValue
ACCESS_DENIED403 — not retryable
CORE_ERROR500 — not retryable
GOVERNANCE_DENIED403 — not retryable
NOT_FOUND404 — not retryable
SETUP_REQUIRED503 — not retryable
VALIDATION_ERROR400 — not retryable
VALIDATION_INPUT_ERROR400 — not retryable

Readback

This method returns the current state it read.

  • laboratory.canvasTriggers.read

Request example

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

GET /api/v1/laboratory/canvas-triggers/{id} HTTP/1.1
Authorization: Bearer <token>
x-merulan-workspace-id: <workspace-id>