Skip to main content
GET
Get an integration

Authorizations

Authorization
string
header
required

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

Path Parameters

integration_id
string<uuid>
required

Response

Successful Response

Response model for List Integrations endpoint.

This model specifically does not include the config field. Use the integration specific read model whenever possible.

created_at
string<date-time>
required
created_by_actor_type
enum<string>
required

Type of actor that created this integration: 'user', 'api', or 'system'.

Available options:
user,
api,
system
id
string<uuid>
required
integration_type
string
required

The type of the integration.

kind
enum<string>
required

Indicates if the integration is a source, destination, or both.

Available options:
source,
destination,
both
name
string
required

The name of the integration as defined by the user.

org_id
string
required
updated_at
string<date-time>
required
connect_method
enum<string>
default:credentials_form

How this connection authenticates: 'credentials_form' (API-key form) or 'oauth_connect' (one-click app-listing OAuth). Gates the switch/reconnect surfaces in the UI.

Available options:
oauth_connect,
credentials_form
created_by_display_name
string | null

Display name of the creator. User's full name or 'API - {key name}'.

health_checked_at
string<date-time> | null

When the latest health check was performed.

health_error_code
string | null

Machine-readable error code from the latest health check (e.g. 'unauthorized', 'insufficient_permissions', 'rate_limited'). Drives the 'Action required — reauthorize' state and Reconnect CTA when it is 'unauthorized' or 'insufficient_permissions'. Null if never checked or healthy.

health_error_message
string | null

Error message from the latest health check, if unhealthy.

health_status
enum<string> | null

Latest health check status: healthy, warning, or error. Null if never checked.

Available options:
healthy,
warning,
error
record_types
IntegrationRecordTypeReadSchema · object[]

Record types this integration supports, as display-ready chips matching the Data tab. Wildcard integrations also include a 'Custom' marker.