---
title: "Share a flow with a guest"
method: POST
path: "/v1/flows/{flowId}/shares"
tags: ["flows"]
---

# Share a flow with a guest

`POST /v1/flows/{flowId}/shares`

## Request

- Base URL: `https://api.flowral.app`
- URL: `https://api.flowral.app/v1/flows/{flowId}/shares`
- Auth: one of:
  - HTTP bearer
  - OAuth 2 (client credentials, token URL `https://api.flowral.app/v1/oauth/token`, scopes: `flows:write`)

Gives one person access to this flow only — they see its progress and nothing else in the workspace.

## Path parameters

- `flowId` string, required

## Request body

- object
  - `email` string, required
  - `role` string: `viewer` or `commenter`.

## Response `201`

CREATED

- Share: A client or guest with access to one flow. Guests never occupy a seat.
  - `id` string, required
  - `email` string, email, required
  - `role` 'viewer' | 'commenter', required
  - `flowId` string, required
  - `createdAt` string, date-time

## Other responses

- `400`: INVALID_EMAIL
- `401`: UNAUTHORIZED
- `403`: FORBIDDEN
- `404`: NOT_FOUND
- `429`: RATE_LIMITED

---

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