API
Reference
The plain-language reference for the VConnector API. Use your dashboard session, or send a Bearer token — endpoints marked Public need no authentication.
Authentication
Most endpoints use your dashboard session — when you're signed in, your requests are already authenticated. For scripts and external tools, send a Bearer token: Authorization: Bearer <token>. Endpoints marked Public need no authentication.
Dashboard session
Signed in to VConnector? Your requests are already authenticated.
Bearer token
For scripts and external integrations. Include it as: Authorization: Bearer <token>.
Public
No authentication needed. Marked "Public" in this reference.
Rate Limits
Requests are limited per account so the service stays fast and fair for everyone. Exceeding your limit returns HTTP 429. Authenticated requests are limited per hour by plan; unauthenticated requests (login, register, and public endpoints) are limited per 15 minutes by IP. Every response carries X-RateLimit-Limit, X-RateLimit-Remaining, and X-RateLimit-Reset headers showing your current allowance. The inbound VICIdial event endpoint is governed by your plan's monthly lead quota instead of the hourly limit.
| Tier | Requests | Window |
|---|---|---|
| Free | 300 requests | /hour |
| Starter | 1,500 requests | /hour |
| Professional | 7,500 requests | /hour |
| Enterprise | 20,000 requests | /hour |
Authentication
Sign in, register, and manage the session for your workspace.
/api/auth/registerPublic. Create a new account. Returns your session./api/auth/loginPublic. Sign in with email and password. Returns your session./api/auth/logoutEnd the current session./api/auth/meReturn the signed-in user, workspace, and plan status.Campaigns
Connect and manage your VICIdial campaigns.
/api/campaigns/configureConnect a campaign: saves the connection, completes setup, and returns a status report./api/campaigns/toggle-configEnable or pause a campaign connection (also accepts GET to read the current state)./api/campaigns/toggle-bidirectionalEnable or disable two-way sync (CRM leads to dialer) for a campaign./api/campaigns/historical-syncBackfill past calls into your CRM. Available on paid plans.Field Mapping
Read and write the mapping rules that reshape call data before it reaches your CRM.
/api/field-mappingsList all field mapping rules for your workspace./api/field-mappingsCreate or replace mapping rules (dynamic, transform, and static rules).Referral Program
Track your referrals, commissions, and payouts.
/api/referral/statsReferral metrics for your workspace./api/referral/historyCommission and payout history./api/referral-settingsCurrent referral program settings./api/referral/payout-accountRead your saved payout method./api/referral/payout-accountSave or update your payout method (Stripe, PayPal, or bank)./api/referral/payout/requestRequest a payout from your available balance.Plans & Payment Options
Plan catalog, payment gateways, and public configuration.
/api/subscription-tiersPublic. List available plans and their limits./api/billing/checkoutStart checkout for a paid plan. Your plan activates automatically once the payment is confirmed./api/payment-gatewaysPublic. List the payment options available at signup./api/configThe canonical application address, so generated links and callback URLs use the address you configured. Sign-in required.Health
Service status endpoints. Public.
/api/healthPublic. Basic service check./api/health/detailedPublic. More detailed service status.Public Marketing Content
Read the content that powers public pages. These are the same calls your site makes.
/api/cms/public/brandingPublic. Site name, logo, and branding values./api/cms/public/content-blocksPublic. Content blocks for a page (use ?page=<slug>)./api/cms/public/navigationPublic. Header and footer navigation menus./api/cms/public/page-settings/:slugPublic. SEO and layout settings for a page.