Sync Connection
/v1/graphs/{graph_id}/connections/{connection_id}/syncPart 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-Keyheader. - Bearer token in the
Authorizationheader.
Path parameters
| Name | Type | Description |
|---|---|---|
graph_idrequired | string | Graph Id |
connection_idrequired | string | Connection identifier |
Header parameters
| Name | Type | Description |
|---|---|---|
Idempotency-Keyoptional | string | Idempotency-Key |
Request body
Required, application/json.
| Field | Type | Description |
|---|---|---|
full_rebuildoptional | boolean | Pull complete history from the provider, ignoring lookback window. Takes precedence over since_date. Default: |
since_dateoptional | string (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_optionsoptional | object | Provider-specific sync options (escape hatch for fields not exposed at the top level). |
Example request
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
| Field | Type | Description |
|---|---|---|
operationrequired | string | Kebab-case operation name |
operationIdrequired | string | op_-prefixed ULID for audit and SSE correlation |
statusrequired | string | Operation lifecycle state One of: |
resultoptional | any | Command-specific result payload |
atrequired | string | ISO-8601 UTC timestamp |
createdByoptional | string | User ID that initiated the operation (null for legacy callers) |
idempotentReplayoptional | boolean | True when this envelope came from the idempotency cache — the underlying command did not execute again. False on fresh executions. Default: |
| Status | Meaning |
|---|---|
| 400 | Invalid request |
| 401 | Authentication required |
| 403 | Access denied |
| 404 | Resource not found |
| 409 | Idempotency-Key conflict — key reused with different body |
| 422 | Validation error |
| 429 | Rate limit exceeded |
| 500 | Internal server error |
| 504 | Sync request timed out |