v47

latestOpenAPI 3.1.0raw.githubusercontent.com2026-05-012382333.4 MB

List Files

get/files

Query parameters

cursorstring

Return the page of entries after this one.

limitinteger

Limit the size of the list that is returned. The default (and maximum) is 100 objects.

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.

purpose.instring[]

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

idempotency_keystring

Filter records to the one with the specified idempotency_key you chose for that object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.

Response

File 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": [
    {
      "created_at": "2020-01-31T23:59:59Z",
      "description": "2022-05 statement for checking account",
      "direction": "from_increase",
      "filename": "statement.pdf",
      "id": "file_makxrc67oh9l6sg7w9yc",
      "idempotency_key": null,
      "mime_type": "application/pdf",
      "purpose": "increase_statement",
      "type": "file"
    }
  ],
  "next_cursor": "v57w5d"
}