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

# List events

> Returns a list of events in your Plane workspace.

### Parameters

<ParamField query="limit" type="number">
  A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
</ParamField>

<ParamField query="starting_after" type="string">
  A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `evt_foo`, your subsequent call can include `starting_after=evt_foo` in order to fetch the next page of the list.
</ParamField>

<ParamField query="ending_before" type="string">
  A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `evt_bar`, your subsequent call can include `ending_before=evt_bar` in order to fetch the previous page of the list.
</ParamField>

### Returns

A dictionary with an `events` property that contains an array of up to `limit` events, starting after event `starting_after`. Each entry in the array is a separate event object. If no more events are available, the resulting array will be empty.

<ResponseExample>
  ```json Response theme={null}
  {
    "events": [
      {
        "id": "evt_abc123def456",
        "type": "payment.created",
        "subject": "pt_xyz789",
        "workspace": "ws_456def",
        "data": {
          "id": "pt_xyz789",
          "amount": "5000.00",
          "currency": "USD",
          "status": "pending",
          "worker": "wr_abc123"
        },
        "created": "2024-01-15T14:30:00Z"
      },
      {
        "id": "evt_def456ghi789",
        "type": "worker.created",
        "subject": "wr_abc123",
        "workspace": "ws_456def",
        "data": {
          "id": "wr_abc123",
          "first_name": "Jane",
          "last_name": "Smith",
          "email": "jane@example.com"
        },
        "created": "2024-01-15T10:30:00Z"
      }
    ]
  }
  ```
</ResponseExample>