invoicepdfs-com Audit Log API

openapi: 3.2.0
info:
  title: Invoicepdfs Com Audit Log API
  version: 0.3.0
  contact:
    name: InvoicePDFs
    url: https://invoicepdfs.com/
  license:
    name: MIT
  description: 'Operations tagged audit-log across 2 of this provider''s published API definitions: openapi.json, invoicepdfs-com-openapi.json. Each path carries the servers of the definition it was published in.'
tags:
- name: Audit Log
paths:
  /api/v1/audit-events:
    get:
      tags:
      - Audit Log
      summary: List Audit Events
      description: 'Who changed what on this account, newest first.


        Filter by `action`, `resource_type` and `resource_id` to follow a single

        object''s history.'
      operationId: list_audit_events
      security:
      - HTTPBearer: []
      parameters:
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          maximum: 100
          minimum: 1
          default: 50
          title: Limit
      - name: cursor
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Cursor
      - name: action
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Action
      - name: resource_type
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Resource Type
      - name: resource_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Resource Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuditEventsListResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
      x-visibility: public
  /api/v1/audit-events/{audit_event_id}:
    get:
      tags:
      - Audit Log
      summary: Get Audit Event
      description: One audit event by id.
      operationId: get_audit_event
      security:
      - HTTPBearer: []
      parameters:
      - name: audit_event_id
        in: path
        required: true
        schema:
          type: string
          title: Audit Event Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuditEventResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
      x-visibility: public
components:
  schemas:
    AuditEventOut:
      properties:
        id:
          type: string
          title: Id
        actor:
          type: string
          title: Actor
        action:
          type: string
          title: Action
        resource_type:
          type: string
          title: Resource Type
        resource_id:
          type: string
          title: Resource Id
        workspace_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Workspace Id
        ip_address:
          anyOf:
          - type: string
          - type: 'null'
          title: Ip Address
        user_agent:
          anyOf:
          - type: string
          - type: 'null'
          title: User Agent
        request_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Request Id
        summary:
          anyOf:
          - type: string
          - type: 'null'
          title: Summary
        created_at:
          type: string
          title: Created At
      type: object
      required:
      - id
      - actor
      - action
      - resource_type
      - resource_id
      - created_at
      title: AuditEventOut
    AuditEventsListResponse:
      properties:
        data:
          items:
            $ref: '#/components/schemas/AuditEventOut'
          type: array
          title: Data
        pagination:
          $ref: '#/components/schemas/CursorPagination'
      type: object
      required:
      - data
      title: AuditEventsListResponse
    AuditEventResponse:
      properties:
        data:
          $ref: '#/components/schemas/AuditEventOut'
      type: object
      required:
      - data
      title: AuditEventResponse
    CursorPagination:
      properties:
        has_more:
          type: boolean
          title: Has More
          default: false
        next_cursor:
          anyOf:
          - type: string
          - type: 'null'
          title: Next Cursor
      type: object
      title: CursorPagination
    ApiErrorResponse:
      type: object
      title: ApiErrorResponse
      properties:
        error:
          type: object
          properties:
            status:
              type: integer
              example: 422
              description: HTTP status, mirroring the response status line.
            code:
              type: string
              example: unprocessable_entity
            message:
              type: string
              example: Request validation failed
            request_id:
              type: string
              nullable: true
              description: Trace id for this request; also returned as X-Trace-Id.
            details:
              type: object
              nullable: true
              description: Error-specific context. Validation failures carry `fields`.
          required:
          - status
          - code
          - message
      required:
      - error
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer
x-refined-from:
- openapi.json
- invoicepdfs-com-openapi.json
x-internal-tags:
- auth
- jobs
- logs