---
title: "Retrieve flow definition by flow ID"
method: GET
path: "/v1/multipass/flows/{flowId}"
tags: ["Multipass API"]
---

# Retrieve flow definition by flow ID

`GET /v1/multipass/flows/{flowId}`

## Request

- Base URL: `https://api.cloud.precisely.com`
- URL: `https://api.cloud.precisely.com/v1/multipass/flows/{flowId}`
- Auth: one of:
  - HTTP bearer
  - API key in header `Authorization`

Retrieves the Multipass flow definition for the specified flow ID.
The flow definition contains the complete configuration and processing steps for the flow.

Path Parameter:
- `flowId` : Unique identifier for the Multipass flow

## Path parameters

- `flowId` string, required

## Headers

- `X-Request-Id` string

## Response `200`

Flow definition retrieved successfully

- FlowDefinitionApiResponseReadFlowResult: Response object containing the operation, status, flow ID, and flow definition after a read operation
  - `operation` string, required
  - `status` string, required
  - `flowId` string, required
  - `flowDefinition` FlowData
    - `flowId` string, required
    - `startOperatorId` string, required
    - `inputDataKey` string, required
    - `inputDataKeyOrDefault` string
    - `operators` Operator[], required
      - `id` string
      - `description` string

## Other responses

- `400`: Invalid request - check flow definition format or input data
- `401`: Unauthorized: Invalid or missing authentication token
- `403`: Forbidden: Insufficient permissions to access this flow
- `429`: Rate limit exceeded - too many requests
- `500`: Internal server error occurred
- `503`: Service temporarily unavailable

---

[API](https://skmtc.dev/precisely/apis/multipass-flow-management-api.md) · [All operations](https://skmtc.dev/precisely/apis/multipass-flow-management-api/llms.txt) · [OpenAPI document](https://skmtc.dev/precisely/apis/multipass-flow-management-api/revisions/40c73192cfac?raw)