---
title: "Create Invitation"
method: POST
path: "/invitations"
tags: ["invitations"]
---

# Create Invitation

`POST /invitations`

## Request

- Base URL: `https://platform.tracecat.com/api`
- URL: `https://platform.tracecat.com/api/invitations`
- Auth: API key in cookie `fastapiusersauth`

Create an invitation carrying one or more role grants.

## Request body

- InvitationCreate: Request body for creating an invitation.
  - `email` string, email, required
  - `grants` InvitationGrant[], required
    - `workspace_id` string, uuid, nullable
    - `role_id` string, uuid, required
  - `group_ids` string[]

## Response `201`

Successful Response

- InvitationRead: Response model for an invitation.
  - `id` string, uuid, required
  - `organization_id` string, uuid, required
  - `email` string, email, required
  - `status` 'pending' | 'accepted' | 'revoked', required: Invitation lifecycle status.
  - `invited_by` string, uuid, nullable, required
  - `expires_at` string, date-time, required
  - `created_at` string, date-time, required
  - `accepted_at` string, date-time, nullable, required
  - `created_by_platform_admin` boolean, required
  - `grants` InvitationGrant[], required
    - `workspace_id` string, uuid, nullable
    - `role_id` string, uuid, required
  - `group_ids` string[]
  - `warning` string, nullable

## Other responses

- `422`: Validation Error

---

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