Start connecting with OAuth

POST/v1/workspaces/{workspaceId}/connections/authorize

Returns the provider's sign-in URL. After the person approves, the provider returns to the API, which creates the connection (or re-authorises connectionId) and redirects to the web app's connection settings with ?connection=<id> or ?error=. Owners and admins only.

docs:write

Request

curl -X POST "https://api.lydie.co/v1/workspaces/01JCQ3TZ0WJ8K4M2X7T9R6N1PA/connections/authorize" \
  -H "Authorization: Bearer $LYDIE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "connector": "string",
    "name": "Notes"
  }'

Path parameters

workspaceIdstringrequired· 1–64 chars

Body

connectorstringrequired· ≥ 1 chars
namestringrequired· 1–120 chars
settingsobject
Default {}
connectionIdULIDor null
Default null

Response

authorizeUrlstring
expiresAttimestamp

200

{
  "authorizeUrl": "string",
  "expiresAt": "2026-11-12T09:30:00.000Z"
}

Errors use one envelope for every endpoint. See Errors and versions.