Get a workflow schema by ref

Resolves a registered workflow schema reference (URL-encoded) to its JSON Schema document.

RBAC · workflow

Path parameters

schemaRefstringRequired

Registered schema reference; URL-encode it in the path.

Response body

Success response 200 · schema WorkflowSchemaResponse

refstringRequired

The resolved schema reference.

schemaobjectRequired

A JSON Schema document.

Response codes

200

Resolved schema.

400

Invalid request.

401

API key missing/invalid.

403

Caller lacks the required permission.

404

Unknown schema ref.

500

Unexpected error.

GET /api/workflow/registry/schemas/{schemaRef}

cURL

curl -X GET "https://algapsa.com/api/workflow/registry/schemas/{schemaRef}" \
  -H "X-API-Key: $ALGA_API_KEY"

TypeScript

const response = await fetch("https://algapsa.com/api/workflow/registry/schemas/{schemaRef}", {
  method: "GET",
  headers: {
    "X-API-Key": "$ALGA_API_KEY",
  }
});
const data = await response.json();

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Get, "https://algapsa.com/api/workflow/registry/schemas/{schemaRef}");
request.Headers.TryAddWithoutValidation("X-API-Key", "$ALGA_API_KEY");
var response = await client.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();

200 OK·application/json

{
  "ref": "string",
  "schema": {}
}