Skip to main content
GET
List

Overview

Retrieves user events with powerful filtering capabilities. Use this endpoint to query events by user, entity, event type, date range, and more. Perfect for building audit trails, fraud investigation tools, and analytics dashboards.
OR Logic for Entity IDs: When querying by entity identifiers (entity_id, entity_external_id, tax_id), the system uses OR logic, returning events that match any of the provided identifiers.

Endpoint

Authentication

Requires a valid API key in the Authorization header:

Query Parameters

string
Filter events by user identifierExample: ?user_id=user_12345
string
Filter events by entity UUIDExample: ?entity_id=550e8400-e29b-41d4-a716-446655440000
string
Filter events by external entity identifierExample: ?entity_external_id=user_12345
string
Filter events by tax identification numberExample: ?tax_id=20242455496
string
Filter events by type (e.g., LOGIN_SUCCESS, TRANSFER_SUCCESS)Example: ?event_type=LOGIN_SUCCESS
string
Filter events after this date (ISO 8601 format)Example: ?start_date=2026-01-01T00:00:00Z
string
Filter events before this date (ISO 8601 format)Example: ?end_date=2026-01-31T23:59:59Z
number
default:"100"
Maximum number of events to return per page (max: 1000)Example: ?limit=50
number
default:"0"
Number of events to skip for paginationExample: ?offset=100

Response

boolean
Indicates if the request was successful
array
Array of event objects sorted by timestamp (newest first)
string
Event UUID
string
Type of event
string
User identifier
string
Entity UUID
string
External entity identifier
string
Tax ID
string
Event timestamp (ISO 8601)
string
Device identifier
string
IP address
string
Country code
boolean
VPN detection flag
boolean
Proxy detection flag
object
Event-specific metadata
string
Record creation timestamp
object
Pagination information
number
Total number of events matching the filters
number
Page size used
number
Offset used
boolean
Whether there are more pages available

Examples

Basic Query

Filter by Event Type

Filter by Date Range

Response Example

Error Responses

400 Bad Request

401 Unauthorized

403 Forbidden

500 Internal Server Error

Use Cases

Audit Trail

Build a complete audit trail for compliance:

Fraud Investigation

Investigate suspicious activity:

User Timeline

Build a user activity timeline:

Filtering Tips

Multiple Entity Identifiers

You can provide multiple entity identifiers to cast a wider net:

Combining Filters

Combine multiple filters for precise queries:

Pagination Best Practices

Iterate Through All Pages

Next Steps

Create Event

Track new events

Event Statistics

Get aggregated statistics

List by Entity

Get events for a specific entity

Fraud Detection

Build fraud rules with events