API version

API reference / List connections

List connections

GET/connections

List connections across every organization your credential can access (portfolio-wide), keyset-paginated. Pass limit and the opaque cursor from a prior response's nextCursor to page forward; hasMore is false on the last page. Each connection maps a platform entity (platformEntityId) to an organization (organizationId), so an integration can discover which entity belongs to which org. Optionally narrow with status / source and order with sort / order; a cursor is only valid for the sort, the filters, AND the organization scope it was issued under -- change any of them and start again from the first page.

Authorization

Api-KeystringRequired

Your secret API key. Include it with every request.

Headers

Api-Versiondate

Release date, as YYYY-MM-DD. Defaults to 2026-07-21.

Query

Every query parameter below is optional. Combine as many as you need and append them to the endpoint as a query string. The example shows a few to get you started.

/connections?status=<status>&sort=<sort>&order=<order>

statusstring

Comma-separated connection statuses (ACTIVE, INACTIVE, CONNECTION_ERROR); matches any of them. Unknown tokens are rejected with 400.

sourcestring

Comma-separated integration sources; matches any of them. Unknown tokens are rejected with 400.

sortPublicConnectionSortEnum

Field to sort by. Omit to page in the original, unsorted id order (the fastest option); every offered key sorts the whole matching set, so expect a slower first page on a large portfolio.

Available options:createdAtupdatedAtlastSyncedstoreNamestatussourcerecordsSynced

orderPublicConnectionSortOrder

Sort direction when sort is set. Defaults to desc.

Available options:ascdesc

limitinteger

Maximum number of items to return.

cursorstring

Opaque cursor from a prior response's nextCursor or previousCursor. Omit for the first page.

Response

itemsConnection[]Required

The results on this page. Empty when there are none.

nextCursorstring

Opaque cursor for the next page. null when this is the last page. Send it back as cursor; do not parse it.

previousCursorstring

Opaque cursor for the previous page. null when this is the first page. Send it back as cursor; do not parse it.

hasMoreboolean

Whether a page exists after this one.

hasPreviousboolean

Whether a page exists before this one.

200

Successful Response

400

The request was invalid.

401

Authentication failed or was missing.

403

The credential is not permitted for this request.

404

The requested resource was not found.

422

The request failed validation.

cURL

GET /connections?status={status}&sort={sort}&order=asc

-H "Api-Key: ***"

-H "Api-Version: 2026-07-21"

Example request

https://api.trykintsugi.com/connections?status={status}&sort={sort}&order=asc

Response

{

"items": [

{

"id": "conn_2mNpQr7Ls8f3k",

"organizationId": "orgn_2mNpQr7Ls8f3k",

"platformEntityId": "realm_1234567890",

"externalId": "order-1001",

"source": "QUICKBOOKS",

"status": "ACTIVE",

"storeName": "Acme Store",

"url": "https://www.example.com",

"createdAt": "2026-07-28T12:00:00Z",

"updatedAt": "2026-07-28T12:00:00Z",

"lastSynced": "2026-07-28T12:00:00Z",

"initialImportComplete": false,

"recordsSynced": 0,

"taxCalculationReady": false,

"taxCalculationEnabled": false,

"taxCalculationEnabledAt": "2026-07-28T12:00:00Z",

"taxCollectionOptedOutAt": "2026-07-28T12:00:00Z",

"needsUpdate": false,

"vertexEnabled": false,

"defaultCountry": "US",

"marketplaceId": "mktpl_2mNpQr7Ls8f3k",

"netsuiteSyncMode": "INVOICE_ONLY",

"netsuiteCashSaleSyncEnabled": false,

"netsuiteAccountId": "3f6c2b1e-8a4d-4c2e-9b1f-2d7e5a6c9f10",

"netsuiteSubsidiaryId": "3f6c2b1e-8a4d-4c2e-9b1f-2d7e5a6c9f10",

"isOneworldAccount": false,

"microsoftD365HistoricalSyncStartDate": "2026-07-21",

"airwallexHistoricalSyncStartDate": "2026-07-21",

"woocommerceHistoricalSyncStartDate": "2026-07-21",

"amazonHistoricalSyncStartDate": "2026-07-21",

"xeroHistoricalSyncStartDate": "2026-07-21",

"zuoraVertexTaxEngineId": "3f6c2b1e-8a4d-4c2e-9b1f-2d7e5a6c9f10",

"zuoraVertexTaxCompanyId": "3f6c2b1e-8a4d-4c2e-9b1f-2d7e5a6c9f10",

"apideckConnectionState": "apideck connection state",

"rilletWebhookTokenSet": false,

"odooHmacSecretSet": false,

"campfireWebhookSecretSet": false,

"killbillHmacSecretSet": false,

"ordwayWebhookSecretSet": false,

"ordwayWebhookLastReceivedAt": "2026-07-21T15:30:00Z",

"billComWebhookConfigured": false,

"plentyoneUsername": "Acme Corp",

"plentyoneHistoricalSyncStartDate": "2026-07-21",

"plentyoneHistoricalSyncEndDate": "2026-07-21",

"plentyoneMarketplaceOrders": "skip"

}

"nextCursor": "eyJpZCI6InRyYW5fMm1OcFFyN0xzOGYzayJ9",

"previousCursor": "eyJpZCI6InRyYW5fMm1OcFFyN0xzOGYzayJ9",

"hasMore": false,

"hasPrevious": false

}