# Connect an orb account

> POST /connections/orb/connect

Source: https://docs.trykintsugi.com/reference/2026-07-21/connect-an-orb-account

POST /connections/orb/connect

Connect an orb account

Create or update an Orb connection with an API key. `siteName` identifies the Orb account and must be unique per organization; re-submitting the same `siteName` updates its stored key rather than creating a second connection. Returns 400 if the key is invalid or `siteName` is empty. A multi-org credential must send an `Organization-Id`, `Connection-Id` or `Entity-Id` selector, or gets a 400.

Category: Connections

Request body:
apiKey (string, required) - Orb API key.
siteName (string, required) - A name identifying this Orb account; unique per organization.
historicalSyncStartDate (string) - Import floor for a brand-new connection, as YYYY-MM-DD. Ignored on reconnect. `null` imports all available history.

Response fields:
id (string, required) - Kintsugi's unique identifier for the connection.
organizationId (string, required) - Id of the organization this connection belongs to.
platformEntityId (string) - The platform's own identifier for the entity this connection points at (e.g. a QuickBooks realm id, D365 company id, NetSuite subsidiary id). Use it to resolve a connection from an id you already hold. `null` until captured on (re)connect or backfilled.
externalId (string, required) - The connection's own external identifier: an Apideck consumer id for a Vault-backed source, or the platform-specific value the connector stores (e.g. a Shopify shop id, a Stripe publishable key).
source (string, required) - Origin platform of the connection (e.g. SHOPIFY, QUICKBOOKS). Any origin outside the published values is reported as OTHER.
  allowed values: ACUMATICA, AIRWALLEX, AMAZON, API, APPLE_APP_STORE, BESTBUY, BIGCOMMERCE, BILL_COM, BUNNY, CAMPFIRE, CHARGEBEE, CHECKOUTCHAMP (and 58 more, see the reference page)
status (PublicConnectionStatusEnum, required) - Lifecycle status of the connection.
  allowed values: ACTIVE, INACTIVE, CONNECTION_ERROR
storeName (string) - Human-readable store or account name for the connection; an empty string when the connection has none.
url (string) - Public shop/account URL when the source exposes one; not a secret.
createdAt (string, required) - When the connection was created.
updatedAt (string) - When the connection was last updated.
lastSynced (string) - When this connection last completed a successful sync.
[truncated, see the reference page]

---

Index of every page: https://docs.trykintsugi.com/llms.txt