# ClientSphere Docs

> ClientSphere is a CRM with support and marketing built in: accounts and contacts, a sales pipeline, a tickets inbox and live chat, broadcasts and sequences, quotes and invoices, and a REST API.

This is the product manual, in three tracks: Set up is for the person who administers a workspace, Use is for everyone on the team, Build is for developers. Each guide covers one screen, the rules it enforces, and the messages it can show.

## Introduction

- [Overview](https://app.clientsphere.io/docs): Set up your workspace, learn everyday work in ClientSphere, or build against the API.
- [What is ClientSphere](https://app.clientsphere.io/docs/introduction/what-is-clientsphere): One workspace for the whole client relationship, and how its parts fit together.
- [Quick start](https://app.clientsphere.io/docs/introduction/quick-start): From an empty workspace to answering tickets and sending a broadcast, in the order the pieces depend on each other.

## Set up

- [Setup overview](https://app.clientsphere.io/docs/setup): Configure a ClientSphere workspace in the order the features depend on each other, and know which steps are optional.
- [Create your workspace and invite your team](https://app.clientsphere.io/docs/setup/workspace/workspace-and-team): Sign up, create the company, invite people with a role, and understand what a role shows and hides.
- [Customise your CRM](https://app.clientsphere.io/docs/setup/workspace/customise-your-crm): The pipeline stages deals move through, the statuses accounts and tasks can have, and the modules that group tickets. Set them before the data arrives.
- [Import your data](https://app.clientsphere.io/docs/setup/workspace/import-your-data): Bring accounts and contacts in from a CSV with column mapping, or pull them from Zoho CRM. Where the import page lives and what each entity needs.
- [Audit trails](https://app.clientsphere.io/docs/setup/workspace/audit-trails): The record of what changed in the workspace and who changed it, what it covers, and how to search it.
- [Set up email sending](https://app.clientsphere.io/docs/setup/email/email-sending): Verify a domain, publish its DNS records, and create a sending address. Broadcasts, sequences and transactional email all wait on this.
- [Connect a support inbox](https://app.clientsphere.io/docs/setup/email/support-inbox): Turn a support address into tickets. Create the channel, forward your mailbox to it, confirm, and set what happens to each new email.
- [Connect a sales inbox](https://app.clientsphere.io/docs/setup/email/sales-inbox): Route inbound sales email into the Sales Inbox with an SLA and an assignee, the same way a support channel feeds tickets.
- [Working hours, SLAs and assignment](https://app.clientsphere.io/docs/setup/email/working-hours-slas-assignment): Set the hours the SLA clocks run, the response targets per channel, and how each new ticket or sales item gets an owner.
- [Connect Gmail](https://app.clientsphere.io/docs/setup/email/connect-gmail): Link a Gmail mailbox so the CRM can send from it and log its conversations against your accounts, and control what gets synced.
- [Put the Support Hub on your site](https://app.clientsphere.io/docs/setup/site/support-hub): Create a support channel, choose what visitors see when they open the widget, and paste one script tag onto your site.
- [Put the floating launcher on your product](https://app.clientsphere.io/docs/setup/site/floating-launcher): Configure the pill button and its quick-action menu, install it with the user's identity, and feed Product Analytics.
- [Publish your knowledge base](https://app.clientsphere.io/docs/setup/site/publish-knowledge-base): Turn on the public help centre, decide who can write and publish, brand it, and serve it on your own domain.
- [Turn on AI](https://app.clientsphere.io/docs/setup/ai-and-developers/turn-on-ai): Every AI switch in one place, what each one controls, and the order to turn them on so the assistant answers well and stays quiet when it should.
- [API keys, logs and MCP](https://app.clientsphere.io/docs/setup/ai-and-developers/api-keys-and-mcp): Generate a key, decide what it may do, watch what it does, and connect an AI assistant to your data over MCP. The admin side; the developer detail is in the Build track.
- [Sandbox mode and test data](https://app.clientsphere.io/docs/setup/ai-and-developers/sandbox-mode): What sandbox is, how to get a test API key, and how to wipe test data when you are done.

## Use

- [Use overview](https://app.clientsphere.io/docs/use): Everyday work in ClientSphere, one screen at a time, with a starting point for each role.
- [From lead to customer](https://app.clientsphere.io/docs/use/crm/leads): Add and qualify leads, work them as a list or a pipeline, convert the good ones, and disqualify the rest with a reason.
- [Accounts and contacts](https://app.clientsphere.io/docs/use/crm/accounts-and-contacts): Accounts are the companies you work with and contacts are the people. How to create them, link them, and keep one record per company.
- [Opportunities and the pipeline](https://app.clientsphere.io/docs/use/crm/opportunities): Track deals through the stages you define, in a list, a grid, or a kanban board you drag cards across.
- [Tasks](https://app.clientsphere.io/docs/use/crm/tasks): Create and assign tasks, link them to an account, and work them as a list, a grid, or a calendar.
- [Build a contact list](https://app.clientsphere.io/docs/use/email/contact-lists): Static lists you curate, dynamic lists that keep themselves current, and what each means when a broadcast goes out.
- [Import a list from a spreadsheet](https://app.clientsphere.io/docs/use/email/import-a-list): Build a contact list from a CSV or Excel file, decide whether the rows are people or companies, map the columns, and read the results.
- [Send your first broadcast](https://app.clientsphere.io/docs/use/email/send-a-broadcast): Choose an audience and a sender, write the email with merge variables, preview it against a real contact, send a test, then send or schedule it.
- [Transactional email](https://app.clientsphere.io/docs/use/email/transactional-email): Templates your own systems send by slug, the variables they must declare, the sent log, and why sent and delivered are different words.
- [Unsubscribes and bounces](https://app.clientsphere.io/docs/use/email/unsubscribes-and-bounces): The two lists that stop email going out, what each one means, and when it is safe to remove someone from them.
- [Sequences](https://app.clientsphere.io/docs/use/automation/sequences): Build a multi-step email series with delays between steps, test each step, activate it, and watch who is moving through it.
- [Triggers](https://app.clientsphere.io/docs/use/automation/triggers): Enrol people into a sequence automatically when something happens, with conditions to narrow it, and a backfill to catch up existing records.
- [Work the tickets inbox](https://app.clientsphere.io/docs/use/support/tickets): Find the tickets that need you, reply by email or leave a note for your team, let the AI draft, and stay inside the SLA.
- [Live chat conversations](https://app.clientsphere.io/docs/use/support/live-chat): Answer visitors from the chat widget, take over from the AI, leave notes for colleagues, and close and reopen conversations.
- [Work the sales inbox](https://app.clientsphere.io/docs/use/support/sales-inbox): Inbound sales email as a queue: reply, leave notes for your team, assign, snooze, and link each conversation to the account it belongs to.
- [Triage feature requests](https://app.clientsphere.io/docs/use/support/feature-requests): Review the suggestions visitors submit through the widget and the launcher, track them through statuses, and keep notes the submitter never sees.
- [Write and publish articles](https://app.clientsphere.io/docs/use/support/articles): Draft help articles, organise them in categories, publish them to customers and the AI, and find the ones that need fixing.
- [Quotes and invoices](https://app.clientsphere.io/docs/use/finance/quotes-and-invoices): Send a quote, turn it into an invoice, record payments against it, share it by link, and set up recurring plans. And what the product does not do yet.
- [Documents](https://app.clientsphere.io/docs/use/finance/documents): Upload contracts, proposals, and templates, file them by category, and attach them to the account they belong to.
- [Reports](https://app.clientsphere.io/docs/use/insights/reports): The built-in reports and headline figures by category, exactly how each figure is calculated, and how to build and export your own report.
- [Product Analytics](https://app.clientsphere.io/docs/use/insights/product-analytics): Who is using your product, which customers are going quiet, and what people search for without finding an answer. What each number means and where it comes from.
- [Dashboard and AI insights](https://app.clientsphere.io/docs/use/insights/dashboard-and-insights): What the dashboard shows, and how to turn on the daily AI briefing, read its cards, and dismiss the ones you have handled.
- [Ask the AI assistant](https://app.clientsphere.io/docs/use/insights/ai-assistant): What the assistant can see, what to ask it, how the context your admin set shapes its answers, and where its conversations live.
- [Notifications](https://app.clientsphere.io/docs/use/insights/notifications): What ClientSphere notifies you about, where to find them, and how to clear them.

## Build

- [ClientSphere API](https://app.clientsphere.io/docs/build): A REST API for the accounts, contacts, opportunities, leads and messaging behind your ClientSphere workspace.
- [Quickstart](https://app.clientsphere.io/docs/build/guides/quickstart): Create an API key and make your first authenticated request to the ClientSphere API.
- [Authentication](https://app.clientsphere.io/docs/build/guides/authentication): How to send a ClientSphere API key, and what determines whether a key may call a given endpoint.
- [Test and live data](https://app.clientsphere.io/docs/build/guides/test-and-live-data): How sk_test_ and sk_live_ API keys keep sandbox data and production data completely separate.
- [Pagination](https://app.clientsphere.io/docs/build/guides/pagination): How list endpoints page their results, and how to walk a collection larger than one page.
- [Errors](https://app.clientsphere.io/docs/build/guides/errors): The error response shape the ClientSphere API returns, and what each error code means.
- [Rate limits](https://app.clientsphere.io/docs/build/guides/rate-limits): How many requests a ClientSphere API key may make, and how to handle being limited.
- [Support Hub](https://app.clientsphere.io/docs/build/guides/support-hub): Install the ClientSphere Support Hub on your site, identify visitors, and understand what it writes to your CRM.
- [Floating launcher](https://app.clientsphere.io/docs/build/guides/floating-launcher): Install the floating launcher, a support button with a quick-action menu that is separate from the Support Hub.

## Optional

Generated reference for every REST endpoint. The OpenAPI document behind it is the better machine-readable source.

- [List accounts](https://app.clientsphere.io/docs/build/api/accounts/list-accounts): Returns a paginated list of accounts. Supports filtering by status, industry, size, and tag.
- [Get account](https://app.clientsphere.io/docs/build/api/accounts/get-account): Fetches a single account by its id. Responds 404 if no account with that id exists in the authenticated company.
- [Create account](https://app.clientsphere.io/docs/build/api/accounts/create-account): Creates an account and returns the created record with its generated id. Responds 201 on success, or 400 if the body fails validation.
- [Update account](https://app.clientsphere.io/docs/build/api/accounts/update-account): Updates an account by its id and returns the updated record. Responds 404 if no account with that id exists in the authenticated company.
- [Delete account](https://app.clientsphere.io/docs/build/api/accounts/delete-account): Deletes an account by its id. Responds 404 if no account with that id exists in the authenticated company.
- [List account notes](https://app.clientsphere.io/docs/build/api/account-notes/list-account-notes): Returns notes attached to the given account, most recent first.
- [Get account note](https://app.clientsphere.io/docs/build/api/account-notes/get-account-note): Fetches a single account note by its id, independently of the account it belongs to.
- [Create account note](https://app.clientsphere.io/docs/build/api/account-notes/create-account-note): Creates a note attached to the given account and returns the created note with its generated id.
- [Update account note](https://app.clientsphere.io/docs/build/api/account-notes/update-account-note): Updates an account note by its id and returns the updated note.
- [Delete account note](https://app.clientsphere.io/docs/build/api/account-notes/delete-account-note): Deletes an account note by its id. The account it was attached to is left unchanged.
- [List contacts](https://app.clientsphere.io/docs/build/api/contacts/list-contacts): Returns a paginated list of contacts.
- [Get contact](https://app.clientsphere.io/docs/build/api/contacts/get-contact): Fetches a single contact by its id. Responds 404 if no contact with that id exists in the authenticated company.
- [Create contact](https://app.clientsphere.io/docs/build/api/contacts/create-contact): Creates a contact, or returns the existing one when the address is already in the workspace. 201 when created, 200 when it already existed, so posting the same person twice is safe.
- [Update contact](https://app.clientsphere.io/docs/build/api/contacts/update-contact): Updates a contact by its id and returns the updated record. Changing the email is subject to the same per-company uniqueness rule as creation.
- [Delete contact](https://app.clientsphere.io/docs/build/api/contacts/delete-contact): Deletes a contact by its id. Responds 404 if no contact with that id exists in the authenticated company.
- [List leads](https://app.clientsphere.io/docs/build/api/leads/list-leads): Returns a paginated list of leads. Supports filtering by stage, source, and search.
- [Get lead](https://app.clientsphere.io/docs/build/api/leads/get-lead): Fetches a single lead by its id. Responds 404 if no lead with that id exists in the authenticated company.
- [Create lead](https://app.clientsphere.io/docs/build/api/leads/create-lead): Creates a lead and returns the created record with its generated id. Responds 201 on success, or 400 if the body fails validation.
- [Update lead](https://app.clientsphere.io/docs/build/api/leads/update-lead): Updates a lead by its id and returns the updated record, including any change to its status.
- [Delete lead](https://app.clientsphere.io/docs/build/api/leads/delete-lead): Deletes a lead by its id. Responds 404 if no lead with that id exists in the authenticated company.
- [List opportunities](https://app.clientsphere.io/docs/build/api/opportunities/list-opportunities): Returns a paginated list of opportunities. Supports filtering by stage, deal size, lead source, and pipeline.
- [Get opportunity](https://app.clientsphere.io/docs/build/api/opportunities/get-opportunity): Fetches a single opportunity by its id. Responds 404 if no opportunity with that id exists in the authenticated company.
- [Create opportunity](https://app.clientsphere.io/docs/build/api/opportunities/create-opportunity): Creates an opportunity and returns the created record with its generated id. Responds 201 on success, or 400 if the body fails validation.
- [Update opportunity](https://app.clientsphere.io/docs/build/api/opportunities/update-opportunity): Updates an opportunity by its id and returns the updated record, including any change to its stage or value.
- [Delete opportunity](https://app.clientsphere.io/docs/build/api/opportunities/delete-opportunity): Deletes an opportunity by its id. Responds 404 if no opportunity with that id exists in the authenticated company.
- [List transactional messages](https://app.clientsphere.io/docs/build/api/transactional-email/list-transactional-messages): Returns a paginated send log, newest first. Message content is not included.
- [Get a transactional message's delivery status](https://app.clientsphere.io/docs/build/api/transactional-email/get-transactional-message): Poll this after sending to follow a message from sent through delivered, bounced or complained. Message content is not returned.
- [Send a transactional email](https://app.clientsphere.io/docs/build/api/transactional-email/send-transactional-email): Sends one message to one recipient, from a stored template or inline HTML. It ignores opt-outs and carries no unsubscribe header, so never use it for marketing.
- [List unsubscribes](https://app.clientsphere.io/docs/build/api/email-unsubscribes/list-email-unsubscribes): Returns a paginated list of addresses that have opted out.
- [Check whether an address is unsubscribed](https://app.clientsphere.io/docs/build/api/email-unsubscribes/get-email-unsubscribe): Returns the unsubscribe record for an address. A 404 means the address is not unsubscribed and currently receives email. Matching is case-insensitive.
- [Record an unsubscribe](https://app.clientsphere.io/docs/build/api/email-unsubscribes/create-email-unsubscribe): Opts an address out of all broadcasts, sequences and automated email. Idempotent, so an unsubscribe link can call it on every click without tracking state.
- [Resubscribe an address](https://app.clientsphere.io/docs/build/api/email-unsubscribes/delete-email-unsubscribe): Removes the opt-out so the address receives email again. Idempotent. Does not affect bounce or complaint suppressions, which the CRM manages separately.
- [List tickets](https://app.clientsphere.io/docs/build/api/tickets/list-tickets): Returns a paginated list of support tickets. Deleted tickets are excluded. Read-only: tickets cannot be created or modified through the public API.
- [Get ticket](https://app.clientsphere.io/docs/build/api/tickets/get-ticket): Fetches a single ticket by its id. Responds 404 if no such ticket exists in this workspace, or if it belongs to the other side of the test/live divide.
- [Get ticket counts](https://app.clientsphere.io/docs/build/api/tickets/get-ticket-counts): Returns ticket totals for the workspace in one call, rather than paging a list to count it.
- [List overdue tasks](https://app.clientsphere.io/docs/build/api/tasks/list-overdue-tasks): Returns every task past its due date and not yet complete. Not paginated: there is no meta object, and page and limit are ignored.
- [List tasks](https://app.clientsphere.io/docs/build/api/tasks/list-tasks): Returns a paginated list of tasks. Deleted tasks are excluded. Read-only through the public API.
- [Get task](https://app.clientsphere.io/docs/build/api/tasks/get-task): Fetches a single task by its id. Responds 404 if no such task exists in this workspace, or if it belongs to the other side of the test/live divide.
- [Get task stats](https://app.clientsphere.io/docs/build/api/tasks/get-task-stats): Returns task counts grouped by status, using the statuses this workspace has configured.
- [List activities](https://app.clientsphere.io/docs/build/api/activities/list-activities): Returns the workspace activity feed. Not paginated: every activity comes back in one response, with no meta object, and page, limit and search are ignored.
- [List invoices](https://app.clientsphere.io/docs/build/api/invoices/list-invoices): Returns a paginated list of invoices. Read-only: invoices are raised in the app, not through the public API. Money fields are decimal strings, not numbers.
- [Get invoice](https://app.clientsphere.io/docs/build/api/invoices/get-invoice): Fetches a single invoice by its id. Responds 404 if no such invoice exists in this workspace, or if it belongs to the other side of the test/live divide.
- [List quotes](https://app.clientsphere.io/docs/build/api/quotes/list-quotes): Returns a paginated list of quotes. Read-only through the public API. Money fields are decimal strings, not numbers.
- [Get quote](https://app.clientsphere.io/docs/build/api/quotes/get-quote): Fetches a single quote by its id. Responds 404 if no such quote exists in this workspace, or if it belongs to the other side of the test/live divide.
- [List articles](https://app.clientsphere.io/docs/build/api/knowledge-base/list-knowledge-base-articles): Returns a paginated list of knowledge base articles, internal ones included. Filter on visibility yourself if you only want the public, customer-facing set.
- [List categories](https://app.clientsphere.io/docs/build/api/knowledge-base/list-knowledge-base-categories): Returns every knowledge base category. Not paginated, and unlike most resources these are shared across the test/live divide rather than separated by it.
- [Search articles](https://app.clientsphere.io/docs/build/api/knowledge-base/search-knowledge-base-articles): Full-text search across knowledge base articles. The response nests differently from the other lists: data is an object holding articles and totalCount.
- [Get workspace summary](https://app.clientsphere.io/docs/build/api/stats/get-stats-summary): Ticket, lead and task totals in a single call, for dashboards that would otherwise fan out across four endpoints.
- [List widgets](https://app.clientsphere.io/docs/build/api/widgets/list-widgets): Returns all chat widgets for the authenticated company.
- [Get widget](https://app.clientsphere.io/docs/build/api/widgets/get-widget): Fetches a single chat widget by its id, including the configuration the embed script reads.
- [Create widget](https://app.clientsphere.io/docs/build/api/widgets/create-widget): Creates a new chat widget with a default support channel.
- [Update widget](https://app.clientsphere.io/docs/build/api/widgets/update-widget): Updates a chat widget by its id and returns the updated configuration. Changes take effect the next time the embed script loads.
- [Delete widget](https://app.clientsphere.io/docs/build/api/widgets/delete-widget): Deletes a chat widget by its id. Any embed script still pointing at it will stop loading a widget.

---
Full text of every guide: https://app.clientsphere.io/docs/llms-full.txt