Events
List all Events
GET
/
events
Returns a list of Events that satisfy the provided filters.
Query Parameters
resource_id
string
Filter events by the associated resource ID.
resource_type
enum
Filter events by the type of resource. One of payment
, entity
, account
or credit_score
type
string
Filter events by the event type (e.g., payment.update, credit_score.increased).
from_date
string
ISO 8601 formatted date (YYYY-MM-DD) to filter for Events created on and after the date provided.
to_date
string
ISO 8601 formatted date (YYYY-MM-DD) to filter for Events created on and before the date provided.
page
string
The number of the page to return.
page_cursor
string
The ID of a resource from which a page should start or end. Mutually exclusive with page
.
page_limit
string
The number of Events to return per page.
Returns
Returns a paginated list of Event objects.