Skip to content

API: integrations

Status: GA Access: token required API contract: 0.3.0 · capability 2026-09-03.1 View as Markdown Open in Claude Open in ChatGPT

List Integrations

Open as a page →

Every external connection with its cached status.

Auth: Authorization: Bearer <token> required

Responses:

CodeMeaningBody
200Successful Responsearray of ConnectionStatus
401Missing or invalid authentication credentialsErrorResponse

Get Integration

Open as a page →

One connection’s freshly recomputed status.

Auth: Authorization: Bearer <token> required

ParameterInRequiredTypeDescription
connection_idpathyesstring

Responses:

CodeMeaningBody
200Successful ResponseConnectionStatus
401Missing or invalid authentication credentialsErrorResponse
422Validation ErrorHTTPValidationError

POST /api/v1/integrations/{connection_id}/health

Section titled “POST /api/v1/integrations/{connection_id}/health”

Recheck Integration

Open as a page →

Force an immediate re-probe of one connection.

Auth: Authorization: Bearer <token> required

ParameterInRequiredTypeDescription
connection_idpathyesstring
Idempotency-KeyheadernostringOptional.

Responses:

CodeMeaningBody
200Successful ResponseConnectionStatus
401Missing or invalid authentication credentialsErrorResponse
422Validation ErrorHTTPValidationError