PixieBrix

PixieBrix Audit API

The audit API from PixieBrix — 3 operation(s) for audit.

GitHub OpenAPI

Operations 3

GET /api/audit/organizations/{id}/ #
GET /api/audit/groups/{id}/ #
GET /api/audit/deployments/{id}/ #

Documentation

📖
Documentation
https://docs.pixiebrix.com/developer-api
📖
APIReference
https://app.pixiebrix.com/api/docs/
📖
GettingStarted
https://docs.pixiebrix.com/developer-api/making-an-api-request
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/pixiebrix/refs/heads/main/authentication/pixiebrix-authentication.yml
📖
RateLimits
https://raw.githubusercontent.com/api-evangelist/pixiebrix/refs/heads/main/rate-limits/pixiebrix-rate-limits.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/pixiebrix/refs/heads/main/openapi/pixiebrix-audit-api-openapi.yml

Other Resources

🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/pixiebrix/refs/heads/main/conventions/pixiebrix-conventions.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/pixiebrix/refs/heads/main/errors/pixiebrix-problem-types.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/pixiebrix/refs/heads/main/data-model/pixiebrix-data-model.yml

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/pixiebrix-audit-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

GitHub Google LinkedIn

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

OpenAPI Specification

pixiebrix-audit-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: PixieBrix Audit API
  version: 1.0.0
  description: PixieBrix admin and package registry API
  contact:
    name: PixieBrix Support
    email: support@pixiebrix.com
servers:
- url: https://app.pixiebrix.com
tags:
- name: audit
paths:
  /api/audit/organizations/{id}/:
    get:
      operationId: listAuditEvents
      description: Return the audit-event history for an organization (membership changes, role changes, and similar administrative actions), newest first.
      parameters:
      - name: id
        in: path
        required: true
        description: ''
        schema:
          type: string
      - name: page
        required: false
        in: query
        description: A page number within the paginated result set.
        schema:
          type: integer
      - name: page_size
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      responses:
        '200':
          content:
            application/json; version=2.0:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AuditEvent'
            application/vnd.pixiebrix.api+json; version=2.0:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AuditEvent'
          description: ''
          headers:
            Link:
              schema:
                type: string
              example: '<https://app.pixiebrix.com/audit/organizations/{id}/>; rel="first", <https://app.pixiebrix.com/audit/organizations/{id}/?page=3>; rel="prev", <https://app.pixiebrix.com/audit/organizations/{id}/?page=5>; rel="next", <https://app.pixiebrix.com/audit/organizations/{id}/?page=11>; rel="last"'
              description: See https://datatracker.ietf.org/doc/html/rfc8288 for more information.
      tags:
      - audit
  /api/audit/groups/{id}/:
    get:
      operationId: listAuditGroups
      description: Return the audit-event history for a single resource targeted by the event (such as a group or deployment), newest first.
      parameters:
      - name: id
        in: path
        required: true
        description: ''
        schema:
          type: string
      - name: page
        required: false
        in: query
        description: A page number within the paginated result set.
        schema:
          type: integer
      - name: page_size
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      responses:
        '200':
          content:
            application/json; version=2.0:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AuditEvent'
            application/vnd.pixiebrix.api+json; version=2.0:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AuditEvent'
          description: ''
          headers:
            Link:
              schema:
                type: string
              example: '<https://app.pixiebrix.com/audit/groups/{id}/>; rel="first", <https://app.pixiebrix.com/audit/groups/{id}/?page=3>; rel="prev", <https://app.pixiebrix.com/audit/groups/{id}/?page=5>; rel="next", <https://app.pixiebrix.com/audit/groups/{id}/?page=11>; rel="last"'
              description: See https://datatracker.ietf.org/doc/html/rfc8288 for more information.
      tags:
      - audit
  /api/audit/deployments/{id}/:
    get:
      operationId: listAuditDeployments
      description: Return the audit-event history for a single resource targeted by the event (such as a group or deployment), newest first.
      parameters:
      - name: id
        in: path
        required: true
        description: ''
        schema:
          type: string
      - name: page
        required: false
        in: query
        description: A page number within the paginated result set.
        schema:
          type: integer
      - name: page_size
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      responses:
        '200':
          content:
            application/json; version=2.0:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AuditEvent'
            application/vnd.pixiebrix.api+json; version=2.0:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AuditEvent'
          description: ''
          headers:
            Link:
              schema:
                type: string
              example: '<https://app.pixiebrix.com/audit/deployments/{id}/>; rel="first", <https://app.pixiebrix.com/audit/deployments/{id}/?page=3>; rel="prev", <https://app.pixiebrix.com/audit/deployments/{id}/?page=5>; rel="next", <https://app.pixiebrix.com/audit/deployments/{id}/?page=11>; rel="last"'
              description: See https://datatracker.ietf.org/doc/html/rfc8288 for more information.
      tags:
      - audit
components:
  schemas:
    AuditEvent:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        actor:
          type: object
          properties:
            id:
              type: string
              format: uuid
              readOnly: true
            name:
              type: string
              readOnly: true
            email:
              type: string
              format: email
              maxLength: 254
            service_account:
              type: boolean
              readOnly: true
            deployment_key_account:
              type: boolean
              readOnly: true
            date_joined:
              type: string
              format: date-time
        target_object:
          type: object
          properties:
            id:
              type: string
            content_type:
              type: string
              readOnly: true
            label:
              type: string
              readOnly: true
          required:
          - id
        action_object:
          type: object
          properties:
            id:
              type: string
            content_type:
              type: string
              readOnly: true
            label:
              type: string
              readOnly: true
          required:
          - id
        action_type:
          type: string
          maxLength: 256
        data:
          type:
          - object
          - 'null'
          additionalProperties: true
        timestamp:
          type: string
          format: date-time
          readOnly: true
      required:
      - actor
      - target_object
      - action_object
      - action_type