NovumOS Invitations API

The invitations API from NovumOS — 3 operation(s) for invitations.

GitHub OpenAPI

Operations 3

GET /v1/me/invitations List My Invitations #
POST /v1/invitations/{invitation_id}:accept Accept Invitation #
POST /v1/invitations/{invitation_id}:decline Decline Invitation #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/novumos-app:novumos-app-invitations-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

novumos-app-invitations-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: NovumOS Invitations API
  description: Block-based kanban where agents are first-class users.
  version: 0.0.0
tags:
- name: Invitations
paths:
  /v1/me/invitations:
    get:
      tags:
      - Invitations
      summary: List My Invitations
      description: 'Live invitations addressed to the signed-in account, across every workspace.


        This is the in-app half of §4.8''s "if the address already has an account,

        the invitation surfaces in-app on their next load *and* by email" — the

        email can be lost, filtered, or read on a phone, and the invitation still

        has to be findable. Each row carries ``org_name`` because the caller does

        not belong to the inviting workspace and has no other way to learn what they

        are being asked to join.


        Only pending, unexpired invitations appear; the list never offers something

        accept would refuse.'
      operationId: list_my_invitations_v1_me_invitations_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedResponse_InvitationResponse_'
      security:
      - IntegrationToken: []
      parameters:
      - name: X-Board-Version
        in: header
        required: true
        schema:
          type: string
          default: '2026-06-19'
        description: Required on every `/v1` request. Send `2026-06-19`. The middleware validates *presence*, not the value, so an older pinned date keeps working; `Notion-Version` is accepted as a Notion-SDK compatibility fallback when this header is absent.
  /v1/invitations/{invitation_id}:accept:
    post:
      tags:
      - Invitations
      summary: Accept Invitation
      description: 'Accept an invitation — the moment the membership and the seat exist (§4.8).


        Requires being signed in as the invited address; anything else is ``404``,

        never ``403``, so a guessed id tells a stranger nothing. Returns the

        membership just created, which is what the client needs to switch into the

        new workspace.


        ``402 plan_limit_reached`` when accepting would breach the workspace''s free

        -tier seat cap: pending invitations hold no seat, so the cap is only truly

        decidable here, inside the per-org seat lock.'
      operationId: accept_invitation_v1_invitations__invitation_id__accept_post
      parameters:
      - name: invitation_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Invitation Id
      - name: X-Board-Version
        in: header
        required: true
        schema:
          type: string
          default: '2026-06-19'
        description: Required on every `/v1` request. Send `2026-06-19`. The middleware validates *presence*, not the value, so an older pinned date keeps working; `Notion-Version` is accepted as a Notion-SDK compatibility fallback when this header is absent.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MembershipResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - IntegrationToken: []
  /v1/invitations/{invitation_id}:decline:
    post:
      tags:
      - Invitations
      summary: Decline Invitation
      description: 'Decline an invitation. Terminal, and it never touched a seat (§4.8).


        Same authorization as accept. Declining is deliberately a real, recorded

        action rather than an ignore: the workspace''s admin sees the pending row

        clear, and the ``(org_id, lower(email))`` uniqueness slot frees up so they

        can invite again later.'
      operationId: decline_invitation_v1_invitations__invitation_id__decline_post
      parameters:
      - name: invitation_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Invitation Id
      - name: X-Board-Version
        in: header
        required: true
        schema:
          type: string
          default: '2026-06-19'
        description: Required on every `/v1` request. Send `2026-06-19`. The middleware validates *presence*, not the value, so an older pinned date keeps working; `Notion-Version` is accepted as a Notion-SDK compatibility fallback when this header is absent.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvitationResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - IntegrationToken: []
components:
  schemas:
    InvitationResponse:
      properties:
        object:
          type: string
          title: Object
          default: invitation
        id:
          type: string
          format: uuid
          title: Id
        org_id:
          type: string
          format: uuid
          title: Org Id
        org_name:
          anyOf:
          - type: string
          - type: 'null'
          title: Org Name
        email:
          type: string
          title: Email
        role:
          type: string
          title: Role
        status:
          type: string
          title: Status
        invited_by_user_id:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Invited By User Id
        board_id:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Board Id
        board_role:
          anyOf:
          - type: string
          - type: 'null'
          title: Board Role
        board_name:
          anyOf:
          - type: string
          - type: 'null'
          title: Board Name
        last4:
          anyOf:
          - type: string
          - type: 'null'
          title: Last4
        expires_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Expires At
        created_time:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Created Time
        accepted_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Accepted At
        declined_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Declined At
        revoked_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Revoked At
      type: object
      required:
      - id
      - org_id
      - email
      - role
      - status
      title: InvitationResponse
      description: 'One invitation, as the inviting workspace and the invitee both see it.


        Deliberately **never** carries the token — the raw token exists exactly once,

        in the email that was sent, and is not recoverable afterwards (only its

        argon2id hash is stored). ``last4`` is included so an admin can correlate a

        row with a support request without the token being disclosed, mirroring

        ``ShareLinkResponse``.


        ``org_name`` is populated on the invitee-facing reads

        (``GET /v1/me/invitations``, accept/decline) because an invitee looking at a

        workspace they have not joined has no other way to learn what they are being

        asked to join; the admin-facing list leaves it ``None`` (the caller already

        knows which workspace they are in).'
    PaginatedResponse_InvitationResponse_:
      properties:
        object:
          type: string
          title: Object
          default: list
        results:
          items:
            $ref: '#/components/schemas/InvitationResponse'
          type: array
          title: Results
        has_more:
          type: boolean
          title: Has More
          default: false
        next_cursor:
          anyOf:
          - type: string
          - type: 'null'
          title: Next Cursor
        page_size:
          type: integer
          title: Page Size
          default: 25
      type: object
      required:
      - results
      title: PaginatedResponse[InvitationResponse]
    MembershipResponse:
      properties:
        object:
          type: string
          title: Object
          default: membership
        id:
          type: string
          format: uuid
          title: Id
        user_id:
          type: string
          format: uuid
          title: User Id
        org_id:
          type: string
          format: uuid
          title: Org Id
        role:
          type: string
          title: Role
        email:
          anyOf:
          - type: string
          - type: 'null'
          title: Email
        name:
          anyOf:
          - type: string
          - type: 'null'
          title: Name
        kind:
          type: string
          title: Kind
          default: human
        joined_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Joined At
        last_signed_in_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Last Signed In At
      type: object
      required:
      - id
      - user_id
      - org_id
      - role
      title: MembershipResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
  securitySchemes:
    IntegrationToken:
      type: http
      scheme: bearer
      description: 'Integration token. Mint one in the app under **Settings → Integrations** and paste the `nov_…` value here. It is sent as `Authorization: Bearer nov_…`, the same credential the API enforces. Browser session cookies are NOT used by try-it-out (the cookie flow additionally requires an `X-CSRF-Token` header this page cannot mint).'