Docs Home Beam MCP APIs

Lightmeter APIs

Developer documentation for lead, campaign, Unibox, and analytics integrations

Leads API

Create missing workspace leads, safely enrich or deliberately replace standard and custom attributes, and optionally assign different audiences per lead.

POST /api/v1/leads/imports/preview
POST /api/v1/leads/imports
View Documentation

Campaigns API

Create draft campaigns, inspect canonical lifecycle state, deliberately pause, end, Fast Forward, or reopen campaigns, recover paused leads, and manage sequences and lead membership.

POST /api/v1/campaigns/submit
POST /api/v1/campaigns/{campaign_id}/leads
GET /api/v1/campaigns
GET /api/v1/campaigns/{campaign_id}
GET /api/v1/campaigns/{campaign_id}/lifecycle
POST /api/v1/campaigns/{campaign_id}/lifecycle/pause
POST /api/v1/campaigns/{campaign_id}/lifecycle/end
POST /api/v1/campaigns/{campaign_id}/lifecycle/fast-forward
POST /api/v1/campaigns/{campaign_id}/lifecycle/reopen
POST /api/v1/campaigns/{campaign_id}/leads/recovery/preview
POST /api/v1/campaigns/{campaign_id}/leads/recovery/apply
POST /api/v1/campaigns/{campaign_id}/leads/recovery/defer
View Documentation

Unibox API

Read lead email conversations, filter by answer status and reply classifications, and send validated plaintext replies from workspace mailbox identities.

GET /api/v1/unibox/threads
GET /api/v1/unibox/threads/{thread_id}
POST /api/v1/unibox/threads/{thread_id}/reply
View Documentation

Analytics API

Retrieve campaign performance metrics, including date-grained trends, sequence-email performance, lead outcomes, replies, end-autoreplies, and bounces.

GET /api/v1/analytics/overview
GET /api/v1/campaigns/{campaign_id}/analytics
GET /api/v1/campaigns/{campaign_id}/analytics/timeseries
GET /api/v1/campaigns/{campaign_id}/analytics/sequence
GET /api/v1/campaigns/{campaign_id}/analytics/leads
GET /api/v1/campaigns/{campaign_id}/leads/{lead_id}/activity
GET /api/v1/campaigns/{campaign_id}/send-timeline
GET /api/v1/reports/summary
GET /api/v1/reports/campaigns
GET /api/v1/reports/campaign-performance
GET /api/v1/reports/engagement/performance
GET /api/v1/reports/engagement/reply-breakdown
GET /api/v1/reports/deliverability
GET /api/v1/reports/volume
GET /api/v1/reports/stocks
View Documentation

Getting Started

All API requests should be made to our base URL:

https://beam.lightmeter.io

Authentication

All API endpoints require authentication using Organization API Keys. Include your API key in the Authorization header:

Authorization: Bearer your_api_key_here

Note: If you haven't already received API access, please request it from your account manager.

API keys are scoped to your organization and provide access to all endpoints your account has permissions for.