---
title: "Get a workflow by slug"
method: GET
path: "/v1/workspaces/{workspaceId}/workflows/slug/{slug}"
tags: ["Workflows"]
---

# Get a workflow by slug

`GET /v1/workspaces/{workspaceId}/workflows/slug/{slug}`

Gets a workflow by its slug within the workspace.

## Path parameters

- `workspaceId` string, required
- `slug` string, required

## Response `200`

OK response

- Workflow
  - `id` string, required
  - `inputs` WorkflowInput[], required
    - union
      - WorkflowStringInput
        - `default` string
        - `key` string, required
        - `type` 'string', required
      - WorkflowNumberInput
        - `default` number
        - `key` string, required
        - `type` 'number', required
      - WorkflowBooleanInput
        - `default` boolean
        - `key` string, required
        - `type` 'boolean', required
      - union
        - WorkflowManualArrayInput
          - `default` object[]
          - `key` string, required
          - `type` 'array', required
        - WorkflowSelectorArrayInput
          - `key` string, required
          - `selector` object, required
            - `default` string — CEL expression for the default selector.
            - `entityType` 'resource' | 'environment' | 'deployment', required
          - `type` 'array', required
      - WorkflowObjectInput
        - `default` object
        - `key` string, required
        - `type` 'object', required
  - `jobAgents` WorkflowJobAgent[], required
    - `config` object, required — Configuration for the job agent
    - `name` string, required
    - `ref` string, required — Reference to the job agent
    - `selector` string, required — CEL expression to determine if the job agent should dispatch a job
  - `name` string, required
  - `slug` string, required

## Other responses

- `400` — Invalid request
- `404` — Resource not found

---

[API](https://skmtc.dev/ctrlplanedev/apis/ctrlplane-api.md) · [All operations](https://skmtc.dev/ctrlplanedev/apis/ctrlplane-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/ctrlplanedev/ctrlplane-api/revisions/156e0d264995/schema)