NUnullplatform
Workflow aliases

Read an alias

Changed on

Returns one alias with its trigger states.

get/workflows/definitions/{id}/aliases/{alias}

Request

  • Base URL
    https://api.nullplatform.com
  • URL
    https://api.nullplatform.com/workflows/definitions/{id}/aliases/{alias}
  • Auth
    HTTP bearer

Path parameters

idstring required

Workflow reference: a server-minted id (wf_...) or the workflow's client-chosen key (lowercase slug, unique per organization).

aliasstring required

The alias name. latest is reserved and auto-maintained.

Response

The alias.

workflowIdstring required
namestring required
revisioninteger required
activeboolean required

Whether the alias's triggers are activated.

updatedAtstring date-time required
updatedBystring
metadataobject
triggerStatesobject

Map of trigger id to its activation state.

Example response

{
  "workflowId": "wf_ifWBbWfpug0n",
  "name": "live",
  "revision": 3
}

Changes