API & webhooks

Your data, over REST.

Create a scoped key in Settings, then read your leads, companies, campaigns and mailboxes from your own code. Webhooks push events to you, signed so you can verify they came from us.

Start free Ask a question

Authentication

Scoped workspace keys.

Create keys under Settings → API in the app. Send one as Authorization: Bearer sf_… or in an x-api-key header.

New keys are read-only unless you choose otherwise. Each key is limited to 600 requests a minute, and each IP address to 120.

curl https://app.lumengrow.co/api/v1/leads \
  -H "Authorization: Bearer sf_your_key"

Endpoints

GET	/api/v1	Service discovery: your workspace, the endpoints and your key's scopes.
GET	/api/v1/leads	List leads in the workspace.
GET	/api/v1/leads/{id}	One lead, by id.
GET	/api/v1/companies	List companies.
GET	/api/v1/campaigns	List campaigns.
GET	/api/v1/mailboxes	List connected mailboxes.
POST	/api/v1/mailboxes	Add a mailbox with SMTP/IMAP credentials.

Scopes

leads:read
Read leads
leads:write
Create leads
companies:read
Read companies
campaigns:read
Read campaigns
mailboxes:read
Read mailboxes
webhooks:write
Subscribe to events
mailboxes:write
Add mailboxes
*
Full access

Webhooks

Events, pushed and signed.

Add an endpoint under Settings → Integrations and pick its events. Each delivery is a JSON POST of { event, data, timestamp }, signed with your endpoint's secret as an HMAC-SHA256 in the X-SignalForge-Signature header.

high_score_lead

A lead was scored 70 or higher out of 100. Includes the lead, its score and the breakdown.

Get a key in two minutes.

Start free