ENendclose

List records

Changed on

Returns a paginated list of records, newest first. At least one of data_stream_key, reconciliation_match_id, reconciliation_id, external_id, or import_id is required.

Pagination is cursor-based: pass each response's next_cursor back as cursor until next_cursor is null. The legacy offset parameter and its has_more/offset/total_count response shape have been removed.

get/records

Request

  • Base URL
    https://api.endclose.com/v1
  • Auth
    API key in header X-API-KEY

Query parameters

data_stream_keystring

Filter by data stream key

reconciliation_match_idstring

Filter to records that belong to the given match

reconciliation_idstring

Filter to records that have a status row in the given reconciliation

external_idstring

Filter to records with this exact external_id

import_idstring uuid

Filter to records created by this import: a file import's id, or a bulk request's id

created_afterstring date-time

ISO8601 lower bound on created_at

created_beforestring date-time

ISO8601 upper bound on created_at

source'single_api' | 'csv_upload' | 'nacha_upload' | 'bulk_api' | 'plaid' | 'airwallex' | 'flows'

Filter via the joined file import's source

status'matched' | 'unmatched'

Filter by match status

cursorstring

Opaque cursor from a previous response's next_cursor. Omit for the first page.

limitinteger

Response

Paginated list of records

next_cursorstring nullable

Opaque cursor for the next page. Null when no more pages.

limitinteger

Changes

  • 159f9ed3dbf4Revision changes
    • breaking

      the // response's property type changed from integer to string, and format from no format to uuid for status

    • warning

      deleted the query request parameter bulk_request_id

    • warning

      deleted the query request parameter import_batch_id

    • info

      added the new optional query request parameter import_id

  • e6fff84c4865Revision changes
    • info

      added the new enum value flows to the query request parameter source