---
title: "Invite someone"
method: POST
path: "/v1/team/invites"
tags: ["team"]
---

# Invite someone

`POST /v1/team/invites`

## Request

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

Sends an invitation. A pending invite occupies a seat for the purposes of the plan limit, which is why this can be refused on a full workspace before anyone has accepted.

## Request body

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

## Response `201`

CREATED

- Invite
  - `id` string, required
  - `email` string, email, required
  - `role` 'admin' | 'member' | 'viewer', required
  - `status` 'pending' | 'accepted' | 'revoked', required
  - `createdAt` string, date-time

## Other responses

- `400`: INVALID_EMAIL · ALREADY_MEMBER
- `401`: UNAUTHORIZED
- `403`: FORBIDDEN · PLAN_LIMIT_REACHED
- `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)