Get a specific integration type
Get detailed information about a specific integration type by its name. Returns the integration type’s categories, display name, description, and configuration schemas.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
1 - 255Response
Successful Response
Integration type metadata for the directory listing.
e.g. ['CRM', 'Marketing Automation']
e.g. 'google.com', 'intercom.com'
OpenAPI schema for connection settings. None if not implemented.
When added to directory
OpenAPI schema for auth credentials. None if not implemented.
What the integration does, shown in detail view
UI label. e.g. 'Google Sheets'
Full URL to icon. e.g. 'https://static.../intercom.svg'
Unique ID. e.g. '123e4567-e89b-12d3-a456-426614174000'
False = coming soon, can't connect yet
Unique ID. e.g. 'googlesheets', 'intercom'
Sort key. e.g. 'Google Sheets', 'Intercom'
Brief overview of the integration's sync capabilities
Short tagline naming key data objects synced
Last metadata update
The ways a user can connect this integration. Contains 'oauth_connect' when an app-listing OAuth manifest exists, and 'credentials_form' when the SDK exposes a non-empty (API-key) credentials form. A single-method type returns exactly one entry (the UI renders as before); a type supporting both returns both (the UI shows a chooser). Empty for unimplemented types.
How a user connects an integration in the UI.
Extensible: as app listings gain non-OAuth connect flows (e.g. install-bound URL secret, per-install signature), add members here rather than another boolean.
An integration type can advertise more than one of these (see
IntegrationTypeRead.connect_methods); a specific connection records the single method it
was created with on IntegrationModel.connect_method.
oauth_connect, credentials_form True when this integration has a marketplace app-listing (OAuth-connect or credentials-form). Orthogonal to connect_method: the directory renders a 'Connect ' button for a marketplace listing even when connect_method is 'credentials_form'. Derived from the app-listings catalog.
'source', 'destination', or 'both'
source, destination, both Record types this integration syncs, as display-ready chips. Empty for 'coming soon' integrations. Wildcard integrations include a 'Custom' marker.