---
title: "Flow structure as YAML with execution path data"
method: GET
path: "/{teamPid}/data/flows/{flowId}"
tags: ["Data"]
---

# Flow structure as YAML with execution path data

`GET /{teamPid}/data/flows/{flowId}`

## Request

- Base URL: `https://api.rightmessage.com/v1`
- URL: `https://api.rightmessage.com/v1/{teamPid}/data/flows/{flowId}`
- Auth: HTTP bearer

Requires an API token with the `read` or `write` ability. Tokens created without abilities have `*`, which grants every ability.

## Path parameters

- `teamPid` string, required
- `flowId` string, required

## Query parameters

- `include_paths` boolean

## Response `200`

- object
  - `data` object, required
    - `flow_id` string, required
    - `format` 'yaml', required
    - `content` string, required: Convert flow to YAML format

## Other responses

- `401`: Missing, invalid or revoked API token.
- `404`: Not found
- `429`: Rate limit exceeded: 120 requests per minute for project endpoints, 60 per minute for token and connection endpoints. Retry after the `Retry-After` seconds.

---

[API](https://skmtc.dev/rightmessage/apis/rightmessage-api.md) - [All operations](https://skmtc.dev/rightmessage/apis/rightmessage-api/llms.txt) - [OpenAPI document](https://skmtc.dev/rightmessage/apis/rightmessage-api/revisions/adec35e9720c?raw)