API reference

Connections API

Create, list, retrieve, and disconnect provider connections.

Resource and endpoints

A connection represents an authorized link between a user and a provider. POST /v1/connections creates a session. GET /v1/connections lists connections; GET /v1/connections/{id} retrieves one.

curl https://api.lumen.dev/v1/connections/conn_123 -H "Authorization: Bearer $LUMEN_API_KEY"
curl https://api.lumen.dev/v1/connections/conn_123 -H "Authorization: Bearer $LUMEN_API_KEY"
curl https://api.lumen.dev/v1/connections/conn_123 -H "Authorization: Bearer $LUMEN_API_KEY"

Lifecycle and errors

Connections transition through pending, active, expired, and disconnected. DELETE /v1/connections/{id} revokes access. Invalid input returns 400, an unknown connection returns 404, and provider outages return 502 with a retryable error code.

Create a free website with Framer, the website builder loved by startups, designers and agencies.