Cavuno Invitations API

openapi: 3.2.0
info:
  title: Cavuno v1 REST Invitations API
  version: 1.0.0
  description: 'The Cavuno API is organized around REST. Our API has predictable resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs. ## Base URL


    Production: `https://api.cavuno.com/v1`


    All API requests must be made over HTTPS. Calls made over plain HTTP will fail. ## Authentication


    The Cavuno API uses API keys to authenticate requests. You can view and manage your API keys in the Cavuno dashboard, under Settings → Developer → API keys. Cavuno API keys have the prefix `cavuno_live_`. Your API keys carry many privileges, so be sure to keep them secure. Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth. Authentication to the API is performed via Bearer auth. Provide your API key as the bearer token in the `Authorization` header:


    ```bash

    curl https://api.cavuno.com/v1/jobs \

    -H "Authorization: Bearer YOUR_SECRET_API_KEY"

    ```


    API requests without authentication will fail. ## Rate limits


    The Cavuno API has rate limits in place to ensure stability and reliability. By default, API keys are limited to 100 requests per minute. If you exceed your limit, requests return an HTTP 429 response with a `Retry-After` header indicating when you can try again. If you have a use case that needs a higher limit, contact support. ## Idempotency


    The API supports idempotency for safely retrying requests without accidentally performing the same operation twice. For example, if a request to create a job fails due to a network connection error, you can safely retry the request with the same idempotency key, and we''ll guarantee that only one job is created. To perform an idempotent request, provide an additional `Idempotency-Key` header on any `POST`, `PATCH`, or `DELETE` request:


    ```bash

    curl https://api.cavuno.com/v1/jobs \

    -X POST \

    -H "Authorization: Bearer cavuno_live_..." \

    -H "Idempotency-Key: $(uuidgen)" \

    -H "Content-Type: application/json" \

    -d ''{ "title": "Senior Engineer" }''

    ```


    ## Errors


    Cavuno uses conventional HTTP response codes to indicate the success or failure of an API request. In general: codes in the `2xx` range indicate success, codes in the `4xx` range indicate an error that failed given the information provided (e.g., a required parameter was omitted), and codes in the `5xx` range indicate an error with Cavuno''s servers (these are rare). Error responses include a JSON body with details:


    ```json

    {

    "error": {

    "code": "validation_bad_request",

    "message": "Field ''title'' is required.",

    "requestId": "req_..."

    }

    }

    ```


    Some errors carry an additional `details` field with structured context, such as per-field validation issues. ### Plan upgrade hints


    When an Operator API request is refused because of the board''s Cavuno plan, the error also carries an `upgrade` object. It names the capability that blocked the request, the cheapest self-serve plan that unlocks it (when that can be told), and the hosted billing endpoints that start the upgrade:


    ```json

    {

    "error": {

    "code": "settings_plan_required_for_branding_removal",

    "message": "Removing Cavuno branding requires a plan that includes branding removal.",

    "requestId": "req_...",

    "upgrade": {

    "capability": "canRemoveBranding",

    "requiredPlan": "basic",

    "checkout": { "method": "POST", "path": "/v1/billing/checkout" },

    "changePlan": { "method": "POST", "path": "/v1/billing/upgrade" }

    }

    }

    }

    ```


    Call `GET /v1/billing/subscription` first. With no active subscription, use `checkout`; with one, use `changePlan`. Send `{ "planKey": "" }` and give the returned `url` to a person: both endpoints return a hosted page where a person confirms the purchase. Nothing is charged until they do. Each `path` is relative to the API origin (`https://api.cavuno.com`), like `Location` headers and list `url` fields, so do not join it to a base URL that already ends in `/v1`.'
  contact:
    name: Cavuno
    url: https://cavuno.com
servers:
- url: https://api.cavuno.com/v1
  description: Production
security:
- bearerAuth: []
tags:
- name: Invitations
  description: Create, list, renew, and accept account invitations.
paths:
  /invitations:
    get:
      summary: List invitations
      description: Returns the invitations for the authenticated account, optionally filtered by status. The accept `token` is never included in list responses.
      parameters:
      - schema:
          type: string
          minLength: 1
          description: Pagination cursor.
        required: false
        description: Pagination cursor.
        name: cursor
        in: query
      - schema:
          type: integer
          minimum: 1
          maximum: 100
          description: Page size (1–100, default 50).
        required: false
        description: Page size (1–100, default 50).
        name: limit
        in: query
      - schema:
          type: string
          enum:
          - pending
          - expired
          - accepted
          - declined
          description: Filter the returned invitations by status.
        required: false
        description: Filter the returned invitations by status.
        name: status
        in: query
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                type: object
                properties:
                  object:
                    type: string
                    enum:
                    - list
                  url:
                    type: string
                    example: /v1/invitations
                  hasMore:
                    type: boolean
                  nextCursor:
                    type:
                    - string
                    - 'null'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Invitation'
                required:
                - object
                - url
                - hasMore
                - nextCursor
                - data
        default:
          description: An error. Every non-2xx response uses the same envelope; see the Errors section of the introduction.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-audience: operator
      tags:
      - Invitations
      operationId: listInvitations
    post:
      summary: Create an invitation
      description: Invites a new member by email and sends the invitation email. The response includes the accept `token` and `acceptUrl` (returned only on create and renew).
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateInvitationBody'
      responses:
        '201':
          description: The invitation was created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvitationWithToken'
        '403':
          description: Team seat limit reached.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: The email already belongs to a member.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-audience: operator
      tags:
      - Invitations
      operationId: createInvitation
  /invitations/{id}:
    get:
      summary: Retrieve an invitation
      description: Retrieves an invitation by ID. The accept token is not included; it is returned only when you create or renew an invitation.
      parameters:
      - schema:
          type: string
          minLength: 1
          description: The invitation ID.
        required: true
        description: The invitation ID.
        name: id
        in: path
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Invitation'
        '404':
          description: Invitation not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-audience: operator
      tags:
      - Invitations
      operationId: getInvitation
    patch:
      summary: Update an invitation
      description: Changes a pending invitation's role.
      parameters:
      - schema:
          type: string
          minLength: 1
          description: The invitation ID.
        required: true
        description: The invitation ID.
        name: id
        in: path
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateInvitationBody'
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Invitation'
        '404':
          description: Invitation not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: The invitation is no longer pending.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-audience: operator
      tags:
      - Invitations
      operationId: updateInvitation
    delete:
      summary: Delete an invitation
      description: Cancels a pending invitation.
      parameters:
      - schema:
          type: string
          minLength: 1
          description: The invitation ID.
        required: true
        description: The invitation ID.
        name: id
        in: path
      responses:
        '200':
          description: The invitation was cancelled.
        '404':
          description: Invitation not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-audience: operator
      tags:
      - Invitations
      operationId: deleteInvitation
  /invitations/{id}/renew:
    post:
      summary: Renew an invitation
      description: Rotates the accept token and extends the expiry by 7 days. The response includes the new token and `acceptUrl`.
      parameters:
      - schema:
          type: string
          minLength: 1
          description: The invitation ID.
        required: true
        description: The invitation ID.
        name: id
        in: path
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvitationWithToken'
        '404':
          description: Invitation not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: An already-accepted invitation cannot be renewed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-audience: operator
      tags:
      - Invitations
      operationId: renewInvitation
  /invitations/{id}/accept:
    post:
      summary: Accept an invitation
      description: Accepts an invitation by its token (passed as the path segment). Session-authenticated only. The accepting user joins the invitation’s account. The caller’s email must match the invitation.
      parameters:
      - schema:
          type: string
          minLength: 1
          description: The invitation ID.
        required: true
        description: The invitation ID.
        name: id
        in: path
      responses:
        '200':
          description: The invitation was accepted.
        '403':
          description: The email does not match the invitation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Invitation not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: The invitation is no longer pending.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '410':
          description: The invitation has expired.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-audience: operator
      tags:
      - Invitations
      operationId: acceptInvitation
components:
  schemas:
    Invitation:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the invitation.
        object:
          type: string
          enum:
          - invitation
          description: String representing the object's type.
        email:
          type: string
          description: The invited email address.
        role:
          type: string
          description: The role the invitee will receive on accept.
        status:
          type: string
          description: 'The invitation status: pending, expired, accepted, declined.'
        expiresAt:
          type: string
          description: ISO-8601 timestamp of when the invitation expires.
        invitedByUserId:
          type:
          - string
          - 'null'
          description: Identifier of the user who created the invitation.
        createdAt:
          type: string
          description: ISO-8601 timestamp of when the invitation was created.
      required:
      - id
      - object
      - email
      - role
      - status
      - expiresAt
      - invitedByUserId
      - createdAt
    CreateInvitationBody:
      type: object
      properties:
        email:
          type: string
          format: email
          description: The email address to invite.
        role:
          type: string
          enum:
          - admin
          - member
          description: The role the invitee receives on accept.
      required:
      - email
      - role
    UpdateInvitationBody:
      type: object
      properties:
        role:
          type: string
          enum:
          - admin
          - member
          description: The new role for the pending invitation.
      required:
      - role
    InvitationWithToken:
      allOf:
      - $ref: '#/components/schemas/Invitation'
      - type: object
        properties:
          token:
            type: string
            description: The opaque accept token.
          acceptUrl:
            type: string
            description: The full URL a recipient uses to accept the invitation.
        required:
        - token
        - acceptUrl
    PlanUpgradeHint:
      type: object
      properties:
        capability:
          type: string
          enum:
          - activeJobsLimit
          - teamSeatLimit
          - canBePublic
          - canRemoveBranding
          - apiAccess
          description: The plan capability that blocked the request, named as in `GET /v1/billing/subscription` `capabilities`.
        requiredPlan:
          type: string
          enum:
          - starter
          - basic
          - grow
          - advanced
          - scale
          description: The cheapest self-serve plan that unlocks the action. Pass it as `planKey`. Omitted when it cannot be told without more information; read `GET /v1/billing/subscription` and pick a higher plan.
        checkout:
          type: object
          properties:
            method:
              type: string
              enum:
              - POST
            path:
              type: string
              enum:
              - /v1/billing/checkout
          required:
          - method
          - path
          description: Starts a hosted checkout when the board has no active subscription (for example during a trial).
        changePlan:
          type: object
          properties:
            method:
              type: string
              enum:
              - POST
            path:
              type: string
              enum:
              - /v1/billing/upgrade
          required:
          - method
          - path
          description: Starts a hosted plan change when the board already has an active subscription.
      required:
      - capability
      - checkout
      - changePlan
      description: 'Present only on Operator API errors caused by the board''s Cavuno plan. Read `GET /v1/billing/subscription` to choose between `checkout` and `changePlan`, call it with `{ "planKey": requiredPlan }`, and give the returned `url` to a person to confirm. Each `path` is relative to the API origin, not to a `/v1` base URL. Both endpoints need `billing.manage`. Board API errors never include it.'
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              description: Machine-readable error code, such as `validation_bad_request` or `jobs_not_found`.
            message:
              type: string
              description: Human-readable explanation.
            requestId:
              type: string
              description: Unique id for this request. Include it when contacting support.
            details:
              description: Structured context for some errors, such as per-field validation issues.
            upgrade:
              $ref: '#/components/schemas/PlanUpgradeHint'
          required:
          - code
          - message
          - requestId
      required:
      - error
      description: The error envelope returned by every non-2xx response.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: cavuno_live_<keyId>_<secret>
      description: Use your secret API key to authenticate. Pass it as a Bearer token in the `Authorization` header. You can view and manage your API keys in the Cavuno dashboard.
externalDocs:
  description: Cavuno API reference
  url: https://cavuno.com/docs/api