---
title: "Invite users to a workspace."
method: POST
path: "/workspaces/{workspaceId}/invites"
---

# Invite users to a workspace.

`POST /workspaces/{workspaceId}/invites`

Invite users to a workspace.

## Path parameters

- `workspaceId` string, uuid, required

## Request body

- object

## Response `201`

Status OK.

- object
  - `items` Invite[], required
    - `id` string, uuid, required — The invite id.
    - `dateCreated` string, date-time, required — The invite creation date.
    - `creator` object, required
      - `id` string, uuid — The invite creator id.
      - `username` string, nullable — The invite creator username.
      - `name` string, nullable — The invite creator name.
    - `status` 'accepted' | 'pending', required — The invite status.
    - `workspace` object, required
      - `id` string, uuid, required
      - `name` string, required
      - `slug` string, required
      - `dateCreated` string, date-time, required
      - `memberCount` integer, required
    - `email` string, email, required — The invite email.
    - `role` 'ADMIN' | 'MEMBER' | 'VIEWER', required — The invite role.

## Other responses

- `default` — Unexpected error.

---

[API](https://skmtc.net/openlayer/apis/openlayer-api.md) · [All operations](https://skmtc.net/openlayer/apis/openlayer-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/openlayer/openlayer-api/versions/d0e74f00c900/schema)