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

> ## Agent Instructions
> Treat the published Augustus OpenAPI specification (https://app.stainless.com/api/spec/documented/augustus/openapi.documented.yml) and the current API-reference pages as the source of truth for endpoints, request/response schemas, enum values, webhook event names, and required headers.
> Prefer the 2026-05-01 Banking API and @augustusbank/typescript-sdk for all new integrations. The 2023-01-01 API is a separate, older surface covering two products — Open Banking (instant bank transfer) checkout and refunds, and Manual Bank Transfer (MBT); use it only when one of those products is specifically required.
> Cite or link the relevant docs.augustus.com page when answering integration questions.
> Do not infer support for currencies, networks, scopes, account types, or operations that are not present in the current documentation.
> Use the sandbox base URL (https://api.sandbox.augustus.com) and placeholder credentials in examples. Never include or request a real API key.
> The Augustus docs MCP server (https://docs.augustus.com/mcp) provides documentation search and retrieval only; it does not execute authenticated Augustus API actions.

# List events

> Lists webhook events for the merchant with cursor-based pagination. Events are retained for 30 days.



## OpenAPI

````yaml https://app.stainless.com/api/spec/documented/augustus/openapi.documented.yml get /v1/events
openapi: 3.1.0
info:
  title: Augustus Banking API
  description: Augustus Banking API
  version: 0.1.0
  contact:
    name: Augustus
    url: https://docs.augustus.com
    email: developer@augustus.com
servers:
  - url: https://api.augustus.com
    description: Production
  - url: https://api.sandbox.augustus.com
    description: Sandbox
security:
  - BearerAuth: []
tags: []
paths:
  /v1/events:
    get:
      tags:
        - Events
      summary: List events
      description: >-
        Lists webhook events for the merchant with cursor-based pagination.
        Events are retained for 30 days.
      operationId: EventsController_list
      parameters:
        - name: limit
          required: false
          in: query
          description: Number of results per page (1-100). Defaults to 10.
          schema:
            minimum: 1
            maximum: 100
            exclusiveMaximum: false
            exclusiveMinimum: false
            default: 10
            type: integer
        - name: cursor
          required: false
          in: query
          description: Opaque cursor from a previous next_cursor.
          schema:
            type: string
        - name: event_type
          required: false
          in: query
          description: Filter by event type.
          schema:
            type: string
            enum:
              - payout.created
              - payout.initiated
              - payout.paid
              - payout.failed
              - return.initiated
              - return.paid
              - return.failed
              - return.returned
              - deposit.received
              - conversion.created
              - conversion.completed
              - conversion.failed
              - account_holder.active
              - account_holder.closed
              - ping.test
        - name: created_at.gte
          required: false
          in: query
          description: >-
            Include events whose created_at is greater than or equal to this ISO
            8601 timestamp.
          schema:
            format: date-time
            type: string
        - name: created_at.lte
          required: false
          in: query
          description: >-
            Include events whose created_at is less than or equal to this ISO
            8601 timestamp.
          schema:
            format: date-time
            type: string
      responses:
        '200':
          description: Paginated list of events
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListEventsResponseDto'
      x-codeSamples:
        - lang: JavaScript
          source: |-
            import Augustus from '@augustusbank/typescript-sdk';

            const client = new Augustus({
              apiKey: process.env['AUGUSTUS_API_KEY'], // This is the default and can be omitted
            });

            // Automatically fetches more pages as needed.
            for await (const eventListResponse of client.events.list()) {
              console.log(eventListResponse.id);
            }
components:
  schemas:
    ListEventsResponseDto:
      type: object
      properties:
        data:
          type: array
          items:
            type: object
            properties:
              id:
                description: >-
                  Unique identifier of the event. Matches the envelope `id`
                  delivered in the webhook payload and is stable across
                  subscription fan-out and retries.
                type: string
                format: uuid
              type:
                description: Resource type discriminator.
                type: string
                enum:
                  - event
              event_type:
                description: Event type.
                type: string
                enum:
                  - payout.created
                  - payout.initiated
                  - payout.paid
                  - payout.failed
                  - return.initiated
                  - return.paid
                  - return.failed
                  - return.returned
                  - deposit.received
                  - conversion.created
                  - conversion.completed
                  - conversion.failed
                  - account_holder.active
                  - account_holder.closed
                  - ping.test
              api_version:
                description: >-
                  API version the event payload was rendered at. Stable across
                  retries and redeliveries, and mirrored in the webhook envelope
                  `api_version` field.
                type: string
              created_at:
                description: ISO 8601 UTC timestamp when the event was created.
                type: string
                format: date-time
              data:
                description: >-
                  Event payload. Shape matches the resource schema for
                  `event_type`.
                type: object
                additionalProperties: {}
            required:
              - id
              - type
              - event_type
              - api_version
              - created_at
              - data
        has_more:
          type: boolean
        next_cursor:
          type: string
          nullable: true
      required:
        - data
        - has_more
        - next_cursor
  securitySchemes:
    BearerAuth:
      scheme: bearer
      bearerFormat: JWT
      type: http
      description: Bearer token for authentication with Augustus Banking API

````