Integrations
List Integrations
List connected integrations and their sync health
GET
List Integrations
List the external systems connected to a company, with connection state, sync health, and the last sync error.
This endpoint is read-only and never returns credentials. Access tokens,
refresh tokens, webhook secrets, and provider API keys are excluded. The
details object carries only an allowlist of non-secret descriptive fields.Request
boolean
default:"false"
Include disconnected integrations. By default only active integrations are
returned.
Response fields
string
Provider identifier, such as
stripe, shopify, supabase, or clerk.string
Display name for the provider, such as
Shopify App Billing for
shopify_app. Falls back to the raw provider id, so it is always safe to
render.string
Provider category:
payments, ecommerce, auth, analytics, ads,
affiliate, cms, or developer. null for a provider with no catalog
entry.string
Provider-side account identifier, such as a Shopify shop domain or a Stripe
acct_ ID.string
Last known sync state, such as
idle, syncing, or error.string
Error message from the most recent failed sync, or
null.object
Allowlisted non-secret metadata, such as
shopName, primaryDomain, or
scopes.object
Records the last sync could not import normally, or
null when the sync was
clean. suppressed counts profiles that were imported but cannot receive
email, so their order history still counts while sends stay blocked.
skipped counts records that were not imported at all. records holds a
sample of up to 50, and truncated is true when more were affected than
the sample shows.Responses
List Integrations