---
id: workflow-alias-read
title: "Read an alias"
description: "Returns one alias with its trigger states."
sidebar_label: "Read an alias"
hide_title: true
hide_table_of_contents: true
api: eJztWNtuGzcQ/ZUBX3zpeuW2KVLsm5M6RQqkMBwbDpAYEbWc1TLmkhteJKvC/nsx5K4uluwgyUse4hdL4pA8M3N4OMMl83zqWPGe3Rh7VykzB64kd+jYbcYEutLK1kujWcEu0QerHRiNyQjm0tcgvQNv5XSKFpznHl3OMmZatJwmvhasYPN+8ZM4r7DIBctYyy1v0KMlAEsmaZOW+5plTPMGWcEkmVn8HKRFwQpvA2bMlTU2nBVL5hctWTlvpZ6y7iHglUsWK7SoSyyAg0M7Q3vSSO1RgBRwOJ5XH/M8Hx+BseBrhAHugYNSSdT+pKyNQw13uIBDZeZoS+4QnArTDIKWnwNCixaMnXIt/4uOH1EY8J43rSKQ8+qjrG5eTG6qNkxPNeuyvR7HAH2P01f1kB1aMYexopT4MUgHFqPzArgWwIM3Jw2X2nOpUWyjVXKGrLvNmMMyWOkXMUMT5BbtWfA1K97f0rBF1xpNdCmW7LfTU/r3CB7aoDTao/ZkxdtWyTJGavTJkely00npI46zPhy902byCUu/FZ73K3K9FkMYaXwmHQHIGC89OZOx0AruUZx5onZriaFeJuQbS+xE+Okk9nl7alKK5QamtTVxcIp20/z3bgV5bTcxRiEnbx4wvEZfYyJtDPLB6iw64BYhrkRe54RgHYE9gCtjG+5ZwcjmxMsGN6a8WOylXoOeC+43edmnqMtYD+Rt1IRdi4e+vOEtmGolJVKAN1Fceh+k0UlfiEhcCEm/cHWxlciBN1cbe++hz3b2adXg9iZRh4Yo1qIW6ReVuFRxqZD4JnWfrNshb18bYYHfNE1x58+tNXZfZLf9a9A5Pt3D0o5OpNg30BFfg6bN3jya450LIk0AsgYXyhq4i9Tsc3rgYDzHSW3M3bVV43wH6HpwH6THsk4C2Q1/GXv27t2uCr2MMg5IAcuBNGlixAIcXziY19zDnIbn1uhpAVwnQxgThHEGHOrQcH1C9xafKISxQM+loiEtMjAaZlxJkUhK3AgWXRZvStTeLtLlUFWJRlBJVOIJPWytmShsfnlcFy+SxR5q76qv81wLbkXvVHT88PLVS3j+5+lz6PeC5JHLYLgiHIwfwzQ+2s1dwrHL3m08kbFANnB9+ToDzKc5jGvvW1eMRqsywS2cxyYXOBtF0G49pI0/qUzQYrx9Y33TGlGmUkifUvB/jYeV/Y5a7BHxZ6fP4smmkH5p6VW10ZdTAh7cMoD30nlHe0tNySy/AHflqBsJrKSOZ8aN9lxeKTAbq3Fr+WInaxdUOGj/CM+LL/Ncemz2XgHbHIql0NOuOY+tG7mS61FpdCX7a+gRgduc2gTnoeYzhKF4gH73BRyQDB6wDRX5Y5+KXGu8b7GkujFVkb2g/DzJP0/yz5P8Q57kVKTWhrrQKUagEdpjoV1K0Y36Fni0jB86Rm0QHffUpwYqT1Ys5a3MdVCqVdxTpZaXptnqnN7SkU9R2eyfVg7SQqxv8GKtH41Y1n94NVR//9xcxSJI6spsCsjQ5VKbRBhTok/zX/PTnfS/CFKJDNowUdLVGdigYwkDZhI9XDGYuvxYum26tuY36qnUmH/QH/QrE6hYR+6G7hfB19LB2cXrggxO4Pj4r3WEj49jY7LZZoMwZWhQe5fD+Qwt1WUzhAmWpkEHHHRoJkhpPj4emqjj4wycAW18TfyUDpD0WBnn87TnWUpivx+1aQJaQ0fcOmotOAxrwaGSdwhjqu3HRzmc9Q2HnlIpmJpp2deJ6Qlk482DItXveH6PZRictFgaUuroT4wzER4mi/g/6yVCt8FToRh8+kC5UGbq+hXfYmmRWiAtYMatpOKTFr9DbKG0KFB7yVUycOgJs6PVYidVI6ypHRvA1jjf8HgT9e8Nl8jFysuHfFmur7Wve/3pqe3x3o9axWWUqJDK+nT+1m172nXFD5axIj77DO9QGSsSuNuM1cZ5mrtcTrjDa6u6jn7+HNDSC8VtxoYoxZMqpKPPghUVVw6f8O7wsleSI/gBXo32hm/QdU2qPuMq0DeWsTtcpJcyelH6Jo+/58noG6CmbHbUMNfIBdqYqzR2VpbY+o1ZO89EJK0rRf/7/IqYsi2oDwQ0rr4X0XKZLK7MHequWwH09J0Adt3/Kodj3A==
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={"Read an alias"}
>
</Heading>

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



Returns one alias with its trigger states.

<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"},{"in":"path","name":"alias","required":true,"schema":{"type":"string"},"description":"The alias name. `latest` is reserved and auto-maintained.","example":"live"}]}
>
  
</ParamsDetails>

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

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"The alias.","content":{"application/json":{"schema":{"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>