List Events

Changed on
get/events

Request

  • Base URL
    https://api.increase.com
  • URL
    https://api.increase.com/events
  • Auth
    HTTP bearer

Query parameters

cursorstring

Return the page of entries after this one.

limitinteger

Limit the size of the list that is returned. The default is 100 objects and the maximum is 1,000.

created_at.afterstring date-time

Return results after this ISO 8601 timestamp.

created_at.beforestring date-time

Return results before this ISO 8601 timestamp.

created_at.on_or_afterstring date-time

Return results on or after this ISO 8601 timestamp.

created_at.on_or_beforestring date-time

Return results on or before this ISO 8601 timestamp.

category.instring[]

Filter Events for those with the specified category or categories. For GET requests, this should be encoded as a comma-delimited string, such as ?in=one,two,three.

associated_object_idstring

Filter Events to those belonging to the object with the provided identifier.

order_by.direction'ascending' | 'descending'

The direction to order in.

order_by.field'created_at'

The field to order by.

Response

Event List

next_cursorstring nullable required

A pointer to a place in the list. Pass this as the cursor parameter to retrieve the next page of results. If there are no more results, the value will be null.

Example response

{
  "data": [
    {
      "associated_object_id": "account_in71c4amph0vgo2qllky",
      "associated_object_type": "account",
      "category": "account.created",
      "created_at": "2020-01-31T23:59:59Z",
      "id": "event_001dzz0r20rzr4zrhrr1364hy80",
      "type": "event"
    }
  ],
  "next_cursor": "v57w5d"
}

Changes

  • 3b8b2f51c3b7Revision changes
    • breaking

      removed the enum value loan_purchase.created from the property items/ of the query request parameter category.in

    • warning

      added the new loan_purchase_offer.created enum value to the // response property for the response status

    • warning

      added the new loan_purchase_offer.updated enum value to the // response property for the response status

    • info

      added the enum value loan_purchase_offer.created to the property items/ of the query request parameter category.in

    • info

      added the enum value loan_purchase_offer.updated to the property items/ of the query request parameter category.in

    • info

      removed the loan_purchase.created enum value from the // response property for the response status

  • 65a762d76560Revision changes
    • warning

      for the query request parameter limit, the max was set to 1000.00