Skip to main content
GET
Get a specific integration type

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

name
string
required
Required string length: 1 - 255

Response

Successful Response

Integration type metadata for the directory listing.

categories
string[]
required

e.g. ['CRM', 'Marketing Automation']

company_domain
string
required

e.g. 'google.com', 'intercom.com'

config_schema
Config Schema · object | null
required

OpenAPI schema for connection settings. None if not implemented.

created_at
string<date-time>
required

When added to directory

credentials_schema
Credentials Schema · object | null
required

OpenAPI schema for auth credentials. None if not implemented.

description
string
required

What the integration does, shown in detail view

display_name
string
required

UI label. e.g. 'Google Sheets'

icon_url
string
required

Full URL to icon. e.g. 'https://static.../intercom.svg'

id
string<uuid>
required

Unique ID. e.g. '123e4567-e89b-12d3-a456-426614174000'

implemented
boolean
required

False = coming soon, can't connect yet

integration_type
string
required

Unique ID. e.g. 'googlesheets', 'intercom'

name
string
required

Sort key. e.g. 'Google Sheets', 'Intercom'

overview
string
required

Brief overview of the integration's sync capabilities

tagline
string
required

Short tagline naming key data objects synced

updated_at
string<date-time>
required

Last metadata update

connect_methods
enum<string>[]

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.

Available options:
oauth_connect,
credentials_form
is_marketplace_listing
boolean
default:false

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.

kind
enum<string>
default:both

'source', 'destination', or 'both'

Available options:
source,
destination,
both
record_types
IntegrationRecordTypeReadSchema · object[]

Record types this integration syncs, as display-ready chips. Empty for 'coming soon' integrations. Wildcard integrations include a 'Custom' marker.