GET
/
events
curl "https://production.methodfi.com/events?resource_id=pmt_zR3nJG3c99P3X" \
  -H "Method-Version: 2024-04-04" \
  -H "Authorization: Bearer sk_WyZEWVfTcH7GqmPzUPk65Vjc"

{
  "data": [
    {
      "id": "evt_7pPmytbXgWk7C",
      "type": "credit_score.increased",
      "resource_id": "crs_wXVk4MM7QWNnh",
      "resource_type": "credit_score",
      "data": "CreditScore",
      "diff": {
        "before": {
          "id": "crs_pn4ca33GXFaCE",
          "entity_id": "ent_au22b1fbFJbp8",
          "status": "completed",
          "scores": [
            {
              "score": 724,
              "source": "equifax",
              "model": "vantage_3",
              "factors": []
            }
          ]
        },
        "after": {
          "id": "crs_wXVk4MM7QWNnh",
          "entity_id": "ent_au22b1fbFJbp8",
          "status": "completed", 
          "scores": [
            {
              "score": 741,
              "source": "equifax",
              "model": "vantage_3",
              "factors": []
            }
          ]
        }
      },
      "updated_at": "2024-08-01T16:08:25.462Z",
      "created_at": "2024-08-01T16:08:25.462Z"
    },
    ...
  ],
}

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.

curl "https://production.methodfi.com/events?resource_id=pmt_zR3nJG3c99P3X" \
  -H "Method-Version: 2024-04-04" \
  -H "Authorization: Bearer sk_WyZEWVfTcH7GqmPzUPk65Vjc"

{
  "data": [
    {
      "id": "evt_7pPmytbXgWk7C",
      "type": "credit_score.increased",
      "resource_id": "crs_wXVk4MM7QWNnh",
      "resource_type": "credit_score",
      "data": "CreditScore",
      "diff": {
        "before": {
          "id": "crs_pn4ca33GXFaCE",
          "entity_id": "ent_au22b1fbFJbp8",
          "status": "completed",
          "scores": [
            {
              "score": 724,
              "source": "equifax",
              "model": "vantage_3",
              "factors": []
            }
          ]
        },
        "after": {
          "id": "crs_wXVk4MM7QWNnh",
          "entity_id": "ent_au22b1fbFJbp8",
          "status": "completed", 
          "scores": [
            {
              "score": 741,
              "source": "equifax",
              "model": "vantage_3",
              "factors": []
            }
          ]
        }
      },
      "updated_at": "2024-08-01T16:08:25.462Z",
      "created_at": "2024-08-01T16:08:25.462Z"
    },
    ...
  ],
}