Get Events

Path parameters

entityIdstringRequired
Entity ID or Entity ForeignID
paymentMethodIdstringRequired
Payment Method ID or Payment Method ForeignID

Headers

AuthorizationstringRequired

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

Query parameters

startDatedatetimeOptional
Start date filter. If not provided, events from the start of time will be returned.
endDatedatetimeOptional
End date filter. If not provided, events to the end of time will be returned.
limitintegerOptional
Limit the number of events returned. Limit can range between 1 and 100, and the default is 50.
startingAfterstringOptional
The ID of the event to start after.

Response

This endpoint returns an object.
datalist of objects
The list of events
countinteger
The total number of events
hasMoreboolean
Whether there are more events to fetch

Errors