---
id: workflow-alias-list
title: List aliases
description: >-
  Lists the workflow's aliases with per-trigger activation state. Webhook URLs
  in `triggerStates` are recomputed on each read.
sidebar_label: List aliases
hide_title: true
hide_table_of_contents: true
api: >-
  eJztWN9v2zYQ/lcOfEmCybK3Zeigt7RohwxtEaQJUqAIalo8WWwoUiEpO56h/304Uv6tOFhf1ofmJbZ4FL+777vjnZfM86lj2Rd2Z+xDocwcuJLcoWP3CRPocitrL41mGXsvnXfgS4R5Z3viVtYwl76EGu3AWzmdogWeeznjtBWc5x5TuMNJacwD3F6/dyA1jDvTT7TsxsAtgsXcVHXjUYDRgDwvwSIXKUuYqdGG910KlrEVhEEAkCnpPEtYzS2v0KMll5ZMEuya+5IlTPMKWcakYAmz+NhIi4Jl3jaYMJeXWHGWLZlf1GTlvJV6ytr9EKyDZLFAizrHDDg4tDO0g0pqwi0FnI7nxdc0TcdnYOx+xHIlUftBXhqHGh5wAafKzNHm3CE41UwTaLR8bJDCCcZOuZb/BMfPKAz4xKtaEch58VUWd68nd0XdTEeatfcJc5g3VvpFcH+C3KK9aHzJsi/3tGzR1UYTu9mS/TYa0b9dD2966aWDc6M9ak9beF0rmQdMw2+O9i0PY2gm3zAPpFiizst4quB+24pbyxcsYdJjFda99MG7CzqZJQdv23D3ZS2CS7EimNZn0pEvCQsSpGdNLbhHceFJ1Ltwtl5xQP/RYK8UdWyTouPbLUwba9LKFO22+e/tGvLGbmKMQk7e7CmxRF9iFFcg6cRBl08uZFKXfyhSQrCJQA/gwtiKe5YRNzjwssKtLa8XvXlRoed7VHYUtQnbSew+Sez68oHXYIoVfEogb0B6d1hDiFQhJD3h6mqHyJVubrbO7pHPLvv01sb1kqibiiRWoxbxiYpaKrhUSHqTuiPrfsXbf42wwO/aprjzb6019uVkq9A5Pu1RaUv5LPoWWtJro+mwD89yvM/gddwAZA2uyUvg8aboOD1xMJ7H8n9r1Tg9ALpZ7IP0HOtUvdutv4Sdf/58WNPehIoLSDFLgSrcxIgFOL5wMC+5hzktz63R0wy4joYwJhTjBDiUTcX1gO4hPlEIY4GeS0VLWiR0T824kiLqlOTRWHT0HAG1t4tYx4siKgkKiUocKai1NROF1S89hbWT+FW06FH3YS13nmvBreicCo6fXr97A6/+HL2C7iyIHrkkXmWC2Bs/h2l8dkhfxHEo4F08QbRANnB7fZkAptMUxqX3tcuGw/WN7hbOY5UKnA0DaLdZ0sYPCtNoMd69Cr/rHaFSxZAeK+IfjYe1/UHB6Knj56PzkNwU0pdevb5rYwMlBexdNIBP1HbR2VITmfkLcNeOuqHAQuqQNm7Yc3/FwPTcxbusXVl0lB/9Os9e1vnmaj9aq0Kfdtw157F2Q5dzPcyNLmR3Ez1T47a3Vo3zUPIZdZixf4Du9AWcUCU8YVtV5I++KnKr8anGnFq82PB1BeVnJv/M5J+Z/ENmcuxTS0MD4xTjgEjQngvtUop2uJp/aZiiNI+jZEOdyVqdvJapbpSqFffUpKW5qXbmr0+U6jEa21PY2jF6EesGz9DmByOWdB/erRq/v+9uQv8jdWFoO+GJZP6ajtIRW+uefdyCAxdXlxTQ2jhf8VB7uvGXZnjYeLijj+Wmjv3fs34XJY9PflgrLoPKm9gcRgo3w1/0Y00iS1gWhvyt3zFK4zxtWS4n3OGtVW1Ljx8btDQp3ydsxq2k5i5wLaSjz4JlBVcOj4Tp9LrT4Bn8AD8N9EZtVRE01YMZVw19Ywl7wEX8OaSl+aVELtAG7+PCRZ5j7be2HMz8JPd1dv319oZCvivyPVGHt/fCWS6jxY15QN22a3SevhPAtv0XH/yJkw==
sidebar_class_name: get api-method
info_path: docs/api/nullplatform-api
custom_edit_url: null
canonical: 'https://docs.nullplatform.com/docs/api/workflow-alias-list'
---
<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"List aliases"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/workflows/definitions/{id}/aliases"}
  context={"endpoint"}
>

</MethodEndpoint>

Lists the workflow's aliases with per-trigger activation state. Webhook URLs in `triggerStates` are recomputed on each read.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"in":"path","name":"id","required":true,"schema":{"type":"string"},"description":"Workflow reference: a server-minted id (`wf_...`) or the workflow's client-chosen key (lowercase slug, unique per organization).","example":"wf_ifWBbWfpug0n"}]}
>

</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>

</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"The workflow's aliases.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"title":"Alias","type":"object","required":["workflowId","name","revision","active","updatedAt"],"properties":{"workflowId":{"type":"string","example":"wf_ifWBbWfpug0n"},"name":{"type":"string","example":"live"},"revision":{"type":"integer","example":3},"active":{"type":"boolean","description":"Whether the alias's triggers are activated."},"updatedAt":{"type":"string","format":"date-time"},"updatedBy":{"type":"string"},"metadata":{"type":"object"},"triggerStates":{"type":"object","description":"Map of trigger id to its activation state.","additionalProperties":{"title":"TriggerState","type":"object","properties":{"status":{"type":"string","enum":["pending","live","failed","inactive"]},"activatedAt":{"type":"string","format":"date-time"},"deactivatedAt":{"type":"string","format":"date-time"},"lastError":{"type":"object","properties":{"message":{"type":"string"},"code":{"type":"string"}}},"runtimeMetadata":{"type":"object","description":"Runtime data such as the trigger's `webhookUrl`.","properties":{"webhookUrl":{"type":"string"}},"additionalProperties":true}}}}}}}}}}}},"4XX":{"description":"Client error. The body says what went wrong: an error `type`, a human-readable `detail`, and, on validation failures, one entry per offending field.","content":{"application/problem+json":{"schema":{"title":"Problem","type":"object","description":"The standard error body (RFC 7807 problem details, served as `application/problem+json`).","properties":{"type":{"type":"string","description":"Error type URI, e.g. `https://workflow-system.dev/errors/workflow-not-found`.","example":"https://workflow-system.dev/errors/workflow-not-found"},"title":{"type":"string","example":"Not found"},"status":{"type":"integer","example":404},"detail":{"type":"string","example":"No workflow with id wf_ifWBbWfpug0n exists"},"instance":{"type":"string","example":"/workflows/definitions/wf_ifWBbWfpug0n"},"errors":{"type":"array","description":"Present on validation failures: one entry per offending field.","items":{"type":"object","properties":{"path":{"type":"string","example":"/steps/scan/config"},"message":{"type":"string","example":"must have required property 'code'"}}}}}}}}},"5XX":{"description":"Unexpected server error.","content":{"application/problem+json":{"schema":{"title":"Problem","type":"object","description":"The standard error body (RFC 7807 problem details, served as `application/problem+json`).","properties":{"type":{"type":"string","description":"Error type URI, e.g. `https://workflow-system.dev/errors/workflow-not-found`.","example":"https://workflow-system.dev/errors/workflow-not-found"},"title":{"type":"string","example":"Not found"},"status":{"type":"integer","example":404},"detail":{"type":"string","example":"No workflow with id wf_ifWBbWfpug0n exists"},"instance":{"type":"string","example":"/workflows/definitions/wf_ifWBbWfpug0n"},"errors":{"type":"array","description":"Present on validation failures: one entry per offending field.","items":{"type":"object","properties":{"path":{"type":"string","example":"/steps/scan/config"},"message":{"type":"string","example":"must have required property 'code'"}}}}}}}}}}}
>

</StatusCodes>