---
title: "Invite a member to the workspace"
method: POST
path: "/api/workspaces/{workspaceId}/invites"
tags: ["Workspace Members"]
---

# Invite a member to the workspace

`POST /api/workspaces/{workspaceId}/invites`

## Request

- Base URL: `https://hiveship.app/api`
- URL: `https://hiveship.app/api/api/workspaces/{workspaceId}/invites`
- Auth: API key in cookie `hiveship_access`

## Path parameters

- `workspaceId` string, required

## Request body

- object
  - `email` string, email, required
  - `role` 'ADMIN' | 'MEMBER' | 'VIEWER', required

## Response `201`

Invite created

- object
  - `success` boolean, required
  - `data` object, required
    - `invite` object, required
      - `id` string, cuid, required
      - `email` string, email, required
      - `role` 'OWNER' | 'ADMIN' | 'MEMBER' | 'VIEWER', required
      - `status` 'PENDING' | 'ACCEPTED' | 'EXPIRED' | 'REVOKED', required
      - `expiresAt` string, date-time, required
      - `createdAt` string, date-time, required
      - `invitedBy` object, required
        - `id` string, cuid, required
        - `name` string, required
    - `linkToken` string, required

## Other responses

- `400`: Validation error
- `409`: Already a member or pending invite exists

---

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