Browse the API reference

List Connections

get/v1/graphs/{graph_id}/connections

Part of Connections.

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

Query parameters

NameTypeDescription
entity_idoptionalstringFilter by entity ID
provideroptionalstringFilter by provider type

One of: quickbooks, external, mercury, plaid

Example request

curl
curl -X GET "https://api.robosystems.ai/v1/graphs/{graph_id}/connections" \
  -H "X-API-Key: $ROBOSYSTEMS_API_KEY"

Responses

200 Successful Response

FieldTypeDescription
connection_idrequiredstring

Unique connection identifier

providerrequiredstring

Connection provider type

entity_idoptionalstring

Entity identifier

statusrequiredstring

Connection status

created_atrequiredstring (date-time) | string

Creation timestamp

updated_atoptionalstring (date-time) | string

Last update timestamp

last_syncoptionalstring (date-time) | string

Last sync timestamp

write_policyoptionalstring

Source-of-truth write policy: 'native' (RoboSystems is authoritative; no outbound write-back) or 'qb_authoritative' (QuickBooks is authoritative; RoboSystems-originated entries publish to QB). Set via the write-policy endpoint.

source_nameoptionalstring

External-provider registered source slug — the value the integration stamps on the events it emits. Null for platform providers.

metadatarequiredobject

Provider-specific metadata

StatusMeaning
400Invalid request
401Authentication required
403Access denied
404Resource not found
422Validation Error
429Rate limit exceeded
500Internal server error