v1

latestOpenAPI 3.1.0raw.githubusercontent.com2026-03-3089191317.6 KB
connectors

Create Connector

post/api/v1/connectors

Request body

urlstring uri required
client_idstring nullable
client_secretstring nullable
metadataobject nullable

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.

match_presetboolean

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