---
id: workflow-execution-read
title: Read an execution
description: >-
  Returns the execution record. Large final snapshots are omitted by default and
  their size reported as `finalSnapshotBytes`; pass `include=finalSnapshot` for
  the full payload.
sidebar_label: Read an execution
hide_title: true
hide_table_of_contents: true
api: >-
  eJztWG1v2zYQ/isEv6zF5Je+oYWHfUiLdss2FEGSIgWCID6LJ5sNRarkKY5q6L8PR9my7KhO208b0HyJLN6Rz909z5HUShLMg5xcygvnbzLjlgLvMC1JOxvkVSIVhtTrgn/LiTxFKr0Ngha4tRMeU+fVUPwDfo4i0xaMCBaKsHAUBHgULtdEqMSsEgozKA0JsIqn0V4E/QWFx8J5NoEgpnGKs/UMryvCMP1NFBCCmGqbmlLh7zsmU5E5H0FlpTGigMo4UEOZSFegBwZ5rORELtcxDlrsE4+gZCIL8JAjoedcrKTmYAughUykhRzlRGo28/i51B6VnJAvMZEhXWAOcrKSVBVsFchrO5f1fuLOdxKmIza8g7ww7MUj16+yZ/Bk9jR9rl6grJM1iM8l+qqDoglffsfSb1yewyAgh8gJxjvyEIbirCyalE/2Ej7dBbczJuurRAZMS6+piqmaIXj0RyUt5OTyioc9hsLZgIHBPR2P+d+BbPBqqbOEltgSisLoNNZs9Cmw+aobq6YI6u3GWyab+N3sE6a0U6TLpmqbsh83JbzVoXEMBFQGmUhti5JC84YzcsTTlIWC5vkqkYVnJpFugtLqft4fqmcXxUHnZXats4vXs4usKOdjy64t5q2jtoRz9F3PZ3UiwWgI7yNXDq1h9G3E5PwcrP7SKqSHTKnzHk20+Burvmn36GY0WhqkCxfQihusRBlQCXKCuD3QXu9YalqIoOcWTBjyelphXjhCm1a969Vt3foitGXOZS/QquaNL61tnlLHwRMyCTLQJj6kYFM0zTPpHNW1K0le1S0ntou0/NpriaUVje1QvPGo0JIGM2C9Kg6/aYA5hBtUIjZLUE2krqT+JepE3oLXMDPYP4reO9+Vwxlh8Ta+PCyH1MXekWMIMMf7xI7jB5nz5/n5yfWL8ZhhbKbp70EE2vTD90i+4ug6ozPnDIKVdV3HboyWWo33K2a3DCceA1riDIdyNlje381izpuZOV1foXuOBAoIeoFv20MPnsz5HEhOJLeNAZOJXbZd5JtdWqJ+u1P8S+Tzjx/vN9tGkCJyZii49c6cqkSAKojlAkgseXjpnZ1PBNjGUEx52WkiQCzKHOyAacslE9OmsjxkVcL5vgWjVWwQgnVVegz8HgVa8pUo0AuXZY0iRabRqAMtv/BuZjD/9eut/6Sx6GH6/U0mEFgFXq2DioE/On33Rrx8NX4p1muJNVcTEdDfro8gX8M0fczgd1XT4HiIoVGfgm3Eh9PjROBwPhTTBVERJqNRezQJVSDMhwpvRxF02A5ZR4PMlVbt7dA/NAczbZ3SQ3p/70i09vcab88u9Hz8vJX/Q1OLVqZxG9BK7G1+Au90oBD3BcvFTB+A2wYaRgozbXWU/qhnT20S05kNvIfqUF/p4fnkYZ5rwrx3G9nlUDxsHg4tEBZhFFKwo9TZTM8P9uCua14GEgu45WN2sxmI9eqV+IV7/i/rFhK7yIu+LvLB4l2BKR8go0r8uqH8VPJPJf9U8n9Syc1pZuH45jvHCDRC66Z2ezwarbSq+QoU1d1cg0tvOqSEQg9taUxhgPgQMkxdvnMfPGOFN0no3grbeHiizc01nvmikUzWD+82B5u/Ls5lHYmSOXZnPE0NnwzHw7Fs6S7fd+CIo5PjeMRzgXKILWd9aT5FUPFk07k07nBjte1h/79PHOvkEt7RqDCgoyZi5TZcvGzvniGSqf2+k8iJVnwLWLhAbLdazSDgB2/qml83Hx+YCUoHPv0pOcnABDyQvx/73NAbxA3f/zqfPG7BlGwVSbe5IX0nvEena908Fn3fZHpxbNqKrbogWnxK1nxhXCAo9BFOM3CUplhQx+Xepw2Oo5XoH2/PZSJhVzJ7Eomz98JZrRqLc3eDtq5bdMS/GWBd/wuY1/gW
sidebar_class_name: get api-method
info_path: docs/api/nullplatform-api
custom_edit_url: null
canonical: 'https://docs.nullplatform.com/docs/api/workflow-execution-read'
---
<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Read an execution"}
>
</Heading>

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

</MethodEndpoint>

Returns the execution record. Large final snapshots are omitted by default and their size reported as `finalSnapshotBytes`; pass `include=finalSnapshot` for the full payload.

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

<ParamsDetails
  parameters={[{"in":"path","name":"id","required":true,"schema":{"type":"string"},"description":"The execution id.","example":"exec_8f3a1b2c4d5e"},{"in":"query","name":"include","schema":{"type":"string"},"description":"Comma-separated extras. Supported: `finalSnapshot`.","example":"finalSnapshot"}]}
>

</ParamsDetails>

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

</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"The execution.","content":{"application/json":{"schema":{"title":"Execution","type":"object","required":["id","workflowId","revision","status","inputs","startedAt","updatedAt"],"properties":{"id":{"type":"string","example":"exec_8f3a1b2c4d5e"},"workflowId":{"type":"string","example":"wf_ifWBbWfpug0n"},"revision":{"type":"integer","example":3},"aliasName":{"type":"string","example":"live"},"organizationId":{"type":"string"},"correlationKey":{"type":"string","description":"Client-chosen key used to target the execution with signals."},"idempotencyKey":{"type":"string"},"status":{"type":"string","enum":["pending","running","completed","failed","cancelled","timed_out"]},"inputs":{"type":"object","description":"Run inputs. Credential-named keys are masked on reads."},"outputs":{"type":"object"},"variables":{"type":"object"},"error":{"title":"StepError","type":"object","required":["code","message"],"properties":{"code":{"type":"string","example":"HTTP_500"},"message":{"type":"string"},"details":{"type":"object"},"retryable":{"type":"boolean"}}},"parentExecutionId":{"type":"string","description":"Present on sub-workflow executions."},"parentStepId":{"type":"string"},"metadata":{"type":"object"},"startedAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"completedAt":{"type":"string","format":"date-time"}}}}}},"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>