---
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: eJztWEtvGzcQ/isDXvzoauW2KVLszUmdwkVSGI4NB0iMiFrOahlzyQ0fklVB/70YcvWy1jaaS3OIL5bEITmPb76Z4YJ5PnGs+MhujL2rlJkBV5I7dOw2YwJdaWXrpdGsYG+l8w58jTDrZA/cShpm0tfQoh14KycTtMBLL6ectoLz3GMONziujbmD68u3DqSGUSf6npbdCLhFsFiapg0eBRgNyMsaLHKRs4yZFm0871ywgq1UGEQFCiWdZxlrueUNerRk0oJJUrvlvmYZ07xBVjApWMYsfg3SomCFtwEz5soaG86KBfPzlqSct1JP2PKhC9ZOslihRV1iARwc2inaQSM16S0FHI5m1ec8z0dHYOxDj5VKovaDsjYONdzhHA6VmaEtuUNwKkwyCFp+DUjuBGMnXMt/ouFH5Aa8502rSMlZ9VlWN6/GN1UbJieaLW8z5rAMVvp5NH+M3KI9Db5mxcdbWrboWqMpusWC/XJyQv92LbzqDS9dXBrtUXvawttWyTLqNPziaN9i34dm/AXLGBRLofMy3Sq435bi1vI5y5j02MR1L3207pRuZtneaZvYfVyD4FysAkzrU+nIloxFCNJvoRXcozj1BOpddbaO2Av/k85eIeqpTYquX27ptJEmrEzQbov/ulyrvJEbG6OQkzUPkFijrzGBKwbpwEGXTy5mUpd/KHLSYOOBHoUrYxvuWUGxwYGXDW5teTXvzYsGPX8Qyi5Ey4ztJHYfJHZtecdbMNVKfUogb0B6t88hFFQhJP3C1cVOIFe4udq6uwc+u9GnU4PrDaIODUGsRS3SLyphqeJSIeFN6i5Yt6u4/VcPC/ymbYo7f2atsc8nW4PO8UkPSpeUz6JvYUl4DZoue/dojB9G8DJtAJIGF8oaeKoUXUwPHIxmif6vrRrle4puFvtUeizqxN7Lrb+MvfjwYZ/TXkfGBSSf5UAMNzZiDo7PHcxq7mFGyzNr9KQArpMgjEiLUQYc6tBwPaA6xMcKYSTQc6loSYuM6tSUKykSTgkewaKj3xFQeztPPF5VCUlQSVTiCUJtrRkrbH7qIdYO4hdJogfd+1zuPNeCW9EZFQ0/vHzzGl7+fvISursgWeSyVMoERW/0mE6jo/3wJT32AbyrTwQtkAxcX55ngPkkh1HtfeuK4XBd0d3ceWxygdNhVNptlrTxg8oELUa7pfCbzohMlVz6FIn/bTys5fcIo4fHX5y8iMlNLn3u6HWtTQ2UFPCg0ADeU9tFd0tNwSyfUXdtqBsKrKSOaeOGPfUrOaanFu9G7cKio/zox3nxPM43pf1Jrop92tOmOY+tG7qS62FpdCW7SvQIx21vbYLzUPMpdZipf4Du9jkcEBMesC0W+a2PRa413rdYUouXGr6OUH5k8o9M/pHJ32Umpz61NjQwTjANiKTaY65dSLEcruZfGqYozdMoGagzWaOTtzLXQalWcU9NWl6aZmf+ek+pnryxPYWtDaODWDd4xjY/CrGs+/Bm1fj9dXMV+x+pK7NNHKtBlNQkHVOAT/Kf85O9sL8KUokM2jBW0tUZ2KBj6wJmHC1cI9cRMqhr2zZtg2vUE6kx/6Q/6TcmUJ+O3K0GVARfSwenF+cFCQzg+PiPjWePj+NMsj0JgzBlaFB7l8PZFC31Y1OEMT0AoAMOOjRjpPAeH6/mp+PjDJwBbXxNuJQOkHhYGefzdOdpCl53H01oAlpDqW0dTRUcVmfBoZJ3CCNq60dHOZx2s4aeUAsYQUAXxP7QB6tdnEjWI5bR3Y1n91iGlZH0fEEMHe2Jfiagw3ge/2cdNeg2eGoQg08fKBbKTFx34nssLdL0owVMuZXUdNLhd4gtlBYFai+5SgIOPens6LQ4RNUIG0jH2a81zjc8VqDuEYRecmCD8x24LDbV7P9+8elyxeO9H7aKy8h1IY0IKZE3TwDJjjXgWMaK+NSz9ZpVG+dpy2Ix5g6vrVou6eevAS29l9xmbOXtmPFCOvosWFFx5fAJNx1edkx0BN/BA1Gv11Z1QVNVmHIV6BvL2B3O06PYkqbYGrlAG61PC6dlia3f2rL38kOkt+bYP8+uyOW7VPeA2uLpveosFkniytyhXi7X2nn6Tgoul/8CjepCZg==
sidebar_class_name: "get api-method"
info_path: docs/api/workflows
custom_edit_url: null
---

import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";

<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>