Skip to main content
GET
List connections
Lists general-ledger connections (quickbooks, xero, netsuite, campfire, dualentry when read:gl is granted) and non-GL connections when read:connections is granted: exchange connections (provider is the lowercase venue, for example binance or coinbase), plaid, ramp, rain, stripe and fireblocks. Each connection ID identifies one connection. Credentials are never returned. To add a connection, use Connect provider. To renew credentials, use Connect provider for a general-ledger connection, or Reauthorize connection for an exchange, bank, card or Fireblocks connection.

Authorizations

X-API-Key
string
header
required

Your organization API key. See Authentication.

Query Parameters

connection_ids
string[]

IDs to return, separated by commas. The other filters also apply.

Required array length: 1 - 100 elements
Minimum string length: 1
limit
integer
default:25

Maximum number of records to return.

Required range: 1 <= x <= 100
cursor
string

The next_cursor value from the previous page. Keep the other filters unchanged.

status
enum<string>

Connection status. Inactive means a Stripe connection that webhooks and payout syncs skip.

Available options:
pending_setup,
active,
inactive,
expired,
disconnecting,
disconnected,
failed
include_pii
boolean

Return the full created_by and updated_by emails. Without it, the emails are masked.

provider
string

Return only the connections of this provider, for example rain or quickbooks. An unknown provider returns 400.

Required string length: 1 - 64

Response

The request succeeded.

data
object[]
required

The records.

has_more
boolean
required

Whether another page is available.

next_cursor
string | null
required

Cursor for the next page, or null on the last page.