References
Operations of the Workflow Engine API. Paths are relative to your deployment's API host.
GET /api/workflow-engine-api/references/by-target
Inbound query: which workflow versions reference a target?
Studio "Used by" surface. Returns every workflow version (in the caller's scope: system + own org) whose parsed AST references the target (kind, slug, version). When version is omitted, every consumer of the slug is returned regardless of which version they pinned. When version is set, consumers that pinned the exact version OR that left version unspecified (latest-active resolution) are both returned. The result joins the consuming workflow row for slug/title so the panel can render clickable rows.
Authentication: bearer token (Authorization: Bearer <token>)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
kind | query | ReferenceKind | yes | |
projectId | query | string | no | The Project the request is in. Admitted by a project#xema_read decision (403 when refused). A workflow contributed by a biome installed in a Project is visible only when its Project is named here; without it, or for another Project, it is not found. |
slug | query | string | yes | |
version | query | string | no |
| Status | Description | Body |
|---|---|---|
| 200 | application/json ReferenceConsumersResponseDtoDataEnvelope | |
| 400 | application/problem+json ProblemDetailsDto | |
| 401 | application/problem+json ProblemDetailsDto | |
| 403 | application/problem+json ProblemDetailsDto | |
| 404 | application/problem+json ProblemDetailsDto | |
| 409 | application/problem+json ProblemDetailsDto | |
| 422 | application/problem+json ProblemDetailsDto | |
| 500 | application/problem+json ProblemDetailsDto |
GET /api/workflow-engine-api/workflows/{slug}/revisions/{revisionNumber}/references
Outbound references emitted by a workflow revision's parsed AST.
Returns one row per (refKind, refSlug, refVersion, sourcePath) the workflow points at — deliverable specs, workspace manifests, agents, action manifests, and reusable workflows discovered by walking jobs[*].uses and jobs[*].with.*. Expression refs (\${{ ... }}) are NOT indexed since they resolve at run time from trigger inputs or upstream outputs. Drives the Studio Related panel's 'this workflow uses…' surface; inverse used-by queries land in a sibling endpoint on each owner service.
Authentication: bearer token (Authorization: Bearer <token>)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
revisionNumber | path | number | yes | |
slug | path | string | yes | |
projectId | query | string | no | The Project the request is in. Admitted by a project#xema_read decision (403 when refused). A workflow contributed by a biome installed in a Project is visible only when its Project is named here; without it, or for another Project, it is not found. |
| Status | Description | Body |
|---|---|---|
| 200 | application/json WorkflowReferencesResponseDtoDataEnvelope | |
| 400 | application/problem+json ProblemDetailsDto | |
| 401 | application/problem+json ProblemDetailsDto | |
| 403 | application/problem+json ProblemDetailsDto | |
| 404 | application/problem+json ProblemDetailsDto | |
| 409 | application/problem+json ProblemDetailsDto | |
| 422 | application/problem+json ProblemDetailsDto | |
| 500 | application/problem+json ProblemDetailsDto |