---
title: "List a flow's guests"
method: GET
path: "/v1/flows/{flowId}/shares"
tags: ["flows"]
---

# List a flow's guests

`GET /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:read`)

Clients and guests with access to this flow. Guests never occupy a seat, on any plan.

## Path parameters

- `flowId` string, required

## Response `200`

SUCCESS

- object
  - `total` integer, required: Total matching, not the length of `items`.
  - `items` Share[], required
    - `id` string, required
    - `email` string, email, required
    - `role` 'viewer' | 'commenter', required
    - `flowId` string, required
    - `createdAt` string, date-time

## Other responses

- `401`: UNAUTHORIZED
- `403`: FORBIDDEN · PLAN_REQUIRED · INSUFFICIENT_SCOPE
- `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)