# CloserX.ai Documentation

## Docs

- [Add Clients](https://docs.closerx.ai/agency/add-clients.md): Onboard clients with whitelabel portals, custom domains, and isolated data.
- [Add DNS Record in Agency](https://docs.closerx.ai/agency/add-dns-record.md): Set up custom domains: ai.client.com
- [Choose Credit Packages](https://docs.closerx.ai/agency/choose-credit-packages.md): Let clients pick and upgrade their AI call plans.
- [Create Credit Packages](https://docs.closerx.ai/agency/create-credit-packages.md): Bundle and sell AI call credits to clients with custom pricing.
- [What Type of Domain Can They Use?](https://docs.closerx.ai/agency/domain-types.md): Subdomain vs. root vs. custom — what works.
- [Event type calendar creation](https://docs.closerx.ai/agency/event-type-calendar-creation.md)
- [Subscription Plans (CloserX & CRM Visible)](https://docs.closerx.ai/agency/subscription-plans-crm.md): Show clients their plan, usage, and CRM sync status.
- [Agent Creation Overview](https://docs.closerx.ai/agents/agent-creation.md): Complete guide covering all methods to create and manage AI agents.
- [Agent Templates](https://docs.closerx.ai/agents/agent-templates.md): Explore and customize pre-built AI agent templates for quick deployment.
- [Clone Agents](https://docs.closerx.ai/agents/clone-agents.md): Duplicate existing agents to create variations or scale across clients.
- [Create Agent](https://docs.closerx.ai/agents/create-agent.md): Step-by-step guide on creating an AI calling agent within the platform.
- [Setup Agent via Talk to AI](https://docs.closerx.ai/agents/setup-talk-ai.md): Create agents using natural language — no coding or prompt engineering required.
- [Create Agent](https://docs.closerx.ai/api-reference/agent/create-blank-agent.md): Creates a new AI call agent with default settings
- [Delete Agent](https://docs.closerx.ai/api-reference/agent/delete-agent.md): Deletes an existing AI call agent by its ID
- [Get Agent](https://docs.closerx.ai/api-reference/agent/get-agent.md): Retrieves the configuration of an existing AI call agent by its ID
- [Get Agent List](https://docs.closerx.ai/api-reference/agent/get-agents.md): Retrieves a paginated list of AI call agents with optional search and sorting
- [Get LLM](https://docs.closerx.ai/api-reference/agent/get-llm.md): Retrieves the configuration of an existing LLM by its ID
- [Update Agent](https://docs.closerx.ai/api-reference/agent/update-agent.md): Updates the configuration of an existing AI call agent or LLM by its ID
- [Forgot Password](https://docs.closerx.ai/api-reference/auth/forgot-password.md): Allows User to Log In the system
- [Login](https://docs.closerx.ai/api-reference/auth/login.md): Allows User to Log In the system
- [Logout](https://docs.closerx.ai/api-reference/auth/logout.md): Allows User to Log Out of the system
- [Refresh Token](https://docs.closerx.ai/api-reference/auth/refresh.md): Allows User to refresh their access token
- [Verify Token](https://docs.closerx.ai/api-reference/auth/reset-password.md): Verifies the password reset token for a user
- [Reset Password](https://docs.closerx.ai/api-reference/auth/reset-password-complete.md): Allows User to reset their password using a valid token
- [Add New Card](https://docs.closerx.ai/api-reference/billing/add-new-card.md): Adds a new payment card to the user's account. The card may be saved for future transactions and can be set as the default payment method.
- [Prices](https://docs.closerx.ai/api-reference/billing/current-plan.md): Fetches current active subscription plan details along with available pricing options.
- [Delete Card](https://docs.closerx.ai/api-reference/billing/delete-card.md): Deletes a saved payment card from the user's account using the card ID.
- [Download Invoice](https://docs.closerx.ai/api-reference/billing/download-invoice.md): Generates and returns the Stripe invoice download URL for the given invoice ID.
- [Active Subscription](https://docs.closerx.ai/api-reference/billing/get-active-subscription.md): Returns the current user's active subscription status, including plan details, billing info, and available pricing options.
- [Set Default](https://docs.closerx.ai/api-reference/billing/make-default-card.md): Sets a specific card or payment method as the default for the user.
- [List Cards](https://docs.closerx.ai/api-reference/billing/payment-methods.md): Retrieves a list of saved payment methods (cards) for the authenticated user.
- [Transaction History](https://docs.closerx.ai/api-reference/billing/transaction-history.md): Retrieves a list of all transactions including manual credits, subscriptions, and payments.
- [Update Subscription](https://docs.closerx.ai/api-reference/billing/update-subscription.md): Updates fields of an existing user subscription. This may include billing cycle, status, auto-renewal settings, etc.
- [Callback History](https://docs.closerx.ai/api-reference/callbacks/callback-history.md): Fetches the list of scheduled callbacks for all agencies.
- [Scheduled Callbacks](https://docs.closerx.ai/api-reference/callbacks/scheduled-callbacks-voizerfreeaccount.md): Fetches the list of scheduled callbacks for the agency 'voizerfreeaccount'.
- [Campaign Analytics](https://docs.closerx.ai/api-reference/campaign/campaign-analytics.md): Returns paginated campaign analytics for a specific campaign and date range.
- [Final Analysis](https://docs.closerx.ai/api-reference/campaign/campaign-final-analysis.md): Returns the final analysis data for a specific campaign by its campaign ID.
- [Create Campaign](https://docs.closerx.ai/api-reference/campaign/create-campaign.md): Creates a new call campaign, including key campaign details such as Campaign Name, Selected AI Agent, Call Direction, Selected Phone Number, Number Rotation settings, Campaign Budget (in minutes), and Scheduling options.
- [Create Quick Campaign](https://docs.closerx.ai/api-reference/campaign/create-quick-campaign.md): Creates a new quick call campaign, including key campaign details such as Campaign Name, Selected AI Agent, Selected Phone Number, and Enable Number Rotation settings.
- [Daily Campaign Result](https://docs.closerx.ai/api-reference/campaign/daily-campaign-results.md): Returns hourly data for credit deductions and campaign results for a given campaign on a specific date.
- [Edit Campaign](https://docs.closerx.ai/api-reference/campaign/edit-campaign.md): This endpoint allows editing campaign details like name, agent, budget, calling number, as well as performing actions like pause, resume, or complete the campaign.
- [Export Campaign](https://docs.closerx.ai/api-reference/campaign/export-campaign.md): Exports campaign data (e.g. analytics or logs) as a downloadable ZIP or Excel file.
- [Get Campaign List](https://docs.closerx.ai/api-reference/campaign/get-campaign-list.md): Fetches call campaign data, including status, agent details, calling numbers, and campaign performance metrics.
- [Add Contact](https://docs.closerx.ai/api-reference/contact/add-contact.md): Creates a new contact with personal, company, and tag information.
- [All List](https://docs.closerx.ai/api-reference/contact/all-list.md): Fetches a paginated list of contacts. You can filter the results using a search query.
- [Bulk Create Contacts](https://docs.closerx.ai/api-reference/contact/bulk-create-contact.md): Creates contacts in bulk with associated tags. Accepts an array of contact objects and a list of tags.
- [Bulk Delete Contacts](https://docs.closerx.ai/api-reference/contact/bulk-delete-contact.md): Deletes contacts in bulk using contact IDs or tag filters.
- [Contact Profile](https://docs.closerx.ai/api-reference/contact/contact-profile.md): Retrieves a contact's associated campaign and quick campaign results based on their contact number.
- [Delete Contact](https://docs.closerx.ai/api-reference/contact/delete-contact.md): Deletes a contact by its unique ID.
- [Edit Contact](https://docs.closerx.ai/api-reference/contact/edit-contact.md): Updates complete details of a specific contact by its unique ID.
- [Get By Tags](https://docs.closerx.ai/api-reference/contact/filter-by-tags.md): Fetches a list of all available tags in the system. This endpoint returns all tags without requiring any query parameters.
- [Import LeadConnect](https://docs.closerx.ai/api-reference/contact/import-from-crm-leadconnect.md): Initiates the CRM import task and returns a task ID and status message.
- [Import Salesforce](https://docs.closerx.ai/api-reference/contact/import-from-crm-salesforce.md): Fetches and imports contacts from the connected Salesforce account.
- [Transfer Contacts](https://docs.closerx.ai/api-reference/contact/transfer-contacts.md): Triggers the export of contacts from Salesforce to another CRM (e.g., GHL).
- [Add Stripe Credits](https://docs.closerx.ai/api-reference/credits/add-credits.md): Creates a Stripe payment link to purchase custom credits using a specified payment method.
- [Campaign Stats](https://docs.closerx.ai/api-reference/credits/campaign-stats.md): Retrieves statistics related to active campaigns, quick campaigns, total credits used, and call durations.
- [Add Paypal Credits](https://docs.closerx.ai/api-reference/credits/paypal-add-credits.md): Creates a PayPal payment link to purchase custom credits using a specified PayPal account.
- [Get Campaign Distribution](https://docs.closerx.ai/api-reference/dashboard/get-campaign-list.md): Returns the campaign distribution
- [Get Campaign Results](https://docs.closerx.ai/api-reference/dashboard/get-campaign-results.md): Returns the campaign distribution
- [Get Monthly Analytics](https://docs.closerx.ai/api-reference/dashboard/get-monthly-analytics.md): Returns the call success rate,average response time,ai accurary rate and total balance
- [Get Quick Campaign Results](https://docs.closerx.ai/api-reference/dashboard/get-quick-campaign-results.md): Returns the campaign distribution
- [Get Dashboard Top Cards](https://docs.closerx.ai/api-reference/dashboard/get-top-cards.md): Returns the call success rate,average response time,ai accurary rate and total balance
- [Get API](https://docs.closerx.ai/api-reference/integrations/get-api-key.md): Retrieves the GHL agency API key associated with the authenticated account.
- [Lead Connect User](https://docs.closerx.ai/api-reference/integrations/ghl-connect-user.md): Initiates the connection process to GHL (Go High Level) using OAuth `code` and `state` values returned after user authorization.
- [List All Agents](https://docs.closerx.ai/api-reference/integrations/list-all-agents.md): Retrieves all configured agents with their full configuration and metadata.
- [Salesforce Connect](https://docs.closerx.ai/api-reference/integrations/salesforce-callback.md): Handles the OAuth callback from Salesforce by consuming the returned `code` and `state`.
- [Web Call](https://docs.closerx.ai/api-reference/integrations/webcall.md): Handles the OAuth callback from Snowie by consuming the returned `code` only.
- [Webhook Active List](https://docs.closerx.ai/api-reference/integrations/webhook-active-list.md): Retrieves a list of all registered webhooks along with their URLs, descriptions, subscribed events, and associated agents.
- [Webhook Active Stats](https://docs.closerx.ai/api-reference/integrations/webhook-active-stats.md): Returns analytics for active webhooks, including total count, average response time, and total hit count.
- [Webhook Delete](https://docs.closerx.ai/api-reference/integrations/webhook-delete.md): Deletes a webhook based on the provided ID.
- [Webhook Edit](https://docs.closerx.ai/api-reference/integrations/webhook-edit.md): Updates an existing webhook using the provided ID with new URL, description, subscribed events, and selected agents.
- [Webhook Register](https://docs.closerx.ai/api-reference/integrations/webhook-register.md): Registers a new webhook with the provided URL, description, agent(s), and subscribed event(s).
- [Introduction](https://docs.closerx.ai/api-reference/introduction.md): Overview of the CloserX.ai API endpoints for managing AI-powered calling operations
- [Buy Caller ID](https://docs.closerx.ai/api-reference/phonenumber/add-caller-id.md): Fetches existing verified caller IDs from Twilio along with their friendly names and SIDs.
- [Delete Contact](https://docs.closerx.ai/api-reference/phonenumber/contact-delete.md): Deletes a Twilio contact based on the provided contact ID.
- [Contact List](https://docs.closerx.ai/api-reference/phonenumber/contact-list.md): Retrieves a list of Twilio contact numbers with additional metadata such as nickname and status.
- [Custom Add Contact](https://docs.closerx.ai/api-reference/phonenumber/custom-telephony-add-contact.md): Adds a new custom contact with SIP trunk credentials and other optional fields.
- [Start Verification](https://docs.closerx.ai/api-reference/phonenumber/start-verification.md): Initiates a verification process for a phone number using Twilio's caller ID validation.
- [Telnyx Buy Number](https://docs.closerx.ai/api-reference/phonenumber/telynx-purchased-number-list.md): Retrieves both purchased and available Telnyx numbers based on filters like country code and number slice options.
- [Telnyx Register](https://docs.closerx.ai/api-reference/phonenumber/telynx-register-add.md): Registers the Telnyx API key for the current company/tenant.
- [Get Telnyx Credentials](https://docs.closerx.ai/api-reference/phonenumber/telynx-register-get.md): Fetches the Telnyx API key and visibility settings for the current company/tenant.
- [Get Telnyx Number](https://docs.closerx.ai/api-reference/phonenumber/telynx-register-number.md): Registers a new number with Telnyx using the given phone number, country code, and friendly name.
- [Get Caller ID](https://docs.closerx.ai/api-reference/phonenumber/twillo-buy-caller-id.md): Registers a new caller ID number along with optional SIP credentials and friendly name.
- [Twilio Buy Number](https://docs.closerx.ai/api-reference/phonenumber/twillo-buy-number.md): Buys a Twilio number using provided credentials, phone number and optional friendly name.
- [Get Twilio Credentials](https://docs.closerx.ai/api-reference/phonenumber/twillo-get.md): Fetches the Twilio SID and token for the specified company schema.
- [Get New Number](https://docs.closerx.ai/api-reference/phonenumber/twillo-new-number.md): Retrieves available Twilio numbers based on search parameters like country, number slice, and slice filter.
- [Twilio Register](https://docs.closerx.ai/api-reference/phonenumber/twillo-register.md): Registers Twilio credentials (SID and Token) for the agency account.
- [Get Purchased Number](https://docs.closerx.ai/api-reference/phonenumber/twillo-user.md): Retrieves a list of phone numbers associated with the provided Twilio SID and Auth Token.
- [Verification Status](https://docs.closerx.ai/api-reference/phonenumber/verification-status.md): Retrieves the verification status for a specific phone number based on Twilio caller ID validation.
- [Change Voice](https://docs.closerx.ai/calls/change-voice.md): Select and customize ultra-realistic AI voices for your agents.
- [End Call on Silence & Max Duration](https://docs.closerx.ai/calls/end-silence-duration.md): Prevent dead air and control call length with smart timeouts.
- [Setup End Calls Function](https://docs.closerx.ai/calls/setup-end-calls.md): Define when and how your AI ends a call gracefully.
- [Setup Transfer Call](https://docs.closerx.ai/calls/setup-transfer-call.md): Seamlessly hand off live calls to human agents when needed.
- [Setup Voicemail Message](https://docs.closerx.ai/calls/setup-voicemail.md): Leave professional, branded voicemails when no one answers.
- [Inbound Campaigns](https://docs.closerx.ai/campaigns/create-inbound-campaign.md): Automatically call inbound leads from forms, funnels, Facebook Lead Ads, Zapier, and webhooks.
- [New Campaign Analytics](https://docs.closerx.ai/campaigns/new-campaign-analytics.md): Real-time dashboards: connect rate, bookings, ROI, AI performance.
- [Import from CRM](https://docs.closerx.ai/contacts/import-crm.md): Sync leads directly from GoHighLevel, Salesforce, HubSpot, and 100+ CRMs.
- [Match Fields & Add Individual Contacts](https://docs.closerx.ai/contacts/match-fields-add-individual.md): Fine-tune field mapping and add single contacts manually.
- [Upload Contact List](https://docs.closerx.ai/contacts/upload-contact-list.md): Bulk upload thousands of leads in seconds — CSV, Excel, or copy-paste.
- [What Information We Can See in the Dashboard](https://docs.closerx.ai/dashboard/dashboard-information.md): Live metrics, AI performance, client usage, and campaign ROI — all in one place.
- [Custom SMS Function Call](https://docs.closerx.ai/features/custom-sms-function.md): Trigger personalized SMS during or after AI calls — confirm bookings, send links, or follow up.
- [Quickstart](https://docs.closerx.ai/getting-started/quickstart.md)
- [Introduction](https://docs.closerx.ai/index.md): Welcome to Closerx, the ultimate AI calling agent solution.
- [Installation](https://docs.closerx.ai/installation.md): How to set up CloserX platform or documentation environment.
- [Cal.com Calendar Setup](https://docs.closerx.ai/integrations/calcom-calendar-setup.md): Let AI book appointments directly into your Cal.com calendar.
- [Fetch Form Data from One CRM to Another](https://docs.closerx.ai/integrations/crm-form-fetch.md): Move form submissions between CRMs instantly.
- [GHL Calendar Booking in Agent](https://docs.closerx.ai/integrations/ghl-calendar-booking.md): Let AI book directly into client GHL calendars during calls.
- [GHL Calendar Setup](https://docs.closerx.ai/integrations/ghl-calendar-setup.md): Sync AI bookings with GoHighLevel calendars and event types.
- [GoHighLevel (GHL) Integration](https://docs.closerx.ai/integrations/ghl-integration.md): Two-way sync: leads, tags, appointments, call outcomes — all in real time.
- [Connect GHL Subaccount](https://docs.closerx.ai/integrations/ghl-subaccount-connection.md): Link client GHL subaccounts for whitelabel AI.
- [Enable User Limit in GHL](https://docs.closerx.ai/integrations/ghl-user-limit-enable.md): Control how many users can access AI per client.
- [Post-Call Analysis & GHL Tags](https://docs.closerx.ai/integrations/post-call-analysis.md): AI analyzes every call and adds smart tags to GHL.
- [Salesforce](https://docs.closerx.ai/integrations/salesforce-loom-video.md): Watch the full Salesforce integration demo.
- [Tags Explanation](https://docs.closerx.ai/integrations/tags-explanation.md): Learn how AI tags work and how to use them in GHL.
- [Zapier Agency Integration](https://docs.closerx.ai/integrations/zapier-agency-integration.md): Connect to 5,000+ apps — no code.
- [Custom Function Calls](https://docs.closerx.ai/prompts/custom-function.md): Trigger external actions during calls — book, tag, notify, and more.
- [How to Create Effective AI Prompts](https://docs.closerx.ai/prompts/effective-ai-prompts.md): Master the art of writing high-converting, natural-sounding AI phone scripts.
- [Prompt Temperature Setting](https://docs.closerx.ai/prompts/temperature-setting.md): Control AI creativity vs. consistency using the temperature parameter.
- [How to Add More Members](https://docs.closerx.ai/support/add-members.md): Invite team members, set roles, and control access.
- [How to Change the Password](https://docs.closerx.ai/support/change-password.md): Securely update your account password in seconds.
- [How to Test Agents](https://docs.closerx.ai/test/test-agents.md): Test your AI voice agents safely before going live — with real-time simulation, audio playback, and performance scoring.

## OpenAPI Specs

- [openapi](https://docs.closerx.ai/api-reference/openapi.json)

## Optional

- [Community](https://closerx.ai/community)
- [Blog](https://closerx.ai/blog)