---
title: "List Events"
method: GET
path: "/v4/organizations/{organizationId}/projects/{projectId}/events"
tags: ["Events"]
---

# List Events

`GET /v4/organizations/{organizationId}/projects/{projectId}/events`

Lists all the events information under a project.

In order to access this endpoint, the provided API key must have at least one of the following roles:
 - Organization Owner
 - Project Owner
 - Project Manager
 - Project Viewer
 - Database Data Reader
 - Database Data Reader/Writer

The results are always limited by the role and scope of the caller's privileges.
Currently, only the `tags` filter is multi-valued; all other filters are single-valued.

By default, `to` is set to the request time, and `from` is set to 24 hours before the
request time. If 'to' is set and 'from' is not set, then 'from' is set to 24 hours
before 'to'.

To learn more, see [Organization, Project, and Database Access Overview](https://docs.couchbase.com/cloud/organizations/organization-projects-overview.html).

## Query parameters

- `page` integer
- `perPage` integer
- `sortBy` string[]
- `sortDirection` 'asc' | 'desc'
- `userIds` string[]
- `clusterIds` string[]
- `severityLevels` string[]
- `tags` string[]
- `from` string, date-time
- `to` string, date-time

## Response `200`

Successfully listed the events under the organization.

- GetEventsResponse
  - `data` GetEventResponse[], required
    - `id` string, uuid, required — UUID for this instance of an Event.
    - `source` string, required — Identifies the originator of the event.
    - `key` string, required — Defines the specific kind of Event.
    - `severity` string, required — Severity of the event.
    - `timestamp` string, date-time, required — Time when the event was emitted.
    - `projectId` string, uuid — ProjectID this Event refers to.
    - `projectName` string — Name of the project at the time of event emission.
    - `clusterId` string, uuid — ClusterID this Event refers to.
    - `clusterName` string — Name of the cluster at the time of event emission.
    - `appServiceId` string, uuid — SyncGatewayID this Event refers to.
    - `appServiceName` string — Name of the sync gateway at the time of event emission.
    - `userId` string — User id that initiated the request for this Event.
    - `userName` string — Name of the associated user at the time of event emission.
    - `userEmail` string — Email of the associated user at the time of event emission.
    - `sessionId` string, uuid — User that initiated the request for this Event.
    - `requestId` string, uuid — RequestID for an Event.
    - `kv` object — Key-value pairs for additional event data.
    - `summary` string — Metadata.SummaryTemplate rendered for this event.
    - `incidentIds` string[] — Group events related to an alert incident.
    - `occurrenceCount` integer — Number of times the alert has fired within this "incident".
    - `imageURL` string — Rendered chart image to display for an Alert Event.
    - `alertKey` string — Populated on demand based on the Event.Key and select labels in KV.
  - `cursor` Cursor, required
    - `pages` Pages, required
      - `page` integer, required — Current page of results, starting from page 1.
      - `next` integer — Number of the next page of results. Not set on the last page.
      - `previous` integer — Number of the previous page of results. Not set on the first page.
      - `last` integer, required — Number of the last page of results.
      - `perPage` integer, required — Number of items displayed in each page.
      - `totalItems` integer, required — Total items found by the given query.
    - `hrefs` Hrefs, required
      - `first` string, uri, required — The base URL, endpoint, and path parameters required to fetch the first page of results.
      - `last` string, uri, required — The base URL, endpoint, and path parameters required to fetch the last page of results.
      - `previous` string, uri, required — The base URL, endpoint, and path parameters required to fetch the previous page of results. Empty if there is no previous page.
      - `next` string, uri, required — The base URL, endpoint, and path parameters required to fetch the next page of results. Empty if there is no next page.

## Other responses

- `403` — The client does not have the necessary permissions to access this resource.
- `404` — The requested resource was not found.
- `429` — Returned when the client exceeds the rate limit for the given APIKey.
- `500` — An unexpected error occurred in the server while processing this request.

---

[API](https://skmtc.net/couchbase/apis/couchbase-capella-management-api.md) · [All operations](https://skmtc.net/couchbase/apis/couchbase-capella-management-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/couchbase/couchbase-capella-management-api/revisions/27d3c1e98fee/schema)