---
title: "Events - List"
method: POST
path: "/events/{merchant_id}"
tags: ["Event"]
---

# Events - List

`POST /events/{merchant_id}`

List all Events associated with a Merchant Account or Profile.

## Path parameters

- `merchant_id` string, required

## Request body

- EventListConstraints — The constraints to apply when filtering events.
  - `created_after` string, date-time, nullable — Filter events created after the specified time.
  - `created_before` string, date-time, nullable — Filter events created before the specified time.
  - `limit` integer, nullable — Include at most the specified number of events.
  - `offset` integer, nullable — Include events after the specified offset.
  - `object_id` string, nullable — Filter all events associated with the specified object identifier (Payment Intent ID, Refund ID, etc.)
  - `event_id` string, nullable — Filter all events associated with the specified Event_id
  - `profile_id` string, nullable — Filter all events associated with the specified business profile ID.
  - `event_classes` EventClass[], nullable — Filter events by their class.
  - `event_types` EventType[], nullable — Filter events by their type.
  - `is_delivered` boolean, nullable — Filter all events by `is_overall_delivery_successful` field of the event.
  - `recipient` 'merchant' | 'connector'

## Response `200`

List of Events retrieved successfully

- TotalEventsResponse — The response body of list initial delivery attempts api call.
  - `events` EventListItemResponse[], required — The list of events
    - `event_id` string, required — The identifier for the Event.
    - `merchant_id` string, required — The identifier for the Merchant Account.
    - `profile_id` string, required — The identifier for the Business Profile.
    - `object_id` string, required — The identifier for the object (Payment Intent ID, Refund ID, etc.)
    - `event_type` 'payment_succeeded' | 'payment_failed' | 'payment_processing' | 'payment_cancelled' | 'payment_cancelled_post_capture' | 'payment_authorized' | 'payment_partially_authorized' | 'payment_captured' | 'payment_expired' | 'action_required' | 'refund_succeeded' | 'refund_failed' | 'dispute_opened' | 'dispute_expired' | 'dispute_accepted' | 'dispute_cancelled' | 'dispute_challenged' | 'dispute_won' | 'dispute_lost' | 'mandate_active' | 'mandate_revoked' | 'payout_success' | 'payout_failed' | 'payout_initiated' | 'payout_processing' | 'payout_cancelled' | 'payout_expired' | 'payout_reversed' | 'invoice_paid' | 'surcharge_payment_succeeded' | 'surcharge_refund_succeeded', required
    - `event_class` 'payments' | 'refunds' | 'disputes' | 'mandates' | 'payouts' | 'subscriptions', required
    - `is_delivery_successful` boolean, nullable — Indicates whether the webhook was ultimately delivered or not.
    - `initial_attempt_id` string, required — The identifier for the initial delivery attempt. This will be the same as `event_id` for the initial delivery attempt.
    - `processor_merchant_id` string, nullable — The identifier for the Processor Merchant Account.
    - `created` string, date-time, required — Time at which the event was created.
  - `total_count` integer, required — Count of total events

---

[API](https://skmtc.net/hyperswitch/apis/dynamic-routing-openapi-3-0.md) · [All operations](https://skmtc.net/hyperswitch/apis/dynamic-routing-openapi-3-0/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/hyperswitch/dynamic-routing-openapi-3-0/revisions/8fbf69ab2597/schema)