v1

latestOpenAPI 3.1.02026-07-24180245513.9 KB

Connectivity Syncs

Retrieve connectivity sync

Retrieve the details of a connectivity sync.

get/connectivity_syncs/{id}

Path parameters

idstring uuid required

Example:3ad331b9-12b2-48fd-ad35-203fe8b5e78e

The ID of the connectivity sync.

Response

Successfully retrieved connectivity sync.

idstring uuid required

The UUID of the connectivity sync.

object'connectivity_sync' required

Label used to identify this kind of object.

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

The type of the connectivity sync: * up: Uploading data to a provider (banks mainly) * down: Downloading/receiving data from a provider (banks mainly) * transfer_file: File transfer operation

connected_account_idsstring[] required

The list of connected account IDs associated with this connectivity sync.

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

The status of the connectivity sync: * success: Operation completed successfully * warning: Operation failed but outside critical business hours (marked as critical) * failure: Operation failed during critical business hours

status_detailsstring nullable required

Detailed information about the status, including error messages or warnings.

created_atstring date-time required

The UTC timestamp of the creation of this connectivity sync.

Example response

{
  "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"
}