List app events (Admin Only)

Get all app events for the authenticated account with filtering, sorting, and pagination. Events track user and system activities within the application. Requires org:admin role.

POST /api/public/v1/events/list

cURL

basic

curl --request POST \
  --url https://app.tagadapay.com/api/public/v1/events/list \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "pagination": {
    "page": 1,
    "pageSize": 20
  }
}
'

200

{
  "events": [
    {
      "id": "evt_123",
      "accountId": "acc_456",
      "storeId": "store_123",
      "customerId": "cus_789",
      "eventType": "s_order_paid",
      "properties": {
        "orderId": "ord_123",
        "amount": 2999,
        "currency": "USD",
        "paymentId": "pay_456"
      },
      "draft": false,
      "processedAt": "2024-03-20T10:35:00Z",
      "createdAt": "2024-03-20T10:30:00Z",
      "customer": {
        "id": "cus_789",
        "email": "[e-mail]",
        "firstName": "John",
        "lastName": "Doe"
      },
      "store": {
        "id": "store_123",
        "name": "My Store"
      }
    }
  ],
  "total": 1,
  "pageCount": 1,
  "options": {
    "appEvents.eventType": [
      "s_order_paid",
      "s_order_created",
      "s_payment_succeeded"
    ],
    "stores.id": [
      {
        "id": "store_123",
        "name": "My Store"
      },
      {
        "id": "store_456",
        "name": "Another Store"
      }
    ]
  }
}

Authorizations

Authorization · string · header · required

Enter your API key as: Bearer your-api-key

Body

application/json

search · string

sortBy · object

Show child attributes

pagination · object

Show child attributes

filters · object

Show child attributes

Response

200

application/json

Successful response