API ReferenceConnectors
Connect a Connector
Connect an API-key-based connector by supplying its required credential fields
Only for connectors whose auth_type is api_key (see List Connectors) — OAuth2 connectors are connected through the dashboard's OAuth flow instead, and request_access connectors use Request Access. Storing new values for an already-connected provider updates the existing credential rather than creating a duplicate.
Path Parameters
provider*Provider
Header Parameters
X-API-Key?string|null
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
curl -X POST "https://example.com/api/v1/connectors/string/connect" \ -H "Content-Type: application/json" \ -d '{ "values": { "property1": "string", "property2": "string" } }'{ "provider": "string", "display_name": "string", "description": "string", "category": "string", "docs_url": "string", "auth_type": "string", "oauth_provider": "string", "oauth_app_configured": false, "oauth_redirect_uri": "string", "oauth_extra_fields": [], "action_count": 0, "connect_fields": [], "connected": true, "credential_uuid": "string", "request_fields": [], "access_requested": false}