# CloseBot API - [List API keys](https://developers.closebot.com/api-reference/account/list-api-keys.md) - [Create API Key](https://developers.closebot.com/api-reference/account/create-api-key.md): Creates a new API key. - [Delete API Key](https://developers.closebot.com/api-reference/account/delete-api-key.md): Deletes an API key. - [List the calling account's notifications for the active agency.](https://developers.closebot.com/api-reference/accountnotification/list-the-calling-accounts-notifications-for-the-active-agency.md) - [Update one of the calling account's notifications.](https://developers.closebot.com/api-reference/accountnotification/update-one-of-the-calling-accounts-notifications.md) - [Get agency](https://developers.closebot.com/api-reference/agency/get-agency.md): Retrieve the current agency details. Currently, CloseBot accounts can only be part of one agency. - [Get usage](https://developers.closebot.com/api-reference/agency/get-usage.md) - [Invite users](https://developers.closebot.com/api-reference/agency/invite-users.md) - [Revoke invitation](https://developers.closebot.com/api-reference/agency/revoke-invitation.md) - [List agencies](https://developers.closebot.com/api-reference/agency/list-agencies.md): List all agencies the account is a part of. - [List dimension values available for a given dimension.](https://developers.closebot.com/api-reference/analytics/list-dimension-values-available-for-a-given-dimension.md) - [List all metrics available.](https://developers.closebot.com/api-reference/analytics/list-all-metrics-available.md) - [Run an analytics query for the active agency.](https://developers.closebot.com/api-reference/analytics/run-an-analytics-query-for-the-active-agency.md) - [Time zones configured on the agency's sources, used to pick a sensible default for time-of-day analytics (see the hourOfWeek resolution on POST /analytics/query).](https://developers.closebot.com/api-reference/analytics/time-zones-configured-on-the-agencys-sources-used-to-pick-a-sensible-default-fortime-of-day-analytics-see-the-hourofweek-resolution-on-post-analyticsquery.md) - [Topics available as a conversations filter, optionally scoped to a set of sources.](https://developers.closebot.com/api-reference/analytics/topics-available-as-a-conversations-filter-optionally-scoped-to-a-set-of-sources.md): One rule covers both cases: a topic is listed when it has at least one LeadTopic row in scope. That deliberately carries no Status predicate. Only Active slugs ever enter the classifier enum (TopicClassificationPrompt) and the collector refuses to write a fact row for a non-Active topic, so Proposed… - [Topic treemap and per-topic daily series for the active agency.](https://developers.closebot.com/api-reference/analytics/topic-treemap-and-per-topic-daily-series-for-the-active-agency.md): A dedicated endpoint rather than another metric on /analytics/query, for three reasons: AnalyticsQueryPoint.Value is an int and average sentiment is a nullable double; the treemap and its sparklines must come from one snapshot or a batch landing mid-request can make the rectangles disagree with the… - [Refill agency wallet](https://developers.closebot.com/api-reference/billing/refill-agency-wallet.md): Attempts to charge the payment method on file for the agency to refill the agency wallet. - [Refill source wallet](https://developers.closebot.com/api-reference/billing/refill-source-wallet.md) - [Get re-billing settings](https://developers.closebot.com/api-reference/billing/get-re-billing-settings.md) - [Update re-billing](https://developers.closebot.com/api-reference/billing/update-re-billing.md) - [AI cost breakdown for a period](https://developers.closebot.com/api-reference/billing/ai-cost-breakdown-for-a-period.md): Splits the period's AI spend by what drove it — global prompt base, node instructions, tool descriptions, knowledge base, tool results, conversation history, response format, thinking, emitted tool calls and the reply itself. Injected variable values are costed against the section they… - [Get agency balance](https://developers.closebot.com/api-reference/billing/get-agency-balance.md): Gets the balance of the agency. - [Get agency billing](https://developers.closebot.com/api-reference/billing/get-agency-billing.md) - [Update agency billing](https://developers.closebot.com/api-reference/billing/update-agency-billing.md) - [Get source balance](https://developers.closebot.com/api-reference/billing/get-source-balance.md): Gets the balance of the source. - [List source transactions](https://developers.closebot.com/api-reference/billing/list-source-transactions.md) - [Add source transaction](https://developers.closebot.com/api-reference/billing/add-source-transaction.md) - [List agency transactions](https://developers.closebot.com/api-reference/billing/list-agency-transactions.md) - [List billed usages](https://developers.closebot.com/api-reference/billing/list-billed-usages.md) - [Delete source transaction](https://developers.closebot.com/api-reference/billing/delete-source-transaction.md) - [Create bot with AI](https://developers.closebot.com/api-reference/bot/create-bot-with-ai.md) - [Attach a source to a bot](https://developers.closebot.com/api-reference/bot/attach-a-source-to-a-bot.md) - [Detach a source from a bot](https://developers.closebot.com/api-reference/bot/detach-a-source-from-a-bot.md) - [Get bot source mcp server](https://developers.closebot.com/api-reference/bot/get-bot-source-mcp-server.md) - [Post bot source mcp server](https://developers.closebot.com/api-reference/bot/post-bot-source-mcp-server.md) - [Delete bot source mcp server](https://developers.closebot.com/api-reference/bot/delete-bot-source-mcp-server.md) - [List bots](https://developers.closebot.com/api-reference/bot/list-bots.md) - [Create a new bot](https://developers.closebot.com/api-reference/bot/create-a-new-bot.md) - [Get a bot](https://developers.closebot.com/api-reference/bot/get-a-bot.md) - [Update a bot](https://developers.closebot.com/api-reference/bot/update-a-bot.md): Updates fields in a bot. - [Delete a bot](https://developers.closebot.com/api-reference/bot/delete-a-bot.md) - [Duplicate a bot](https://developers.closebot.com/api-reference/bot/duplicate-a-bot.md) - [End a persona split test](https://developers.closebot.com/api-reference/bot/end-a-persona-split-test.md): Ends the bot's current persona split test immediately, snapshots performance results, and promotes the winning persona to the bot default. Idempotent if the test has already been finalized. - [Export a bot](https://developers.closebot.com/api-reference/bot/export-a-bot.md) - [Get bot builder builder templates](https://developers.closebot.com/api-reference/bot/get-bot-builder-builder-templates.md) - [Get steps for a version](https://developers.closebot.com/api-reference/bot/get-steps-for-a-version.md) - [Persona performance for a bot, scoped to a date range or split-test window.](https://developers.closebot.com/api-reference/bot/persona-performance-for-a-bot-scoped-to-a-date-range-or-split-test-window.md) - [List past persona split tests for a bot](https://developers.closebot.com/api-reference/bot/list-past-persona-split-tests-for-a-bot.md): Returns deactivated tests, newest first. The current test — running or just-ended and still marked active — stays on GET /bot/{id}. - [Get the node descriptors](https://developers.closebot.com/api-reference/bot/get-the-node-descriptors.md) - [Validate Flow](https://developers.closebot.com/api-reference/bot/validate-flow.md): Preview and validate a KDL import without creating a bot. Performs structural, referential, and graph integrity checks. - [Publish a bot](https://developers.closebot.com/api-reference/bot/publish-a-bot.md) - [Save a bot](https://developers.closebot.com/api-reference/bot/save-a-bot.md) - [Save bot tools](https://developers.closebot.com/api-reference/bot/save-bot-tools.md) - [Update a bot version](https://developers.closebot.com/api-reference/bot/update-a-bot-version.md) - [Get agency summary](https://developers.closebot.com/api-reference/botmetric/get-agency-summary.md) - [Get action count](https://developers.closebot.com/api-reference/botmetric/get-action-count.md) - [Get actions](https://developers.closebot.com/api-reference/botmetric/get-actions.md) - [Get agency metric](https://developers.closebot.com/api-reference/botmetric/get-agency-metric.md) - [Get booking graph](https://developers.closebot.com/api-reference/botmetric/get-booking-graph.md) - [Get logs](https://developers.closebot.com/api-reference/botmetric/get-logs.md) - [Get message count](https://developers.closebot.com/api-reference/botmetric/get-message-count.md) - [Get messages with feedback](https://developers.closebot.com/api-reference/botmetric/get-messages-with-feedback.md) - [Save message feedback](https://developers.closebot.com/api-reference/botmetric/save-message-feedback.md) - [Get messages with likes](https://developers.closebot.com/api-reference/botmetric/get-messages-with-likes.md) - [Get message feedback reason](https://developers.closebot.com/api-reference/botmetric/get-message-feedback-reason.md) - [Get messages](https://developers.closebot.com/api-reference/botmetric/get-messages.md) - [Get source variables](https://developers.closebot.com/api-reference/botsourcevariable/get-source-variables.md) - [Update a source variable](https://developers.closebot.com/api-reference/botsourcevariable/update-a-source-variable.md) - [List templates](https://developers.closebot.com/api-reference/bottemplate/list-templates.md) - [List test sessions](https://developers.closebot.com/api-reference/bottesting/list-test-sessions.md) - [Create a test session](https://developers.closebot.com/api-reference/bottesting/create-a-test-session.md) - [Update a test session](https://developers.closebot.com/api-reference/bottesting/update-a-test-session.md) - [Delete a test session](https://developers.closebot.com/api-reference/bottesting/delete-a-test-session.md) - [Force processing](https://developers.closebot.com/api-reference/bottesting/force-processing.md) - [Listen for messages](https://developers.closebot.com/api-reference/bottesting/listen-for-messages.md) - [Rollback a test session](https://developers.closebot.com/api-reference/bottesting/rollback-a-test-session.md) - [Send a message to a test session](https://developers.closebot.com/api-reference/bottesting/send-a-message-to-a-test-session.md) - [Get dashboard](https://developers.closebot.com/api-reference/dashboard/get-dashboard.md) - [Post dashboard](https://developers.closebot.com/api-reference/dashboard/post-dashboard.md) - [Get dashboard 1](https://developers.closebot.com/api-reference/dashboard/get-dashboard-1.md) - [Put dashboard](https://developers.closebot.com/api-reference/dashboard/put-dashboard.md) - [Delete dashboard](https://developers.closebot.com/api-reference/dashboard/delete-dashboard.md) - [List folders](https://developers.closebot.com/api-reference/hierarchy/list-folders.md) - [Add a folder](https://developers.closebot.com/api-reference/hierarchy/add-a-folder.md) - [Get a folder](https://developers.closebot.com/api-reference/hierarchy/get-a-folder.md) - [Update a folder](https://developers.closebot.com/api-reference/hierarchy/update-a-folder.md) - [Delete a folder](https://developers.closebot.com/api-reference/hierarchy/delete-a-folder.md) - [Get lead ai toggle](https://developers.closebot.com/api-reference/lead/get-lead-ai-toggle.md) - [Put lead ai toggle](https://developers.closebot.com/api-reference/lead/put-lead-ai-toggle.md) - [Get a lead](https://developers.closebot.com/api-reference/lead/get-a-lead.md) - [Update lead fields](https://developers.closebot.com/api-reference/lead/update-lead-fields.md) - [Delete a lead](https://developers.closebot.com/api-reference/lead/delete-a-lead.md) - [Get lead page history](https://developers.closebot.com/api-reference/lead/get-lead-page-history.md) - [The topics a lead's conversation has been classified into.](https://developers.closebot.com/api-reference/lead/the-topics-a-leads-conversation-has-been-classified-into.md): Unpaginated, no limit: the taxonomy is capped at 30 Active topics per agency (see the remark on /analytics/topics/options), and LeadTopics is unique on (LeadId, TopicId), so a lead's list is bounded well under any page size. Deliberately not gated on the analytics add-on, unlike /analyt… - [List leads](https://developers.closebot.com/api-reference/lead/list-leads.md) - [Leave an internal note on a conversation. Notes are not messages: they are never sent to the contact and are only included in the AI's context when marked AiVisible.](https://developers.closebot.com/api-reference/lead/leave-an-internal-note-on-a-conversation-notes-are-not-messages:-theyare-never-sent-to-the-contact-and-are-only-included-in-the-ais-contextwhen-marked-aivisible.md) - [Delete an internal note. Only the note's author may delete it.](https://developers.closebot.com/api-reference/lead/delete-an-internal-note-only-the-notes-author-may-delete-it.md) - [Update an internal note's body and/or AI visibility.](https://developers.closebot.com/api-reference/lead/update-an-internal-notes-body-andor-ai-visibility.md) - [List a lead's scheduled messages: everything pending, plus recent failures so they stay visible in the conversation.](https://developers.closebot.com/api-reference/lead/list-a-leads-scheduled-messages:-everything-pending-plus-recentfailures-so-they-stay-visible-in-the-conversation.md) - [Schedule a message to a lead for a future time — either a manually typed message or one generated at send time by the conversation's last-responding AI agent.](https://developers.closebot.com/api-reference/lead/schedule-a-message-to-a-lead-for-a-future-time-—-either-a-manuallytyped-message-or-one-generated-at-send-time-by-the-conversationslast-responding-ai-agent.md) - [Cancel a pending scheduled message, or dismiss a failed one. Creator or team members only. The row is kept (status "canceled") for auditability; a dismissed failure keeps its original StatusReason.](https://developers.closebot.com/api-reference/lead/cancel-a-pending-scheduled-message-or-dismiss-a-failed-one-creatoror-team-members-only-the-row-is-kept-status-"canceled"-forauditability;-a-dismissed-failure-keeps-its-original-statusreason.md) - [Update a pending scheduled message's time, body (manual only), or cancel-on-reply flag. Creator or team members only.](https://developers.closebot.com/api-reference/lead/update-a-pending-scheduled-messages-time-body-manual-only-orcancel-on-reply-flag-creator-or-team-members-only.md) - [Search leads](https://developers.closebot.com/api-reference/lead/search-leads.md) - [Send a message to a lead](https://developers.closebot.com/api-reference/lead/send-a-message-to-a-lead.md) - [Broadcast human typing state to live subscribers for a lead.](https://developers.closebot.com/api-reference/lead/broadcast-human-typing-state-to-live-subscribers-for-a-lead.md) - [Update a lead instance](https://developers.closebot.com/api-reference/lead/update-a-lead-instance.md) - [One leaderboard: the leaders, the caller's neighbourhood, and where the caller stands.](https://developers.closebot.com/api-reference/leaderboard/one-leaderboard:-the-leaders-the-callers-neighbourhood-and-where-the-caller-stands.md) - [Get leaderboardprofile](https://developers.closebot.com/api-reference/leaderboard/get-leaderboardprofile.md) - [The metrics a board can be ranked by. Clients should build their columns from this rather than hardcoding a list, so changing the headline set needs no frontend deploy.](https://developers.closebot.com/api-reference/leaderboard/the-metrics-a-board-can-be-ranked-by-clients-should-build-their-columns-from-this-ratherthan-hardcoding-a-list-so-changing-the-headline-set-needs-no-frontend-deploy.md) - [Attach a file to a source](https://developers.closebot.com/api-reference/library/attach-a-file-to-a-source.md) - [Detach a file from a source](https://developers.closebot.com/api-reference/library/detach-a-file-from-a-source.md) - [Get a file metadata](https://developers.closebot.com/api-reference/library/get-a-file-metadata.md) - [Replace file content](https://developers.closebot.com/api-reference/library/replace-file-content.md) - [Delete a file](https://developers.closebot.com/api-reference/library/delete-a-file.md) - [Get libraryexternal connections](https://developers.closebot.com/api-reference/library/get-libraryexternal-connections.md) - [Post libraryexternal connections](https://developers.closebot.com/api-reference/library/post-libraryexternal-connections.md) - [Get libraryexternal connections connectable items](https://developers.closebot.com/api-reference/library/get-libraryexternal-connections-connectable-items.md) - [Post libraryexternal connections resources](https://developers.closebot.com/api-reference/library/post-libraryexternal-connections-resources.md) - [Get libraryexternal resources](https://developers.closebot.com/api-reference/library/get-libraryexternal-resources.md) - [Get libraryexternal resources items](https://developers.closebot.com/api-reference/library/get-libraryexternal-resources-items.md) - [Delete libraryexternal resources](https://developers.closebot.com/api-reference/library/delete-libraryexternal-resources.md) - [Get the scrape pages for a file](https://developers.closebot.com/api-reference/library/get-the-scrape-pages-for-a-file.md) - [Update the scrape pages for a file](https://developers.closebot.com/api-reference/library/update-the-scrape-pages-for-a-file.md) - [List files](https://developers.closebot.com/api-reference/library/list-files.md) - [Upload a file](https://developers.closebot.com/api-reference/library/upload-a-file.md) - [Get libraryfiles preview](https://developers.closebot.com/api-reference/library/get-libraryfiles-preview.md) - [Create a Web-Scrape file](https://developers.closebot.com/api-reference/library/create-a-web-scrape-file.md) - [Get file content](https://developers.closebot.com/api-reference/library/get-file-content.md) - [List Live Demos](https://developers.closebot.com/api-reference/livedemo/list-live-demos.md) - [Create Live Demo](https://developers.closebot.com/api-reference/livedemo/create-live-demo.md) - [Create Live Demo Session](https://developers.closebot.com/api-reference/livedemo/create-live-demo-session.md) - [Update Live Demo](https://developers.closebot.com/api-reference/livedemo/update-live-demo.md) - [Delete Live Demo](https://developers.closebot.com/api-reference/livedemo/delete-live-demo.md) - [Get Live Demo](https://developers.closebot.com/api-reference/livedemo/get-live-demo.md) - [Get Live Demo Lead](https://developers.closebot.com/api-reference/livedemo/get-live-demo-lead.md) - [Update Live Demo Fields](https://developers.closebot.com/api-reference/livedemo/update-live-demo-fields.md) - [Stream Live Demo Messages](https://developers.closebot.com/api-reference/livedemo/stream-live-demo-messages.md) - [Stream Live Demo Messages](https://developers.closebot.com/api-reference/livedemo/stream-live-demo-messages-1.md) - [Update a notification](https://developers.closebot.com/api-reference/notification/update-a-notification.md) - [Delete a notification](https://developers.closebot.com/api-reference/notification/delete-a-notification.md) - [Get notification forwarding settings](https://developers.closebot.com/api-reference/notification/get-notification-forwarding-settings.md) - [Update notification forwarding settings](https://developers.closebot.com/api-reference/notification/update-notification-forwarding-settings.md) - [List notifications](https://developers.closebot.com/api-reference/notification/list-notifications.md) - [List personas](https://developers.closebot.com/api-reference/persona/list-personas.md) - [Create a new persona](https://developers.closebot.com/api-reference/persona/create-a-new-persona.md) - [Get a persona](https://developers.closebot.com/api-reference/persona/get-a-persona.md) - [Update a persona](https://developers.closebot.com/api-reference/persona/update-a-persona.md) - [Delete a persona](https://developers.closebot.com/api-reference/persona/delete-a-persona.md) - [Get report](https://developers.closebot.com/api-reference/report/get-report.md) - [Post report](https://developers.closebot.com/api-reference/report/post-report.md) - [Put report](https://developers.closebot.com/api-reference/report/put-report.md) - [Delete report](https://developers.closebot.com/api-reference/report/delete-report.md) - [Get report shares](https://developers.closebot.com/api-reference/report/get-report-shares.md) - [Put report shares](https://developers.closebot.com/api-reference/report/put-report-shares.md) - [Post report shares](https://developers.closebot.com/api-reference/report/post-report-shares.md) - [Delete report shares](https://developers.closebot.com/api-reference/report/delete-report-shares.md) - [Follow up on answered FAQs](https://developers.closebot.com/api-reference/smartfaq/follow-up-on-answered-faqs.md) - [Answer multiple FAQs](https://developers.closebot.com/api-reference/smartfaq/answer-multiple-faqs.md) - [List FAQs](https://developers.closebot.com/api-reference/smartfaq/list-faqs.md) - [Create a new FAQ](https://developers.closebot.com/api-reference/smartfaq/create-a-new-faq.md) - [Delete an FAQ](https://developers.closebot.com/api-reference/smartfaq/delete-an-faq.md) - [List sources](https://developers.closebot.com/api-reference/source/list-sources.md): Retrieves sources within the current agency. - [Add a source](https://developers.closebot.com/api-reference/source/add-a-source.md) - [Get a source](https://developers.closebot.com/api-reference/source/get-a-source.md): Retrieves information for a single source. - [Delete a source](https://developers.closebot.com/api-reference/source/delete-a-source.md): Deletes a source and all associated information from Closebot. - [List HubSpot owners](https://developers.closebot.com/api-reference/source/list-hubspot-owners.md): Returns the list of HubSpot users (owners) available as message senders for a HubSpot source. Returns an empty list for non-HubSpot sources. - [List source calendars](https://developers.closebot.com/api-reference/source/list-source-calendars.md): Lists all calendars attached to a source. - [List source channels](https://developers.closebot.com/api-reference/source/list-source-channels.md): Lists all channels available to a source. - [List source fields](https://developers.closebot.com/api-reference/source/list-source-fields.md) - [List source tags](https://developers.closebot.com/api-reference/source/list-source-tags.md) - [Update a source](https://developers.closebot.com/api-reference/source/update-a-source.md): Updates fields in a source. - [Get the webhook integration configuration for a source](https://developers.closebot.com/api-reference/source/get-the-webhook-integration-configuration-for-a-source.md): Returns the setup wizard configuration. The external API key itself is never returned, only whether one is saved. - [List captured webhook events](https://developers.closebot.com/api-reference/source/list-captured-webhook-events.md): Returns up to 3 events captured while the source was in listen mode, newest first. The setup wizard polls this endpoint. - [Save the contact fetch configuration](https://developers.closebot.com/api-reference/source/save-the-contact-fetch-configuration.md): Saves the optional request executed on inbound messages to fetch contact details (typically a GET with {{contactId}}), plus the mapping of contact field descriptors to JSON paths within its response body. Passing a null template disables contact fetching. - [Save the inbound webhook mapping](https://developers.closebot.com/api-reference/source/save-the-inbound-webhook-mapping.md): Saves the JSON path mapping, filter key and token requirement. Passing a null mapping reverts inbound processing to the legacy packet format (kind/contactId/body). - [Save the outbound webhook configuration](https://developers.closebot.com/api-reference/source/save-the-outbound-webhook-configuration.md): Mode "legacy" POSTs bot events to the callback URL; mode "templates" executes the saved HTTP request templates directly against the external API. For the external API key: null leaves it unchanged, an empty string clears it. - [Get agencysource custom channels](https://developers.closebot.com/api-reference/sourcechannel/get-agencysource-custom-channels.md) - [Post agencysource custom channels](https://developers.closebot.com/api-reference/sourcechannel/post-agencysource-custom-channels.md) - [Get agencysource custom channels 1](https://developers.closebot.com/api-reference/sourcechannel/get-agencysource-custom-channels-1.md) - [Put agencysource custom channels](https://developers.closebot.com/api-reference/sourcechannel/put-agencysource-custom-channels.md) - [Delete agencysource custom channels](https://developers.closebot.com/api-reference/sourcechannel/delete-agencysource-custom-channels.md) - [Send a webhook event](https://developers.closebot.com/api-reference/webhook/send-a-webhook-event.md) ## OpenAPI Specs - [openapi](/api-reference/openapi.json) - [swagger](https://megastream25-api.closebot.com/swagger/v1/swagger.json) ## Optional - [Documentation](https://docs.closebot.com/) - [Blog](https://closebot.com/blog) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.