Connections

Sync Connection

QuickBooks: fetches transactions, balances, and chart of accounts. Mercury: pulls the bank feed (a 60-day window by default, or from since_date / the full backfill on full_rebuild) and captures it into the inbox. Plaid: continues from the Item's stored cursor (added, modified and removed transactions), or replays its history on full_rebuild / since_date. For all three the envelope is pending with the run's task_id, and completion is reflected in the connection's last_sync timestamp and last_sync_result. External connections are push-based and have nothing to pull; the envelope is completed with a null task_id and a message saying so — there is nothing to poll. Returns an OperationEnvelope; supports Idempotency-Key.

post/v1/graphs/{graph_id}/connections/{connection_id}/sync

Request

  • Base URL: https://api.robosystems.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.robosystems.ai/v1/graphs/{graph_id}/connections/{connection_id}/sync
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Path parameters

graph_idstring required
connection_idstring required

Connection identifier

Headers

Idempotency-Keystring nullable

Request body

full_rebuildboolean

Pull complete history from the provider, ignoring lookback window. Takes precedence over since_date.

since_datestring date nullable

Sync data from this date forward (ISO 8601). Ignored if full_rebuild=True. If neither set, provider default applies (e.g., QuickBooks: 60 days).

sync_optionsobject nullable

Provider-specific sync options (escape hatch for fields not exposed at the top level).

Response

Successful Response

operationstring required

Kebab-case operation name

operationIdstring required

op_-prefixed ULID for audit and SSE correlation

status'completed' | 'pending' | 'failed' required

Operation lifecycle state

resultunknown
atstring required

ISO-8601 UTC timestamp

createdBystring nullable

User ID that initiated the operation

idempotentReplayboolean

True when this envelope came from the idempotency cache — the underlying command did not execute again. False on fresh executions.

Changes

No recorded changes to this operation across all 1 revision of this API.