Get List Lender Events

Consuming webhooks, which we recommend, may not always be viable. Or in some cases, due to the way you operate your business, you can only respond to events at particular points in the day.

Below is an example of a lender who has received a number of events about their customers, and has chosen to query the Lender API for events in the last day.

This could be due to your operating hours, tech capability or for a reconciliation of events received. We really want to make this flexible, so we have provided some filters to help you narrow down the events you're looking for.

🚧
Rate limiting will be enforced on the endpoint. If you receive a 429 Too Many Requests response, you'll need to wait for the appropriate time found in the response before attempting to make another API call.

All requests require and start_datetime and end_datetime, optionally you can provide the event_type if for example you wanted to query for funding-options.offer-selected events.

You can also use the delivered field to search for events that Funding Options failed to deliver (according to the HTTP status code received from the webhook notification).

Finally, you can use to pagination parameters page and limit to fetch a bulk of events, limit being the number of results per batch and page to step through the batches.

📘
The parameters event_filter and range can be ignored. They will be deprecated shortly.