Browse the API reference

List Connection Options

get/v1/graphs/{graph_id}/connections/options

Part of Connections.

Returns available providers and their requirements. Only enabled providers are included (gated by feature flags). QuickBooks and Mercury require OAuth 2.0; Plaid authorizes through Plaid Link (auth_type link); external connections require no auth.

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

Example request

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

Responses

200 Successful Response

FieldTypeDescription
providersrequiredConnectionProviderInfo[]

Available connection providers

ConnectionProviderInfo fields
FieldTypeDescription
providerrequiredstring

Provider identifier

One of: quickbooks, external, mercury, plaid

display_namerequiredstring

Human-readable provider name

descriptionrequiredstring

Provider description

auth_typerequiredstring

Authentication type

One of: none, oauth, link, api_key

auth_flowoptionalstring

Description of authentication flow

required_configrequiredstring[]

Required configuration fields

optional_configoptionalstring[]

Optional configuration fields

featuresrequiredstring[]

Supported features

sync_frequencyoptionalstring

Typical sync frequency

data_typesrequiredstring[]

Types of data available

setup_instructionsoptionalstring

Setup instructions

documentation_urloptionalstring

Link to documentation

total_providersrequiredinteger

Total number of providers

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