Quickstart

Make your first authenticated request and connect a provider in minutes.

Create your workspace

Create a workspace in the Lumen dashboard, then generate a sandbox API key. Sandbox keys start with lm_test_ and never touch production credentials. Store the key on your server rather than shipping it to a browser.

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

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

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

Verify your connection

A successful request returns a JSON object with a data array and a request_id. Save the request ID when debugging, and switch to a live key only after your integration passes sandbox tests.