Browse the API reference

Sync Connection

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

Part of Connections.

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.

Authentication

Authenticate in any one of these ways — not all of them:

  • API key in the X-API-Key header.
  • Bearer token in the Authorization header.

Path parameters

NameTypeDescription
graph_idrequiredstringGraph Id
connection_idrequiredstringConnection identifier

Header parameters

NameTypeDescription
Idempotency-KeyoptionalstringIdempotency-Key

Request body

Required, application/json.

FieldTypeDescription
full_rebuildoptionalboolean

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

Default: false

since_dateoptionalstring (date)

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_optionsoptionalobject

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

Example request

curl
curl -X POST "https://api.robosystems.ai/v1/graphs/{graph_id}/connections/{connection_id}/sync" \
  -H "X-API-Key: $ROBOSYSTEMS_API_KEY" \
  -H "Idempotency-Key: <Idempotency-Key>" \
  -H "Content-Type: application/json" \
  -d '{
  "full_rebuild": false,
  "since_date": "2026-01-31",
  "sync_options": {}
}'

Responses

202 Successful Response

FieldTypeDescription
operationrequiredstring

Kebab-case operation name

operationIdrequiredstring

op_-prefixed ULID for audit and SSE correlation

statusrequiredstring

Operation lifecycle state

One of: completed, pending, failed

resultoptionalany

Command-specific result payload

atrequiredstring

ISO-8601 UTC timestamp

createdByoptionalstring

User ID that initiated the operation (null for legacy callers)

idempotentReplayoptionalboolean

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

Default: false

StatusMeaning
400Invalid request
401Authentication required
403Access denied
404Resource not found
409Idempotency-Key conflict — key reused with different body
422Validation error
429Rate limit exceeded
500Internal server error
504Sync request timed out