Cavuno Members API

openapi: 3.2.0
info:
  title: Cavuno v1 REST Members 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: Members
  description: List, update, suspend, and remove team members, and read roles and permissions.
paths:
  /members:
    get:
      summary: List members
      description: Returns the members of the authenticated account, optionally filtered by role.
      parameters:
      - schema:
          type: string
          enum:
          - owner
          - admin
          - member
          description: Filter the returned members by role.
        required: false
        description: Filter the returned members by role.
        name: role
        in: query
      - schema:
          type: string
          enum:
          - 'true'
          - 'false'
          description: 'Filter by suspension state: `true` or `false`.'
        required: false
        description: 'Filter by suspension state: `true` or `false`.'
        name: suspended
        in: query
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                type: object
                properties:
                  object:
                    type: string
                    enum:
                    - list
                  url:
                    type: string
                    example: /v1/members
                  hasMore:
                    type: boolean
                  nextCursor:
                    type:
                    - string
                    - 'null'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Member'
                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:
      - Members
      operationId: listMembers
  /members/transfer-ownership:
    post:
      summary: Transfer account ownership
      description: Transfers the primary-owner role to another member. Only the current primary owner may call this. The current owner is demoted to admin and the new owner is promoted.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TransferOwnershipBody'
      responses:
        '200':
          description: Ownership transferred.
        '403':
          description: Only the primary owner can transfer ownership.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: The new owner must already be a member.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: Cannot transfer ownership to a suspended member.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-audience: operator
      tags:
      - Members
      operationId: transferAccountOwnership
  /members/me:
    delete:
      summary: Leave the account
      description: The authenticated user leaves the account. Session-authenticated only (api_key / oauth_token actors are rejected). The account owner cannot leave. Transfer ownership first.
      responses:
        '200':
          description: You left the account.
        '403':
          description: Only a session-authenticated user can leave.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: You are not a member of this account.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: The account owner cannot leave.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-audience: operator
      tags:
      - Members
      operationId: leaveAccount
  /members/{userId}:
    get:
      summary: Retrieve a member
      description: Retrieves a single member of the authenticated account by their user ID. Members of other accounts are invisible and return `members_not_found`.
      parameters:
      - schema:
          type: string
          minLength: 1
          description: The user ID of the member.
        required: true
        description: The user ID of the member.
        name: userId
        in: path
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Member'
        '404':
          description: Member not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-audience: operator
      tags:
      - Members
      operationId: getMember
    patch:
      summary: Update a member
      description: Updates a member's role. The primary owner's role cannot be changed here (use transfer-ownership), and only an owner may promote a member to owner.
      parameters:
      - schema:
          type: string
          minLength: 1
          description: The user ID of the member.
        required: true
        description: The user ID of the member.
        name: userId
        in: path
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateMemberBody'
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Member'
        '403':
          description: Only an owner can promote to owner.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Member not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: Cannot change the primary owner role.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-audience: operator
      tags:
      - Members
      operationId: updateMember
    delete:
      summary: Remove a member
      description: Removes a member from the account. The account owner cannot be removed. Transfer ownership first.
      parameters:
      - schema:
          type: string
          minLength: 1
          description: The user ID of the member.
        required: true
        description: The user ID of the member.
        name: userId
        in: path
      responses:
        '200':
          description: The member was removed.
        '404':
          description: Member not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: Cannot remove the account owner.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-audience: operator
      tags:
      - Members
      operationId: deleteMember
  /members/{userId}/suspend:
    post:
      summary: Suspend a member
      description: 'Suspends a member: they keep their role but lose all permission evaluations. The primary owner cannot be suspended.'
      parameters:
      - schema:
          type: string
          minLength: 1
          description: The user ID of the member.
        required: true
        description: The user ID of the member.
        name: userId
        in: path
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Member'
        '404':
          description: Member not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: Cannot suspend the account primary owner.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-audience: operator
      tags:
      - Members
      operationId: suspendMember
  /members/{userId}/unsuspend:
    post:
      summary: Unsuspend a member
      description: Reinstates a suspended member.
      parameters:
      - schema:
          type: string
          minLength: 1
          description: The user ID of the member.
        required: true
        description: The user ID of the member.
        name: userId
        in: path
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Member'
        '404':
          description: Member not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: Cannot suspend the account primary owner.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-audience: operator
      tags:
      - Members
      operationId: unsuspendMember
components:
  schemas:
    UpdateMemberBody:
      type: object
      properties:
        role:
          type: string
          enum:
          - owner
          - admin
          - member
          description: The new role. Only an owner may set `owner`; the primary owner’s role is immutable (use transfer-ownership).
      required:
      - role
    TransferOwnershipBody:
      type: object
      properties:
        newOwnerUserId:
          type: string
          minLength: 1
          description: The user ID of the member who will become the primary owner.
      required:
      - newOwnerUserId
    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.'
    Member:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the membership.
        object:
          type: string
          enum:
          - member
          description: String representing the object's type.
        userId:
          type: string
          description: Identifier of the user behind the member.
        email:
          type: string
          description: The member's email address.
        name:
          type: string
          description: The member's display name.
        avatarUrl:
          type:
          - string
          - 'null'
          description: URL of the member's avatar, or `null` if none is set.
        role:
          type: string
          description: The member's role in the account.
        suspended:
          type: boolean
          description: Whether the member is currently suspended.
        joinedAt:
          type: string
          description: ISO-8601 timestamp of when the member joined the account.
        isPrimaryOwner:
          type: boolean
          description: Whether the member is the account primary owner.
      required:
      - id
      - object
      - userId
      - email
      - name
      - avatarUrl
      - role
      - suspended
      - joinedAt
      - isPrimaryOwner
    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