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

# List organization events

> Lists organization-owned event metadata. Project-owned events are excluded.

Requires a team API key with `events:read`. Project tokens are not accepted.



## OpenAPI

````yaml api-reference/features/operate.json GET /platform/events
openapi: 3.0.3
info:
  title: Operate API methods
  version: 1.0.0
  description: Task-focused operate methods across supported Polymorfa connection types.
servers: []
security: []
paths:
  /platform/events:
    get:
      tags:
        - Events
      summary: List organization events
      description: >-
        Lists organization-owned event metadata. Project-owned events are
        excluded.


        Requires a team API key with `events:read`. Project tokens are not
        accepted.
      operationId: managementListOrganizationEvents
      parameters:
        - name: type
          in: query
          required: false
          schema:
            type: string
          description: Type discriminator for this object.
        - name: since
          in: query
          required: false
          schema:
            type: string
            format: date-time
          description: |-
            Specifies since for this query parameter.

            <!-- polymorfa-input-table -->
            **Value constraints**
            | Constraint | Accepted input |
            | --- | --- |
            | Format | `date-time` |
        - name: until
          in: query
          required: false
          schema:
            type: string
            format: date-time
          description: |-
            Specifies until for this query parameter.

            <!-- polymorfa-input-table -->
            **Value constraints**
            | Constraint | Accepted input |
            | --- | --- |
            | Format | `date-time` |
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 25
          description: |-
            Specifies limit for this query parameter.

            <!-- polymorfa-input-table -->
            **Value constraints**
            | Constraint | Accepted input |
            | --- | --- |
            | Numeric value | `1` through `100` (inclusive) |
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          description: Specifies cursor for this query parameter.
      responses:
        '200':
          description: Success
          headers:
            X-Request-Id:
              schema:
                type: string
              description: Stable request correlation identifier.
            Polymorfa-Version:
              schema:
                type: string
              description: API version applied to this response.
          content:
            application/json:
              schema:
                type: object
                additionalProperties: false
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/management__OrganizationEvent'
                    description: Structured data carried by this object.
                  page:
                    allOf:
                      - $ref: '#/components/schemas/management__CursorPageMetadata'
                    description: Specifies page for this schema.
                required:
                  - data
                  - page
        '400':
          $ref: '#/components/responses/management__BadRequest'
        '401':
          $ref: '#/components/responses/management__Unauthorized'
        '403':
          $ref: '#/components/responses/management__Forbidden'
      security:
        - management__ApiKeyAuth: []
      servers:
        - url: https://api.polymorfa.com
        - url: http://localhost:8080
          description: local dev
components:
  schemas:
    management__OrganizationEvent:
      type: object
      additionalProperties: false
      properties:
        id:
          type: string
          format: uuid
          description: |-
            Identifier for this resource.

            <!-- polymorfa-input-table -->
            **Value constraints**
            | Constraint | Accepted input |
            | --- | --- |
            | Format | `uuid` |
        organizationId:
          type: string
          format: uuid
          description: |-
            Identifier for the organization.

            <!-- polymorfa-input-table -->
            **Value constraints**
            | Constraint | Accepted input |
            | --- | --- |
            | Format | `uuid` |
        projectId:
          type: string
          nullable: true
          enum:
            - null
          description: |-
            Identifier of the Polymorfa project that owns this resource.

            <!-- polymorfa-input-table -->
            **Allowed values**
            | Value | Meaning |
            | --- | --- |
            | `null` | Null. |

            **Accepted alternatives**
            | Alternative | Accepted input |
            | --- | --- |
            | Alternative 1 | Type: `string` |
            | Alternative 2 | `null` |
        type:
          type: string
          minLength: 1
          maxLength: 128
          description: |-
            Type discriminator for this object.

            <!-- polymorfa-input-table -->
            **Value constraints**
            | Constraint | Accepted input |
            | --- | --- |
            | String length | `1` through `128` characters |
        source:
          type: string
          enum:
            - runtime
            - platform
            - test
          description: |-
            Specifies source for this management organization event.

            <!-- polymorfa-input-table -->
            **Allowed values**
            | Value | Meaning |
            | --- | --- |
            | `runtime` | Runtime. |
            | `platform` | Platform. |
            | `test` | Test. |
        environment:
          type: string
          enum:
            - development
            - production
          description: |-
            Specifies environment for this management organization event.

            <!-- polymorfa-input-table -->
            **Allowed values**
            | Value | Meaning |
            | --- | --- |
            | `development` | Development. |
            | `production` | Production. |
        createdAt:
          type: string
          format: date-time
          description: |-
            ISO 8601 timestamp when this resource was created.

            <!-- polymorfa-input-table -->
            **Value constraints**
            | Constraint | Accepted input |
            | --- | --- |
            | Format | `date-time` |
        payloadAvailability:
          type: string
          enum:
            - available
            - not_retained
            - expired
            - redacted
            - unavailable
          description: >-
            Specifies payload availability for this management organization
            event.


            <!-- polymorfa-input-table -->

            **Allowed values**

            | Value | Meaning |

            | --- | --- |

            | `available` | Available. |

            | `not_retained` | Not retained. |

            | `expired` | Expired. |

            | `redacted` | Redacted. |

            | `unavailable` | Unavailable. |
        payload:
          nullable: true
          allOf:
            - $ref: '#/components/schemas/management__EncodedEventPayload'
          description: >-
            Structured payload carried by this event or operation.


            <!-- polymorfa-input-table -->

            **Accepted alternatives**

            | Alternative | Accepted input |

            | --- | --- |

            | Alternative 1 | Type: `object`; Field `encoding`: `base64`; Field
            `contentType`: `application/json`; Required fields: `encoding`,
            `contentType`, `data` |

            | Alternative 2 | `null` |
        replayableUntil:
          type: string
          format: date-time
          nullable: true
          description: |-
            Specifies replayable until for this management organization event.

            <!-- polymorfa-input-table -->
            **Accepted alternatives**
            | Alternative | Accepted input |
            | --- | --- |
            | Alternative 1 | Type: `string`; Format: `date-time` |
            | Alternative 2 | `null` |

            **Value constraints**
            | Constraint | Accepted input |
            | --- | --- |
            | Format | `date-time` |
        metadataExpiresAt:
          type: string
          format: date-time
          description: |-
            Timestamp for metadata expires at.

            <!-- polymorfa-input-table -->
            **Value constraints**
            | Constraint | Accepted input |
            | --- | --- |
            | Format | `date-time` |
      required:
        - id
        - organizationId
        - projectId
        - type
        - source
        - environment
        - createdAt
        - payloadAvailability
        - payload
        - replayableUntil
        - metadataExpiresAt
    management__CursorPageMetadata:
      type: object
      additionalProperties: false
      properties:
        nextCursor:
          type: string
          nullable: true
          description: |-
            Specifies next cursor for this management cursor page metadata.

            <!-- polymorfa-input-table -->
            **Accepted alternatives**
            | Alternative | Accepted input |
            | --- | --- |
            | Alternative 1 | Type: `string` |
            | Alternative 2 | `null` |
        hasMore:
          type: boolean
          description: Whether more.
      required:
        - nextCursor
        - hasMore
    management__EncodedEventPayload:
      type: object
      additionalProperties: false
      properties:
        encoding:
          type: string
          enum:
            - base64
          description: |-
            Specifies encoding for this management encoded event payload.

            <!-- polymorfa-input-table -->
            **Allowed values**
            | Value | Meaning |
            | --- | --- |
            | `base64` | Base64. |
        contentType:
          type: string
          enum:
            - application/json
          description: >-
            IANA media type that matches the payload.


            <!-- polymorfa-input-table -->

            **Allowed values**

            | Value | Meaning |

            | --- | --- |

            | `application/json` | Application/json. |


            **Value constraints**

            | Constraint | Accepted input |

            | --- | --- |

            | Media type | IANA `type/subtype` value matching the payload, such
            as `image/jpeg`, `video/mp4`, `audio/ogg`, or `application/pdf` |
        data:
          type: string
          format: byte
          maxLength: 87384
          description: >-
            Canonical base64 for the complete native webhook body; decoded bytes
            are limited to 65,536 bytes.


            <!-- polymorfa-input-table -->

            **Value constraints**

            | Constraint | Accepted input |

            | --- | --- |

            | String length | At most `87384` characters |

            | Format | `byte` |
      required:
        - encoding
        - contentType
        - data
    management__ErrorEnvelope:
      type: object
      required:
        - error
        - data
        - docs
      properties:
        error:
          type: object
          required:
            - type
            - code
            - message
            - param
          properties:
            type:
              type: string
              enum:
                - invalid_request_error
                - authentication_error
                - permission_error
                - conflict_error
                - rate_limit_error
                - api_error
                - upstream_error
              description: |-
                Type discriminator for this object.

                <!-- polymorfa-input-table -->
                **Allowed values**
                | Value | Meaning |
                | --- | --- |
                | `invalid_request_error` | Invalid request error. |
                | `authentication_error` | Authentication error. |
                | `permission_error` | Permission error. |
                | `conflict_error` | Conflict error. |
                | `rate_limit_error` | Rate limit error. |
                | `api_error` | Api error. |
                | `upstream_error` | Upstream error. |
            code:
              type: string
              description: Stable failure code. Use this value for programmatic handling.
            message:
              type: string
              description: Safe explanation of the failure.
            param:
              type: string
              nullable: true
              description: |-
                Invalid request field, or null when no field applies.

                <!-- polymorfa-input-table -->
                **Accepted alternatives**
                | Alternative | Accepted input |
                | --- | --- |
                | Alternative 1 | Type: `string` |
                | Alternative 2 | `null` |
          description: Error details returned when the operation fails.
        data:
          type: string
          nullable: true
          enum:
            - null
          description: |-
            Always null for a failed request.

            <!-- polymorfa-input-table -->
            **Allowed values**
            | Value | Meaning |
            | --- | --- |
            | `null` | Null. |

            **Accepted alternatives**
            | Alternative | Accepted input |
            | --- | --- |
            | Alternative 1 | Type: `string` |
            | Alternative 2 | `null` |
        docs:
          type: string
          format: uri
          description: |-
            Documentation link to this failure code.

            <!-- polymorfa-input-table -->
            **Value constraints**
            | Constraint | Accepted input |
            | --- | --- |
            | Format | `uri` |
  responses:
    management__BadRequest:
      description: A path, query, or request-body value did not pass validation.
      headers:
        X-Request-Id:
          schema:
            type: string
          description: Stable request correlation identifier.
        Polymorfa-Version:
          schema:
            type: string
          description: API version applied to this response.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/management__ErrorEnvelope'
    management__Unauthorized:
      description: Missing/invalid credential for this audience.
      headers:
        X-Request-Id:
          schema:
            type: string
          description: Stable request correlation identifier.
        Polymorfa-Version:
          schema:
            type: string
          description: API version applied to this response.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/management__ErrorEnvelope'
    management__Forbidden:
      description: Authenticated but lacks the required scope/role/audience.
      headers:
        X-Request-Id:
          schema:
            type: string
          description: Stable request correlation identifier.
        Polymorfa-Version:
          schema:
            type: string
          description: API version applied to this response.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/management__ErrorEnvelope'
  securitySchemes:
    management__ApiKeyAuth:
      type: http
      scheme: bearer
      description: >-
        Polymorfa server credential: a scoped pmfa_ organization key, or a
        pmfa_pt_ project token on project- and session-bound operations inside
        its exact authenticated project. Keys may be personal or service-account
        owned. Both enforce selected action scopes; organization keys can
        address team resources and every project in the organization. Listener
        and browser client credentials are rejected.

````