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

# List events



## OpenAPI

````yaml https://raw.githubusercontent.com/webhookx-io/webhookx/refs/tags/v1.2.0/openapi.yml get /workspaces/{ws_id}/events
openapi: 3.0.3
info:
  title: WebhookX Admin API
  contact:
    name: WebhookX
    url: https://github.com/webhookx-io/webhookx
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
  version: 1.2.0
servers:
  - url: http://localhost:9601
security: []
paths:
  /workspaces/{ws_id}/events:
    parameters:
      - $ref: '#/components/parameters/workspace_id'
    get:
      tags:
        - Event
      summary: List events
      parameters:
        - $ref: '#/components/parameters/page_no'
        - $ref: '#/components/parameters/page_size'
        - $ref: '#/components/parameters/limit'
        - $ref: '#/components/parameters/sort'
        - $ref: '#/components/parameters/after'
        - $ref: '#/components/parameters/before'
        - $ref: '#/components/parameters/created_at'
        - description: event_type filter
          in: query
          name: event_type
          schema:
            type: string
        - description: unique_id filter
          in: query
          name: unique_id
          schema:
            type: string
        - description: ingested_at filter (unix time in milliseconds).
          in: query
          name: ingested_at
          explode: true
          style: deepObject
          schema:
            anyOf:
              - type: object
                properties:
                  gt:
                    type: integer
                    format: int64
                  gte:
                    type: integer
                    format: int64
                  lt:
                    type: integer
                    format: int64
                  lte:
                    type: integer
                    format: int64
              - type: integer
                format: int64
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                oneOf:
                  - allOf:
                      - $ref: '#/components/schemas/OffsetPagination'
                      - type: object
                        properties:
                          data:
                            type: array
                            items:
                              $ref: '#/components/schemas/Event'
                  - allOf:
                      - $ref: '#/components/schemas/CursorPagination'
                      - type: object
                        properties:
                          data:
                            type: array
                            items:
                              $ref: '#/components/schemas/Event'
components:
  parameters:
    workspace_id:
      in: path
      name: ws_id
      required: true
      schema:
        type: string
        example: default
      description: The workspace id
    page_no:
      deprecated: true
      in: query
      name: page_no
      schema:
        type: integer
        default: 1
        minimum: 1
    page_size:
      deprecated: true
      in: query
      name: page_size
      schema:
        type: integer
        default: 20
        maximum: 1000
        minimum: 1
    limit:
      description: >-
        A limit on the number of objects to be returned. Limit can range between
        1 and 1000, and the default is 20.
      in: query
      name: limit
      schema:
        type: integer
        default: 20
        maximum: 1000
        minimum: 1
    sort:
      description: Only id.asc and id.desc are supported.
      in: query
      name: sort
      schema:
        type: string
        enum:
          - id.desc
          - id.asc
        default: id.desc
    after:
      description: A cursor for use in pagination.
      in: query
      name: after
      schema:
        type: string
    before:
      description: A cursor for use in pagination.
      in: query
      name: before
      schema:
        type: string
    created_at:
      description: created_at filter (unix time in milliseconds).
      in: query
      name: created_at
      explode: true
      style: deepObject
      schema:
        anyOf:
          - type: object
            properties:
              gt:
                type: integer
                format: int64
              gte:
                type: integer
                format: int64
              lt:
                type: integer
                format: int64
              lte:
                type: integer
                format: int64
          - type: integer
            format: int64
  schemas:
    OffsetPagination:
      type: object
      properties:
        total:
          description: Total number of resources.
          type: integer
          example: 1
        data:
          description: List of resources
          type: array
          items:
            type: object
    Event:
      type: object
      properties:
        id:
          type: string
        event_type:
          type: string
        data:
          type: object
        ingested_at:
          type: integer
          description: The time the event was ingested
        unique_id:
          type: string
          nullable: true
          maxLength: 50
          description: The unique id used to de-duplication
        created_at:
          type: integer
          readOnly: true
        updated_at:
          type: integer
          readOnly: true
      required:
        - event_type
        - data
    CursorPagination:
      type: object
      properties:
        next:
          description: URI to next page when available.
          type: string
          nullable: true
        prev:
          description: URI to previous page when available.
          type: string
          nullable: true
        data:
          description: List of resources
          type: array
          items:
            type: object

````