---
title: "Get a workflow"
method: GET
path: "/workflows/{workflowId}"
tags: ["Workflows"]
---

# Get a workflow

`GET /workflows/{workflowId}`

## Request

- Base URL: `https://{prefix}.api.sandbox.checkout.com`
- URL: `https://{prefix}.api.sandbox.checkout.com/workflows/{workflowId}`
- Auth: one of:
  - OAuth 2
    - Client credentials
    - Token URL: `string` scopes: `flow`, `flow:workflows`
  - API key in header `Authorization`
- TypeScript: <https://skmtc.dev/checkout/apis/checkout-com-api-reference/docs/workflows/:workflowId/get.ts> (a function with typed inputs; its response is checked against the schema)

Get the details of a workflow

## Path parameters

- `workflowId` string, required

## Response `200`

Workflow retrieved successfully

- GetWorkflowResponse
  - `id` string: The workflow identifier
  - `name` string: A name you can use to describe your workflow
  - `active` boolean: Indicates whether the workflow is currently active
  - `conditions` GetWorkflowCondition[]: One or more workflow conditions
    - union: The get workflow condition
      - object: Condition that enables a source
        - `id` string, required: The workflow condition identifier
        - `type` string, required: The type of the workflow condition
        - `events` SourceEventsHashmap, required
        - `_links` WorkflowConditionLinks: Links related to the workflow condition
          - `self` Link
            - `href` string, required: The link URL
      - object: Condition that filters based on the entity
        - `id` string, required: The workflow condition identifier
        - `type` string, required: The type of the workflow condition
        - `entities` string[], required: ent_axclravnqf5u5ejkweijnp5zc4
        - `_links` WorkflowConditionLinks: Links related to the workflow condition
          - `self` Link
            - `href` string, required: The link URL
      - object: Condition that filters based on the processing channel
        - `id` string, required: The workflow condition identifier
        - `type` string, required: The type of the workflow condition
        - `processing_channels` string[], required: pc_axclravnqf5u5ejkweijnp5zc4
        - `_links` WorkflowConditionLinks: Links related to the workflow condition
          - `self` Link
            - `href` string, required: The link URL
  - `actions` GetWorkflowAction[]: One or more workflow actions
    - `id` string, required: The workflow action identifier
    - `type` string, required: The type of workflow action
    - `url` string, uri, required: Your webhook endpoint URL
    - `headers` object: Optional [HTTP headers](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers) added to the request
    - `signature` object: Used to produce a signature of the webhook contents that will be included in the `Cko-Signature` header. This value can be computed by you on receipt of a webhook to validate its authenticity.
      - `method` string: The signing method, defaults to HMAC SHA256
      - `key` string, required: The key used the sign the webhook
    - `_links` WorkflowActionLinks: Links related to the workflow action
      - `self` Link
        - `href` string, required: The link URL
  - `_links` WorkflowLinks: Links related to the workflow
    - `self` Link, required
      - `href` string, required: The link URL

## Other responses

- `401`: Unauthorized
- `404`: Workflow not found
- `500`: Internal Error

---

[API](https://skmtc.dev/checkout/apis/checkout-com-api-reference.md) - [All operations](https://skmtc.dev/checkout/apis/checkout-com-api-reference/llms.txt) - [OpenAPI document](https://skmtc.dev/checkout/apis/checkout-com-api-reference/revisions/0f1abdb1c3e9?raw)