List Events

GET

/api/:account_id/events/

GET

/api/:account_id/events/

$ curl https://app.paymentkit.com/api/account_id/events/ \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json"

1 {
2   "items": [
3     {
4       "id": "evt_01F8XYZ9ABCD1234EFGH5678",
5       "type": "invoice.created",
6       "aggregate_type": "invoice",
7       "aggregate_id": "inv_20240615_0001",
8       "data": {
9         "amount_due": 15000,
10         "currency": "USD",
11         "status": "pending",
12         "due_date": "2024-07-15"
13       },
14       "metadata": {
15         "source": "billing_system",
16         "priority": "high"
17       },
18       "version": 3,
19       "created": "2024-06-15T09:30:00Z",
20       "previous_data": null,
21       "correlation_id": "corr_9a8b7c6d5e4f3g2h1i0j",
22       "actor_type": "user",
23       "actor_id": "usr_7890abcd1234efgh5678",
24       "actor_email": "jane.doe@example.com",
25       "actor_name": "Jane Doe",
26       "actor_display": "Jane D.",
27       "actor_origin": "web_portal",
28       "actor_reason": "Initial invoice creation"
29     }
30   ],
31   "total": 1,
32   "has_more": false
33 }

List events for an account.

Supports filtering by:

event_id: Show a specific event by its ID
aggregate_id: Show events for a specific entity (e.g., invoice timeline)
customer_id: Roll up events across everything a customer owns
aggregate_type: Show events for a type of entity
event_type: Show specific event types
filter JSON param: DataTable filters (event_type, aggregate_type, aggregate_id, created_at)

Results are ordered by created_at descending (newest first).

List events for an account. Supports filtering by: - event_id: Show a specific event by its ID - aggregate_id: Show events for a specific entity (e.g., invoice timeline) - customer_id: Roll up events across everything a customer owns - aggregate_type: Show events for a type of entity - event_type: Show specific event types - filter JSON param: DataTable filters (event_type, aggregate_type, aggregate_id, created_at) Results are ordered by created_at descending (newest first).

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

account_idstringRequired

Query parameters

event_idstring or nullOptional

Filter by event ID (e.g., ‘evt_dev_a1b2c3d4e5f6g7h8’)

aggregate_idstring or nullOptional

Filter by aggregate ID (entity ID)

customer_idstring or nullOptional

Roll up all events for a customer’s owned entities (subscriptions, invoices, payments, refunds, …). Mutually exclusive with aggregate_id.

aggregate_typestring or nullOptional

Filter by aggregate type (e.g., ‘invoice’)

event_typestring or nullOptional

Filter by event type (e.g., ‘invoice.created’)

limitintegerOptional1-100Defaults to 50

Number of items per page

offsetintegerOptional>=0Defaults to 0

Number of items to skip

filterstringOptionalDefaults to {}

Filter conditions as key-value pairs or advanced filter objects (JSON string)

sortBystring or nullOptional

Field to sort by

sortOrderintegerOptionalDefaults to -1

Sort order: 1 for ascending, -1 for descending

searchstring or nullOptional

Keyword-based search across multiple fields

Response

Successful Response

itemslist of objects

totalinteger

has_moreboolean

Errors

422

Unprocessable Entity Error