---
title: "Invite someone to a team"
method: POST
path: "/v1/team-invitations"
tags: ["Teams"]
---

# Invite someone to a team

`POST /v1/team-invitations`

## Request

- Base URL: `https://api.spacefast.com`
- URL: `https://api.spacefast.com/v1/team-invitations`
- Auth: one of:
  - HTTP bearer
  - OAuth 2 (authorization code, authorization URL `https://api.spacefast.com/v1/auth/oauth2/authorize`, token URL `https://api.spacefast.com/v1/auth/oauth2/token`; client credentials, token URL `https://api.spacefast.com/v1/auth/oauth2/token`, scopes: `teams:members.write`)

Creates a pending invitation and emails the invitee a join link.

## Request body

- object
  - `teamId` string, required: The team to invite this person to.
  - `email` string, email, required
  - `role` 'owner' | 'admin' | 'member'

## Response `201`

Response for status 201

- object
  - `$schema` string, uri: Canonical JSON Schema URL for this response body. The server also sends it in the `Link: rel="describedby"` response header.
  - `data` object, required
    - `id` string, required
    - `teamId` string, required
    - `email` string, email, required
    - `role` 'owner' | 'admin' | 'member', required
    - `status` 'pending' | 'accepted' | 'rejected' | 'canceled' | 'expired', required
    - `expiresAt` string, date-time, required
    - `createdAt` string, date-time, required

## Other responses

- `default`: Problem details (RFC 9457). Any 4xx/5xx response is one `application/problem+json` document.

---

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