---
title: "List integrations"
method: GET
path: "/integrations"
tags: ["integrationsapi"]
---

# List integrations

`GET /integrations`

## Query parameters

- `billing_only` boolean
- `exclude_ids` string[]
- `id` string
- `state` 'active' | 'created' | 'pending'
- `type` 'clerk' | 'metronome' | 'orb' | 'stripe' | 'unknown' | 'workos'
- `limit` integer — Page limit (default 100)
- `offset` integer — Page offset (default 0)

## Response `200`

OK

- object
  - `data` IntegrationsListResponseData[], required
    - `capabilities` IntegrationCapabilities, required
      - `author_plans` boolean, required
      - `checkout` boolean, required
      - `edit_billing` boolean, required
    - `config` union
      - object
        - `account_id` string, nullable — Connected Stripe account ID (acct_*)
        - `account_name` string, nullable — Display name of the connected Stripe account
        - `company_update_only` boolean — When importing Stripe customers, only update existing companies, do not create new companies
        - `is_sandbox` boolean, required — Whether the integration is connected to a Stripe sandbox account
        - `live_mode` boolean, required — Whether the integration is connected to a live Stripe account
        - `onboard_url` string, nullable — Onboarding URL returned during the v2 (Connect) install flow before activation
        - `type` 'stripe', required — Discriminator: always "stripe" for this variant
      - object
        - `external_customer_id_key` string, nullable — Schematic company key used to store Orb's external_customer_id; when unset, defaults to orb_external_customer_id
        - `type` 'orb', required — Discriminator: always "orb" for this variant
      - object
        - `first_events_received` boolean, nullable — Whether Schematic has received the first webhook event from Clerk after install
        - `type` 'clerk', required — Discriminator: always "clerk" for this variant
        - `webhook_url` string, nullable — URL configured on the Clerk webhook endpoint that delivers events to Schematic
      - object
        - `first_events_received` boolean, nullable — Whether Schematic has received the first webhook event from WorkOS after install
        - `type` 'workos', required — Discriminator: always "workos" for this variant
        - `webhook_url` string, nullable — URL configured on the WorkOS webhook endpoint that delivers events to Schematic
      - object
        - `external_customer_id_key` string, nullable — Schematic company key used to store the Metronome customer's ingest alias; when unset, imported customers carry only metronome_customer_id
        - `type` 'metronome', required — Discriminator: always "metronome" for this variant
    - `id` string, required
    - `is_app_install` boolean, required
    - `is_connect_install` boolean, required
    - `last_webhook_received_at` string, date-time, nullable
    - `state` 'active' | 'created' | 'pending', required
    - `type` 'clerk' | 'metronome' | 'orb' | 'stripe' | 'unknown' | 'workos', required
  - `params` object, required — Input parameters
    - `billing_only` boolean
    - `exclude_ids` string[]
    - `id` string
    - `limit` integer — Page limit (default 100)
    - `offset` integer — Page offset (default 0)
    - `state` 'active' | 'created' | 'pending'
    - `type` 'clerk' | 'metronome' | 'orb' | 'stripe' | 'unknown' | 'workos'

## Other responses

- `400` — Bad request
- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not found
- `500` — Server error

---

[API](https://skmtc.net/schematichq/apis/schematic-api.md) · [All operations](https://skmtc.net/schematichq/apis/schematic-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/schematichq/schematic-api/revisions/eb621e00773b/schema)