API Docs
REST API reference
Push and pull leads, campaigns, creatives, KPIs, and alerts from your CRM, data warehouse, or custom backend. Authenticate with a workspace API key on Pro and Agency plans.
18
Endpoints
5
Resource groups
OpenAPI 3.1
Machine-readable spec
Authentication
Send your workspace API key as a Bearer token. Create keys in Settings → Connect → API inside your workspace.
Authorization: Bearer lsg_live_…Base URL
All endpoints are relative to this base path.
https://staging.leadsysgen.com/api/v1Endpoints
Workspace API
REST API for workspace data — leads, campaigns, creatives, KPIs, and alert rules. Authenticate with a workspace API key (PRO or AGENCY plan). All responses include a requestId for support.
Leads
Create, read, update, and delete leads in your workspace pipeline.
Campaigns
List connected ad campaigns and fetch per-campaign KPI rollups.
Creatives
Browse ad creatives, variants, and creative-level performance.
KPIs
Workspace-wide performance summary over a rolling date window.
Alerts
Manage alert rules and inspect fired alert events.
Error handling
Errors return a JSON envelope with error.code, error.message, and requestId. Use requestId when contacting support.
| HTTP | Description |
|---|---|
401 | Missing, expired, or invalid API key. |
403 | Valid key but insufficient RBAC permission or plan limit. |
404 | Resource not found in the authenticated workspace. |
429 | Rate limit exceeded — retry with exponential backoff. |
500 | Unexpected server error — retry; contact support with requestId if persistent. |
Ready to connect your stack?
Create a workspace, generate an API key, and start syncing leads in minutes.