---
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: >-
  eJztWFFv2zgM/iuEXtriHKd3t8MOfuuG7dADNhRdiw4YioWx6FirLXmSnDQX+L8fKDlp0jgd1r3sYXmJbVHSR/IjRWolPM6cyD6JG2PvisosACuFjpy4TYQkl1vVeGW0yMQl+dZqB0ZTFIKF8iUo78BbNZuRBefRk0tFIkxDFnniuRSZWPSLj8K8zBJKkYgGLdbkyTKAlVC8SYO+FInQWJPIhGIxS19bZUmKzNuWEuHykmoU2Ur4ZcNSzlulZ6J7DHijkqWCLOmcMkBwZOdkR7XSniQoCceTRfE5TdPJCRgLviRYwz1ykFeKtB/lpXGk4Y6WcFyZBdkcHYGr2lkCrVZfW4KGLBg7Q63+C4qfsBnoHuumYpCL4rMqbl5Nb4qmnZ1q0SWDGgcD/YjSV+XaO7xiCpOKXeInoBxYCspLQC0BW29GNSrtUWmSu2grNSfR3SbCUd5a5ZfBQ1NCS/as9aXIPt3ysCXXGM10yVbij9NT/juAhzfIjfakPUth01QqD5Yaf3EsutpWUvmA46w3R6+0mX6h3O+Y59OGXOdybUYenyvHABKBuWdlEtE2Ej3JM8/Ubiwz1KuIfGuJPQs/7cTeb09NirbcwvQgzRyckd0W/7PbQH6QmxpTEbI2jxheki8pkjYY+WgTiw7QEoSVWOuUETxYYABwYWyNXmSCZUZe1bQ15dVykHo1eZTot3nZu6hLRA/kQ8gJ+xKPdXmHDZhik0qUBG9Ccul1UEbH/MJEQikVf8HqYseRa95cbe09QJ9d7/OqrRt0om5rplhDWsYvVeRSgaoi5pvSvbNu1377XgtLeta0Cp1/Y62xQ5bd1a8m53A2wNKOI1IODXTM11bzZu8O+njvgIgTgKXBtXkJ6AI1e58eOZgsaFoac3dtq0m6B/RhcAjSIa9zguzWv0S8+PhxPwu9DmkciA2WAuekqZFLcLh0sCjRw4KHF9boWQaooyBMGMIkAYSyrVGP+NzCaUUwkeRRVTykZQJGwxwrJSNJmRutJZeEk5K0t8t4OBRFpBEUiir5RD5srJlWVP92OC9eRIkBau9nX+dRS7SyVyoofnz59jW8/Pv0JfR7QdTIJbA+IhxMDmGanOz7LuLYZ+8unsBYYBm4vjxPgNJZCpPS+8Zl4/GmTHBL56lOJc3HAbR7GNLGjwrTajnZPbGetUZIU9GkT2Xw98bDRn4vWwwk8RenL0Jks0m/tfSm2ujLKQmPThmge+W8472VZmfm34C7UdSNJRVKh5hx44HDKxpmazW0Fpd7XrvgwkH7AzzPvs1z5akePAJ2ORRKoadVc54aN3Y56nFudKH6Y+hAgtueWrfOQ4lzgnXxAP3uSzjiNHgktrLIX0NZ5FrTfUM5142xiuwTyq9I/hXJvyL5p4zkWKSWhrvQGQWgAdoh066U7MZ9CzxehYdOcBvE4R771JbLkw1LsVGpbquqqdBzpZbmpt7pnD5wyEerbPdPGwV5IdE3eKHWD0Ii6R/erqu/f2+uQhGkdGF4OuOJTv09PU1PxYb/4v0WHDi7OGfDNsb5GkMO6jvNS0JuBGHdce4QZfWQ0L6v7++V8nTvx02FKpCzjQVdtPxDwxZ33dheJCILDf/6BiIRWQR3m4jSOM9zV6spOrq2Vdfx568tWe5NbxMxR6u4OAs+ksrxsxRZgZWjJ7Q7vuw5dAI/wX3BoPnWEa05nudYtfwmEnFHy3hHwncJz9L4Ry4LngE1erPjVqkklGSDr+LYWZ5T47dm7V0QcFBtYvmfN1fMlN1QehQ6YfVBRKtVlLgyd6S7bgPQ8zsD7Lr/ASEuqwk=
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-read'
---
<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>