---
title: "Get Workflow Registration"
method: GET
path: "/v1/workflows/registrations/{workflow_registration_id}"
tags: ["workflows"]
---

# Get Workflow Registration

`GET /v1/workflows/registrations/{workflow_registration_id}`

Get Workflow Registration

## Path parameters

- `workflow_registration_id` string, uuid, required

## Query parameters

- `with_workflow` boolean — Whether to include the workflow definition
- `include_shared` boolean — Whether to include shared workflow versions

## Response `200`

Successful Response

- WorkflowRegistrationGetResponse
  - `workflow_registration` WorkflowRegistrationWithWorkerStatus, required
    - `id` string, uuid, required — Unique identifier of the workflow registration
    - `deployment_id` string, uuid, nullable — Deprecated. Use deployment_name instead. Will be removed in a future release.
    - `task_queue` string, nullable — Deprecated. Use deployment_name instead. Will be removed in a future release.
    - `definition` WorkflowCodeDefinition, required
      - `input_schema` object, required — Input schema of the workflow's run method
      - `output_schema` object, nullable — Output schema of the workflow's run method
      - `signals` SignalDefinition[] — Signal handlers defined by the workflow
        - `name` string, required — Name of the signal
        - `description` string, nullable — Description of the signal
        - `input_schema` object, required — Input JSON schema of the signal's model
      - `queries` QueryDefinition[] — Query handlers defined by the workflow
        - `name` string, required — Name of the query
        - `description` string, nullable — Description of the query
        - `input_schema` object, required — Input JSON schema of the query's model
        - `output_schema` object, nullable — Output JSON schema of the query's model
      - `updates` UpdateDefinition[] — Update handlers defined by the workflow
        - `name` string, required — Name of the update
        - `description` string, nullable — Description of the update
        - `input_schema` object, required — Input JSON schema of the update's model
        - `output_schema` object, nullable — Output JSON schema of the update's model
      - `enforce_determinism` boolean — Whether the workflow enforces deterministic execution
      - `on_behalf_of` boolean — Whether the workflow must run associated to a user's identity
      - `execution_timeout` number — Maximum total execution time including retries and continue-as-new
      - `plugin_metadata` object, nullable — Plugin-specific metadata (e.g. connector declarations)
    - `workflow_id` string, uuid, required — Workflow ID of the workflow
    - `workflow` Workflow
      - `id` string, uuid, required — Unique identifier of the workflow
      - `name` string, required — Name of the workflow
      - `display_name` string, required — Display name of the workflow
      - `type` 'code', required
      - `description` string, nullable — Description of the workflow
      - `customer_id` string, uuid, required — Customer ID of the workflow
      - `workspace_id` string, uuid, required — Workspace ID of the workflow
      - `shared_namespace` string, nullable — Reserved namespace for shared workflows (e.g., 'shared:my-shared-workflow')
      - `available_in_chat_assistant` boolean — Whether the workflow is available in chat assistant
      - `is_technical` boolean — Whether the workflow is technical (e.g. SDK-managed)
      - `archived` boolean — Whether the workflow is archived
      - `tags` string[] — Tags for filtering and discovery
    - `deployment_name` string, nullable — Name of the deployment this registration belongs to
    - `compatible_with_chat_assistant` boolean — Whether the workflow is compatible with chat assistant
    - `active` boolean, required — Whether the workflow registration is active
  - `workflow_version` WorkflowRegistrationWithWorkerStatus, required
    - `id` string, uuid, required — Unique identifier of the workflow registration
    - `deployment_id` string, uuid, nullable — Deprecated. Use deployment_name instead. Will be removed in a future release.
    - `task_queue` string, nullable — Deprecated. Use deployment_name instead. Will be removed in a future release.
    - `definition` WorkflowCodeDefinition, required
      - `input_schema` object, required — Input schema of the workflow's run method
      - `output_schema` object, nullable — Output schema of the workflow's run method
      - `signals` SignalDefinition[] — Signal handlers defined by the workflow
        - `name` string, required — Name of the signal
        - `description` string, nullable — Description of the signal
        - `input_schema` object, required — Input JSON schema of the signal's model
      - `queries` QueryDefinition[] — Query handlers defined by the workflow
        - `name` string, required — Name of the query
        - `description` string, nullable — Description of the query
        - `input_schema` object, required — Input JSON schema of the query's model
        - `output_schema` object, nullable — Output JSON schema of the query's model
      - `updates` UpdateDefinition[] — Update handlers defined by the workflow
        - `name` string, required — Name of the update
        - `description` string, nullable — Description of the update
        - `input_schema` object, required — Input JSON schema of the update's model
        - `output_schema` object, nullable — Output JSON schema of the update's model
      - `enforce_determinism` boolean — Whether the workflow enforces deterministic execution
      - `on_behalf_of` boolean — Whether the workflow must run associated to a user's identity
      - `execution_timeout` number — Maximum total execution time including retries and continue-as-new
      - `plugin_metadata` object, nullable — Plugin-specific metadata (e.g. connector declarations)
    - `workflow_id` string, uuid, required — Workflow ID of the workflow
    - `workflow` Workflow
      - `id` string, uuid, required — Unique identifier of the workflow
      - `name` string, required — Name of the workflow
      - `display_name` string, required — Display name of the workflow
      - `type` 'code', required
      - `description` string, nullable — Description of the workflow
      - `customer_id` string, uuid, required — Customer ID of the workflow
      - `workspace_id` string, uuid, required — Workspace ID of the workflow
      - `shared_namespace` string, nullable — Reserved namespace for shared workflows (e.g., 'shared:my-shared-workflow')
      - `available_in_chat_assistant` boolean — Whether the workflow is available in chat assistant
      - `is_technical` boolean — Whether the workflow is technical (e.g. SDK-managed)
      - `archived` boolean — Whether the workflow is archived
      - `tags` string[] — Tags for filtering and discovery
    - `deployment_name` string, nullable — Name of the deployment this registration belongs to
    - `compatible_with_chat_assistant` boolean — Whether the workflow is compatible with chat assistant
    - `active` boolean, required — Whether the workflow registration is active

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.dev/mistral/apis/mistral-ai-api.md) · [All operations](https://skmtc.dev/mistral/apis/mistral-ai-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/mistral/mistral-ai-api/revisions/61436a496404/schema)