---
title: "List all events"
method: GET
path: "/v1/projects/{projectID}/events"
tags: ["Events"]
---

# List all events

`GET /v1/projects/{projectID}/events`

This endpoint fetches app events with pagination

## Path parameters

- `projectID` string, required

## Query parameters

- `direction` 'next' | 'prev'
- `endDate` string
- `endpointId` string[]
- `idempotencyKey` string
- `next_page_cursor` string
- `perPage` integer
- `prev_page_cursor` string
- `query` string
- `sort` string
- `sourceId` string[]
- `startDate` string

## Response `200`

OK

- object
  - `message` string
  - `status` boolean
  - `data` object
    - `content` ModelsEventResponse[]
      - `app_id` string — Deprecated
      - `created_at` string
      - `data` integer[] — Data is an arbitrary JSON value that gets sent as the body of the webhook to the endpoints
      - `deleted_at` string
      - `endpoint_metadata` DatastoreEndpoint[]
        - `advanced_signatures` boolean
        - `authentication` DatastoreEndpointAuthentication
          - `api_key` DatastoreApiKey
            - `header_name` string
            - `header_value` string
          - `type` 'api_key'
        - `created_at` string
        - `deleted_at` string
        - `description` string
        - `events` integer
        - `http_timeout` integer
        - `name` string
        - `owner_id` string
        - `project_id` string
        - `rate_limit` integer
        - `rate_limit_duration` integer
        - `secrets` DatastoreSecret[]
          - `created_at` string
          - `deleted_at` string
          - `expires_at` string
          - `uid` string
          - `updated_at` string
          - `value` string
        - `slack_webhook_url` string
        - `status` 'active' | 'inactive' | 'pending' | 'paused'
        - `support_email` string
        - `uid` string
        - `updated_at` string
        - `url` string
      - `endpoints` string[]
      - `event_type` string
      - `headers` HttpheaderHTTPHeader
      - `idempotency_key` string
      - `is_duplicate_event` boolean
      - `project_id` string
      - `raw` string
      - `source_id` string
      - `source_metadata` DatastoreSource
        - `body_function` string
        - `created_at` string
        - `custom_response` DatastoreCustomResponse
          - `body` string
          - `content_type` string
        - `deleted_at` string
        - `forward_headers` string[]
        - `header_function` string
        - `idempotency_keys` string[]
        - `is_disabled` boolean
        - `mask_id` string
        - `name` string
        - `project_id` string
        - `provider` 'github' | 'twitter' | 'shopify'
        - `provider_config` DatastoreProviderConfig
          - `twitter` DatastoreTwitterProviderConfig
            - `crc_verified_at` string
        - `pub_sub` DatastorePubSubConfig
          - `amqp` DatastoreAmqpPubSubConfig
            - `auth` DatastoreAmqpCredentials
              - …
            - `bindedExchange` string
            - `deadLetterExchange` string
            - `host` string
            - `port` string
            - `queue` string
            - `routingKey` string
            - `schema` string
            - `vhost` string
          - `google` DatastoreGooglePubSubConfig
            - `project_id` string
            - `service_account` integer[]
            - `subscription_id` string
          - `kafka` DatastoreKafkaPubSubConfig
            - `auth` DatastoreKafkaAuth
              - …
            - `brokers` string[]
            - `consumer_group_id` string
            - `topic_name` string
          - `sqs` DatastoreSQSPubSubConfig
            - `access_key_id` string
            - `default_region` string
            - `queue_name` string
            - `secret_key` string
          - `type` 'sqs' | 'google' | 'kafka' | 'amqp'
          - `workers` integer
        - `type` 'http' | 'rest_api' | 'pub_sub' | 'db_change_stream'
        - `uid` string
        - `updated_at` string
        - `url` string
        - `verifier` DatastoreVerifierConfig
          - `api_key` DatastoreApiKey
            - `header_name` string
            - `header_value` string
          - `basic_auth` DatastoreBasicAuth
            - `password` string
            - `username` string
          - `hmac` DatastoreHMac
            - `encoding` 'base64' | 'hex'
            - `hash` string
            - `header` string
            - `secret` string
          - `type` 'noop' | 'hmac' | 'basic_auth' | 'api_key'
      - `uid` string
      - `updated_at` string
      - `url_query_params` string
    - `pagination` DatastorePaginationData
      - `has_next_page` boolean
      - `has_prev_page` boolean
      - `next_page_cursor` string
      - `per_page` integer
      - `prev_page_cursor` string

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `404` — Not Found

## Changes

- **2024-03-26** `2ddfad646792` — 1 info
  - api operation id `GetEventsPaged` was added
- **2024-02-20** `17b85b56a687` — 1 info
  - added the new optional `query` request parameter `direction`
- **2024-02-20** `152f0e36cf45` — 1 warning
  - deleted the `query` request parameter `direction`
- **2024-02-08** `5e75c52bd9bd` — 1 info
  - added the new optional `query` request parameter `direction`
- **2024-01-30** `5a219dba9f40` — 1 warning, 1 info
  - deleted the `query` request parameter `direction`
  - api operation id `GetEventsPaged` removed and replaced with ``

[Change history](https://skmtc.dev/frain-dev/apis/convoy-api-reference/changes/v1/projects/:projectID/events/get.md)

---

[API](https://skmtc.dev/frain-dev/apis/convoy-api-reference.md) · [All operations](https://skmtc.dev/frain-dev/apis/convoy-api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/frain-dev/convoy-api-reference/revisions/831c5f3ca19d/schema)
