integration-types

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.

get/integration/type/{name}/

Request

  • Base URL: https://api.getoneprofile.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.getoneprofile.ai/integration/type/{name}/
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Path parameters

namestring required

Response

Successful Response

categoriesstring[] required

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

company_domainstring required

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

config_schemaobject nullable required

OpenAPI schema for connection settings. None if not implemented.

connect_methodsIntegrationConnectMethod[]

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.

created_atstring date-time required

When added to directory

credentials_schemaobject nullable required

OpenAPI schema for auth credentials. None if not implemented.

descriptionstring required

What the integration does, shown in detail view

display_namestring required

UI label. e.g. 'Google Sheets'

icon_urlstring required

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

idstring uuid required

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

implementedboolean required

False = coming soon, can't connect yet

integration_typestring required

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

is_marketplace_listingboolean

True when this integration has a marketplace app-listing (OAuth-connect or credentials-form). Orthogonal to connect_method: the directory renders a 'Connect <X>' button for a marketplace listing even when connect_method is 'credentials_form'. Derived from the app-listings catalog.

kind'source' | 'destination' | 'both'

Query filter: source-only, destination-only, or both.

namestring required

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

overviewstring required

Brief overview of the integration's sync capabilities

taglinestring required

Short tagline naming key data objects synced

updated_atstring date-time required

Last metadata update

Changes

No recorded changes to this operation across all 1 revision of this API.