Cavuno Audit logs API

openapi: 3.2.0
info:
  title: Cavuno v1 REST Audit logs 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: Audit Logs
  description: Read your account audit-log entries.
paths:
  /audit-logs:
    get:
      summary: List audit log entries
      description: 'Returns who changed what on your board, newest first: the same entries as the Audit log page in Settings, with the same filters. Use it to answer "what changed" and "who did it". The audit log is available on the Grow plan (last 90 days) and on Advanced and higher (full history). Requires the `audit.read` permission, which owners and admins hold.'
      parameters:
      - schema:
          type: string
          enum:
          - user_session
          - api_key
          - oauth_token
          - board_user
          - system
          - companion
          description: Only return entries made by this kind of actor.
        required: false
        description: Only return entries made by this kind of actor.
        name: actorType
        in: query
      - schema:
          type: string
          enum:
          - job
          - company
          - blog_post
          - blog_tag
          - blog_author
          - feed
          - employer
          - candidate
          - subscriber
          - invitation
          - member
          - settings
          - page
          - email
          - custom_domain
          - email_domain
          - redirect
          - plan
          - coupon
          - webhook
          - api_key
          - integration
          - indexing
          - import_batch
          - invoice
          - backfill
          - inbox_ticket
          description: Only return entries about this kind of record, the same choices as the Audit log page in Settings.
        required: false
        description: Only return entries about this kind of record, the same choices as the Audit log page in Settings.
        name: resourceType
        in: query
      - schema:
          type: string
          format: date-time
          description: Only return entries at or after this time. ISO 8601 datetime. On the Grow plan entries older than 90 days are never returned.
        required: false
        description: Only return entries at or after this time. ISO 8601 datetime. On the Grow plan entries older than 90 days are never returned.
        name: from
        in: query
      - schema:
          type: string
          format: date-time
          description: Only return entries at or before this time. ISO 8601 datetime.
        required: false
        description: Only return entries at or before this time. ISO 8601 datetime.
        name: to
        in: query
      - schema:
          type: string
          minLength: 1
          description: An opaque pagination cursor returned in the `nextCursor` field of a previous response.
        required: false
        description: An opaque pagination cursor returned in the `nextCursor` field of a previous response.
        name: cursor
        in: query
      - schema:
          type: integer
          minimum: 1
          maximum: 50
          description: A limit on the number of objects to be returned. Limit can range between 1 and 50, and the default is 25.
        required: false
        description: A limit on the number of objects to be returned. Limit can range between 1 and 50, and the default is 25.
        example: 25
        name: limit
        in: query
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                type: object
                properties:
                  object:
                    type: string
                    enum:
                    - list
                  url:
                    type: string
                    example: /v1/audit-logs
                  hasMore:
                    type: boolean
                  nextCursor:
                    type:
                    - string
                    - 'null'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/AuditLogEntry'
                required:
                - object
                - url
                - hasMore
                - nextCursor
                - data
        '400':
          description: The request was malformed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Missing the `audit.read` permission (`audit_log_forbidden`), or the board’s plan does not include the audit log (`audit_log_plan_required`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-audience: operator
      tags:
      - Audit Logs
      operationId: listAuditLogs
  /audit-logs/{id}:
    get:
      summary: Retrieve an audit log entry
      description: Retrieves one audit log entry with the changed fields before and after the change, as the entry’s detail panel in Settings shows them. An entry older than the plan’s retention window is not found.
      parameters:
      - schema:
          type: string
          minLength: 1
          description: The audit log entry ID returned by the list endpoint.
        required: true
        description: The audit log entry ID returned by the list endpoint.
        name: id
        in: path
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuditLogEntryDetail'
        '403':
          description: Missing the `audit.read` permission (`audit_log_forbidden`), or the board’s plan does not include the audit log (`audit_log_plan_required`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Audit log entry not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-audience: operator
      tags:
      - Audit Logs
      operationId: getAuditLog
components:
  schemas:
    AuditLogEntryDetail:
      allOf:
      - $ref: '#/components/schemas/AuditLogEntry'
      - type: object
        properties:
          userAgent:
            type:
            - string
            - 'null'
            description: Browser or client that made the change, or `null` when unknown.
          before:
            type:
            - string
            - 'null'
            description: The changed fields before the change, as a JSON string, or `null` (for example on create). Secrets are replaced with `[REDACTED]`; a value over 4 KB is cut short and ends with `…[truncated]`.
          after:
            type:
            - string
            - 'null'
            description: The changed fields after the change, as a JSON string, or `null` (for example on delete). Same redaction and size rules as `before`.
        required:
        - userAgent
        - before
        - after
    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.'
    AuditLogEntry:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the entry.
        object:
          type: string
          enum:
          - audit_log
          description: String representing the object's type. Objects of the same type share the same value.
        createdAt:
          type: string
          description: When the change was made. ISO 8601 datetime.
        actorType:
          type: string
          enum:
          - user_session
          - api_key
          - oauth_token
          - board_user
          - system
          - companion
          description: 'Who made the change: `user_session` (a team member in the dashboard), `api_key` (an API key), `oauth_token` (an app or agent connected with OAuth), `board_user` (a job seeker or employer on your board), `system` (Cavuno on your behalf) or `companion` (Cavuno Companion, acting for a team member with their permission).'
        actorLabel:
          type: string
          description: 'Who made the change, as shown on the Audit log page: a member’s name or email, an API key’s name, or an app’s name.'
        action:
          type: string
          description: What was done, as a stable machine-readable name such as `jobs.create` or `settings.update`.
        summary:
          type: string
          description: The action in plain English, such as "Created a job".
        resourceType:
          type: string
          description: The kind of record that changed, such as `job`, `company` or `settings`.
        resourceId:
          type:
          - string
          - 'null'
          description: ID of the record that changed, or `null` when the change has no single record.
        ipAddress:
          type:
          - string
          - 'null'
          description: IP address the change was made from, or `null` when unknown.
      required:
      - id
      - object
      - createdAt
      - actorType
      - actorLabel
      - action
      - summary
      - resourceType
      - resourceId
      - ipAddress
    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