v1

latestOpenAPI 3.1.02026-07-24180245513.9 KB

Connectivity Syncs

List connectivity syncs

List and filter connectivity syncs.

get/connectivity_syncs

Query parameters

limitinteger

starting_afterstring uuid

The ID of the object from which your list request will start. It is not included in the result.

sort_order'asc' | 'desc'

Order is based on attribute created_at. If asc, results are fetched in chronological order. If desc, results are fetched in reversed chronological order. Default order is desc.

start_datestring date

The creation date of the connectivity sync.

end_datestring date

The creation date of the connectivity sync.

type'up' | 'down' | 'transfer_file'

The type of the connectivity sync.

status'success' | 'warning' | 'failure'

The status of the connectivity sync.

connected_account_idstring uuid

The ID of the connected account used to connect to the partner bank, CSM, or connectivity provider.

Response

List of filtered connectivity syncs.

Example response

{
  "records": [
    {
      "id": "3ad331b9-12b2-48fd-ad35-203fe8b5e78e",
      "object": "connectivity_sync",
      "type": "up",
      "connected_account_ids": [
        "f1c51532-1d11-4a33-aee0-592db244c76f",
        "b2de8b54-e81d-4fb7-bb26-536d8d671c18"
      ],
      "status": "failure",
      "status_details": "SFTP connection failed outside critical business hours - marked as critical",
      "created_at": "2024-08-01T06:00:05Z"
    }
  ]
}