> ## Documentation Index
> Fetch the complete documentation index at: https://docs.portalhq.io/llms.txt
> Use this file to discover all available pages before exploring further.

# List audit event types

> Retrieve every audit event type that can appear in
`GET /custodians/me/audit-events`, with a human-readable label and the kind of
resource each event's `resourceId` refers to. These `type` values are the valid
values for that endpoint's `eventTypes` filter.




## OpenAPI

````yaml /openapi/custodian-api.yaml get /custodians/me/audit-events/types
openapi: 3.1.0
info:
  title: Portal Custodian API
  version: '3.0'
  description: >
    The Portal Custodian API provides endpoints for managing clients, building
    transactions,

    retrieving wallet data, managing delegations, alert webhooks and gas
    sponsorship, and

    reading the Portal Dashboard audit log.

    All endpoints require authentication via a Portal API Key (also known as a
    Custodian API Key)

    passed as a Bearer token.


    ## Base URL

    `https://api.portalhq.io/api/v3`


    ## Authentication

    Include your Portal API Key as a Bearer token in the `Authorization` header
    of every request.


    ## Chain ID Format

    Chain parameters use either friendly names (e.g. `ethereum`, `solana`) or
    CAIP-2 format

    (e.g. `eip155:1`, `solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp`). When using
    CAIP-2 format

    in URLs, ensure the colon is URI-encoded (`%3A`).
servers:
  - url: https://api.portalhq.io/api/v3
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Clients
    description: Create and manage Portal clients
  - name: Transactions
    description: Build and evaluate blockchain transactions
  - name: Wallet Metadata
    description: Retrieve wallet balances and NFTs
  - name: Wallet Shares
    description: Manage backup shares and wallet ejection
  - name: Delegations
    description: Manage token delegations and delegated transfers
  - name: Session Keys
    description: Build and send EIP-7702 session key user operations
  - name: Alert Webhooks
    description: Manage alert webhooks, external addresses, and replay failed events
  - name: Gas Sponsorship
    description: View and manage gas sponsorship across chains
  - name: Due
    description: Manage Due webhook endpoints and deliveries
  - name: Audit Events
    description: Read the audit log of actions taken in the Portal Dashboard
paths:
  /custodians/me/audit-events/types:
    get:
      tags:
        - Audit Events
      summary: List audit event types
      description: >
        Retrieve every audit event type that can appear in

        `GET /custodians/me/audit-events`, with a human-readable label and the
        kind of

        resource each event's `resourceId` refers to. These `type` values are
        the valid

        values for that endpoint's `eventTypes` filter.
      operationId: listAuditEventTypes
      responses:
        '200':
          description: Audit event types retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuditEventTypesResponse'
              example:
                results:
                  - type: custodian:update
                    label: Updated organization settings
                    resourceNoun: organization
                  - type: alert-webhook:create
                    label: Created an alert webhook
                    resourceNoun: alert webhook
                  - type: member:invite
                    label: Invited a member
                    resourceNoun: member
        '401':
          description: Unauthorized - invalid or missing authentication token
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    AuditEventTypesResponse:
      type: object
      required:
        - results
      properties:
        results:
          type: array
          items:
            $ref: '#/components/schemas/AuditEventType'
    ErrorResponse:
      type: object
      properties:
        error:
          type: string
          description: Error message describing what went wrong
    AuditEventType:
      type: object
      required:
        - type
        - label
        - resourceNoun
      properties:
        type:
          type: string
          description: The audit event type, in `resource:action` form.
        label:
          type: string
          description: A human-readable description of the action.
        resourceNoun:
          type: string
          description: The kind of resource the event's `resourceId` refers to.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: |
        Portal API Key (Custodian API Key). Pass as a Bearer token in the
        Authorization header.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.