Docs Home Beam MCP APIs

Lightmeter APIs

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

Customer Agreement API

Review and accept an issued agreement using its private invitation capability, recover uncertain results and download the retained PDF.

GET/v1/onboarding/invites/{token}/native-agreement
POST/v1/onboarding/invites/{token}/native-agreement/accept
GET/api/v1/agreements
View Documentation

Infrastructure API

Read workspace domain and mailbox inventory, health, and campaign distribution.

GET/api/v1/infrastructure/domains
GET/api/v1/infrastructure/mailboxes
GET/api/v1/infrastructure/distribution
View Documentation

Workspace Settings and Integrations API

Read workspace settings, team, activity, CRM state, billing and agreements; manage customer webhooks and inspect delivery history.

GET/api/v1/settings/general
GET/api/v1/billing/overview
POST/api/v1/webhook-configurations
View Documentation

Qualification API

Manage workspace qualification prompt templates and preview processing costs without starting a job.

GET/api/v1/qualification/prompt-templates
POST/api/v1/qualification/prompt-templates
POST/api/v1/qualification/estimate
View Documentation

Leads API

Search, export, import, and manage workspace leads; assign audiences and manage blocklists.

POST /api/v1/leads/imports/preview
POST /api/v1/leads/imports
GET /api/v1/lens/leads
POST /api/v1/lens/leads/import/impact
POST /api/v1/blocklists/values
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, find existing leads and their sent campaign steps, preview personalized reply templates, manage shared reply snippets, and send validated plaintext replies or separate messages from workspace mailbox identities.

GET /api/v1/unibox/compose-leads
GET /api/v1/unibox/compose-leads/{lead_id}/sent-steps
POST /api/v1/unibox/leads/{lead_id}/compose-context
POST /api/v1/unibox/leads/{lead_id}/messages
GET /api/v1/unibox/threads
GET /api/v1/unibox/threads/{thread_id}
POST /api/v1/unibox/threads/{thread_id}/reply-personalization
POST /api/v1/unibox/threads/{thread_id}/reply
GET /api/v1/reply-snippets
POST /api/v1/reply-snippets
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/volume/all-time
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.