craaft Invitations API

openapi: 3.2.0
info:
  title: Craaft Invitations API
  version: 1.0.0
  description: 'Personal-access-token API for Craaft. See `docs/api.md` for the

    narrative guide, rate limits, and worked examples.'
  contact:
    name: Craaft
servers:
- url: https://craaft.io/api/v1
  description: Production
- url: http://localhost:8080/api/v1
  description: Local
security:
- bearerAuth: []
tags:
- name: Invitations
paths:
  /invitations:
    get:
      summary: List pending invitations
      operationId: listInvitations
      responses:
        '200':
          description: Pending invitations, each with its `boardGrants` array.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Invitation'
        '401':
          $ref: '#/components/responses/Unauthorized'
      tags:
      - Invitations
    post:
      summary: Invite a user by email
      operationId: createInvitation
      description: '`boardGrants` is optional and only honoured for `role: "member"`

        invitations - admin invitations auto-see every board. Grants are

        persisted alongside the invitation and applied atomically when

        the invitee accepts.


        When the email already belongs to a verified account, the invite is

        accepted on the spot and `consumed` is `true` (the person is now a

        member). An unverified account leaves the invite pending until the

        address is confirmed.'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InvitationCreate'
      responses:
        '201':
          description: Created. The invitation is wrapped, not returned bare.
          content:
            application/json:
              schema:
                type: object
                required:
                - invitation
                - consumed
                properties:
                  invitation:
                    $ref: '#/components/schemas/Invitation'
                  consumed:
                    type: boolean
                    description: True when an existing verified account was added immediately
        '400':
          description: Malformed body or invalid role
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '409':
          description: Email already a member or has a pending invitation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      tags:
      - Invitations
  /invitations/{id}:
    parameters:
    - name: id
      in: path
      required: true
      schema:
        type: string
        format: uuid
    delete:
      summary: Revoke a pending invitation
      operationId: revokeInvitation
      description: Owner/admin only. Deletes a pending invite so its accept link stops working.
      responses:
        '204':
          description: Revoked
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          description: Caller isn't a workspace owner/admin
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          $ref: '#/components/responses/NotFound'
      tags:
      - Invitations
components:
  responses:
    Unauthorized:
      description: Missing or invalid token
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    NotFound:
      description: Resource doesn't exist or caller isn't a member of its workspace
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    InvitationCreate:
      type: object
      required:
      - email
      - role
      properties:
        email:
          type: string
          format: email
        role:
          type: string
          enum:
          - admin
          - member
        boardGrants:
          type: array
          description: 'Optional, only honoured for `role: "member"` invitations

            (admins auto-see every board). Persisted alongside the

            invitation and applied atomically on accept.

            '
          items:
            type: object
            required:
            - projectId
            - role
            properties:
              projectId:
                type: string
                format: uuid
              role:
                type: string
                enum:
                - admin
                - contributor
    Invitation:
      type: object
      required:
      - id
      - email
      - role
      - invitedBy
      - invitedByName
      - createdAt
      - expiresAt
      - boardGrants
      properties:
        id:
          type: string
          format: uuid
        email:
          type: string
          format: email
        role:
          type: string
          enum:
          - admin
          - member
        invitedBy:
          type: string
          format: uuid
        invitedByName:
          type: string
        createdAt:
          type: string
          format: date-time
        expiresAt:
          type: string
          format: date-time
        boardGrants:
          type: array
          items:
            $ref: '#/components/schemas/InvitationGrant'
    Error:
      type: object
      required:
      - error
      properties:
        error:
          type: string
    InvitationGrant:
      type: object
      required:
      - projectId
      - name
      - role
      properties:
        projectId:
          type: string
          format: uuid
        name:
          type: string
          maxLength: 200
        role:
          type: string
          enum:
          - admin
          - contributor
  securitySchemes:
    sessionAuth:
      type: apiKey
      in: cookie
      name: craaft_session
      description: 'Browser session cookie (`__Host-craaft_session` in production,

        `craaft_session` in dev), set at sign-in. Not obtainable through

        this API - it''s here only so the handful of session-only routes

        below (the OAuth consent screen''s own endpoints, connected-apps

        management) can be marked accurately. They reject both bearer

        schemes with a 403.

        '
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: cra_<24 base64url chars>
      description: 'Two token schemes, same permissions. `cra_<24 base64url chars>` is a

        personal access token minted in Settings, doesn''t expire on its own,

        and is revoked from the same page. `cro_<32 base64url chars>` is an

        OAuth access token issued to an OAuth client (an MCP client such as

        Claude) via the authorization-code-with-PKCE flow; it expires after

        1 hour and the client refreshes it. Either token authenticates as

        the user who authorized it, with that user''s exact permissions.


        A token can be read-only: a personal access token created with

        access `read`, or an OAuth grant with scope `craaft:read`. A

        read-only token can send GET, HEAD and OPTIONS; any other method

        gets `403` with "this token is read-only; this request needs a

        token with read and write access", before the request is handled.


        A token can also be limited to chosen boards. Other boards then

        behave as if they don''t exist (`404`, or left out of lists), and

        `POST /projects`, `/imports`, `/members` and `/invitations` answer

        `403` with "this token is limited to some boards; this request

        needs a token for all boards".


        OAuth clients discover every endpoint they need - authorization,

        token, dynamic client registration, revocation - at

        `/.well-known/oauth-authorization-server` (RFC 8414); they don''t

        need to be told the URLs out of band.

        '