---
descriptions:
  list_events:
    after: >-
      Pagination cursor to receive records after a provided event ID. Mutually
      exclusive with the `range_start` parameter.
    range_start: >-
      ISO 8601 formatted date range start for a stream of events. Can be
      provided without `range_end` to fetch all events since `range_start`.
      Mutually exclusive with the `after` parameter.
    range_end: ISO 8601 formatted date range end for a stream of events.
    events: Filter to only return events of particular types.
    organization_id: >-
      Filter to only return events belonging only to specific Organizations.
      User events (e.g user.created) will not be Organization specific.
    limit: >-
      Maximum number of records to return. Accepts values between `1` and `100`.
      Default is `10`.
    data: List of the corresponding event objects.
reference:
  curl:
    - key: list_events
      type: GET
      id: list_events
      url: /reference/events/list
      title: /events
      parameters:
        - key: events
          type: array
          description: (list_events.events)
        - key: organization_id
          type: string
          description: (list_events.organization_id)
        - key: limit
          optional: true
          type: number
          description: (list_events.limit)
        - key: range_start
          optional: true
          type: string
          description: (list_events.range_start)
        - key: range_end
          optional: true
          type: string
          description: (list_events.range_end)
        - key: after
          optional: true
          type: string
          description: (list_events.after)
      returns:
        - key: anonymous
          type: object
          unwrap: true
          properties:
            - key: data
              type: array
              description: (list_events.data)
            - key: list_metadata
              type: object
              properties:
                - (after)
  js:
    - key: listEvents
      id: list_events
      url: /reference/events/list
      title: events.listEvents()
      parameters:
        - key: events
          type: 'EventNames[]'
          description: (list_events.events)
        - key: limit
          optional: true
          type: number
          description: (list_events.limit)
        - key: organizationId
          optional: true
          type: string
          description: (list_events.organization_id)
        - key: rangeStart
          optional: true
          type: string
          description: (list_events.range_start)
        - key: rangeEnd
          optional: true
          type: string
          description: (list_events.range_end)
        - key: after
          optional: true
          type: string
          description: >-
            Pagination cursor to receive records after a provided event ID.
            Mutually exclusive with the `rangeStart` parameter.
      returns:
        - key: anonymous
          type: object
          unwrap: true
          properties:
            - key: data
              type: 'Event[]'
              description: (list_events.data)
            - key: listMetadata
              type: object
              properties:
                - (after)
  go:
    - key: ListEvents
      id: list_events
      url: /reference/events/list
      title: events.ListEvents()
      parameters:
        - (ctx)
        - key: opts
          type: events.ListEventsOpts
          expanded: true
          properties:
            - key: Events
              type: '[]string'
              description: (list_events.events)
            - key: Limit
              optional: true
              type: int
            - key: OrganizationId
              optional: true
              type: int
              description: (list_events.organization_id)
            - key: RangeStart
              optional: true
              type: string
              description: >-
                Date range start for stream of events. Mutually exclusive with
                the `After` parameter.
            - key: RangeEnd
              optional: true
              type: string
              description: (list_events.range_end)
            - key: After
              optional: true
              type: string
              description: >-
                Pagination cursor to receive records after a provided event ID.
                Mutually exclusive with the `RangeStart` parameter.
      returns:
        - key: list
          type: events.ListEventsResponse
          expanded: true
          properties:
            - key: Data
              type: '[]events.Event'
              description: (list_events.data)
            - key: ListMetadata
              type: common.ListMetadata
              properties:
                - (After)
        - (err)
  ruby:
    - key: list_events
      id: list_events
      url: /reference/events/list
      title: Events.list_events()
      parameters:
        - key: events
          type: 'Array[String]'
          description: (list_events.events)
        - key: limit
          optional: true
          type: Integer
          description: (list_events.limit)
        - key: organization_id
          optional: true
          type: String
          description: (list_events.organization_id)
        - key: range_start
          optional: true
          type: String
          description: (list_events.range_start)
        - key: range_end
          optional: true
          type: String
          description: (list_events.range_end)
        - key: after
          optional: true
          type: String
          description: (list_events.after)
      returns:
        - key: anonymous
          type: Struct
          unwrap: true
          properties:
            - key: data
              type: 'Array[Event]'
              description: (list_events.data)
            - key: list_metadata
              type: Struct
              properties:
                - (after)
  python:
    - key: list_events
      id: list_events
      url: /reference/events/list
      title: events.list_events()
      parameters:
        - key: events
          type: 'Sequence[EventType]'
          description: (list_events.events)
        - key: limit
          optional: true
          type: int
          description: (list_events.limit)
        - key: organization_id
          optional: true
          type: str
          description: (list_events.organization_id)
        - key: range_start
          optional: true
          type: str
          description: (list_events.range_start)
        - key: range_end
          optional: true
          type: str
          description: (list_events.range_end)
        - key: after
          optional: true
          type: str
          description: (list_events.after)
      returns:
        - key: anonymous
          type: WorkOSListResource
          unwrap: true
          properties:
            - key: data
              type: 'list[Event]'
              description: (list_events.data)
            - key: list_metadata
              type: ListAfterMetadata
              properties:
                - (after)
originalPath: .tmp-workos-clone/packages/docs/content/reference/events/list.mdx
---

## List events

Get a list of all of events up to 30 days old.

<CodeBlock referenceId="list_events">
  <CodeBlockTab title="Request" file="list-events-request" />
  <CodeBlockTab title="Response" file="list-events-response" />
</CodeBlock>