v2

latestOpenAPI 3.1.0raw.githubusercontent.com2026-04-0177130234.9 KB

connectors

Connect Connector

post/api/v1/connectors/{connector_id}/connect

Path parameters

connector_idstring uuid required

Request body

redirect_urlstring uri nullable

access_tokenstring nullable

Response

Successful Response

idstring uuid required

urlstring uri required

state'created' | 'auth_required' | 'connected' | 'disconnected' required

disconnect_reasonstring nullable required

metadataobject nullable required

Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard.

Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters.

created_atstring date-time required

updated_atstring date-time required

created_bystring uuid required