> ## Documentation Index
> Fetch the complete documentation index at: https://docs.middlewr.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Create Invitation

> Invite someone to a workspace by email



## OpenAPI

````yaml openapi.json POST /api/workspaces/{workspace_id}/invitations
openapi: 3.1.1
info:
  title: Middlewr API
  description: Short link management platform API
  version: 1.0.0
  contact:
    name: Middlewr
    email: hello@middlewr.com
    url: https://middlewr.com/contact
servers:
  - url: https://api.middlewr.com
security:
  - ApiKeyAuth: []
paths:
  /api/workspaces/{workspace_id}/invitations:
    post:
      tags:
        - Workspaces
      operationId: workspaces.createInvitation
      parameters:
        - name: workspace_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                email:
                  type: string
                  format: email
                permissions:
                  type: integer
                  minimum: 1
                  maximum: 9007199254740991
              required:
                - email
                - permissions
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    format: uuid
                  workspace_id:
                    type: string
                    format: uuid
                  email:
                    type: string
                    format: email
                  token:
                    type: string
                  permissions:
                    type: integer
                    minimum: -9007199254740991
                    maximum: 9007199254740991
                  invited_by_id:
                    type: string
                    format: uuid
                  expires_at:
                    type: string
                    format: date-time
                    x-native-type: date
                  created_at:
                    type: string
                    format: date-time
                    x-native-type: date
                required:
                  - id
                  - workspace_id
                  - email
                  - token
                  - permissions
                  - invited_by_id
                  - expires_at
                  - created_at
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: A user or workspace API key, created in the dashboard settings.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.