ClientSphere API

A REST API for the accounts, contacts, opportunities, leads and messaging behind your ClientSphere workspace.

The ClientSphere API is a REST API over the same data your workspace uses: accounts and their notes, contacts, leads and opportunities; quotes, invoices, tickets and tasks; the knowledge base; and transactional email.

Every endpoint lives under /api/v1, takes and returns JSON, and is authenticated with an API key you create in Settings → API Keys.

Start here

Quickstart

Make your first authenticated request in a couple of minutes.

Authentication

API keys, the two ways to send one, and what a key is allowed to do.

Test and live data

How sk_test_ and sk_live_ keys separate sandbox data from production.

Support Hub

Install the hub on your site, and identify visitors to it.

Floating launcher

A support button and quick-action menu — the other embed.

API reference

Every endpoint, with parameters, responses and a request you can send.

What to know before you build

Four things behave the same way across every endpoint, and reading them once will save you rediscovering them one at a time:

Authentication — one key, sent as a bearer token or an X-API-Key header; the key's permissions decide what it may call.
Pagination — list endpoints wrap results in a data array with meta.pagination beside it, never a bare array.
Errors — every failure is a JSON body with a stable error.code worth branching on.
Rate limits — 60 requests a minute per key by default, with the remaining budget in the response headers.
Test and live data — a key is bound to one or the other and cannot cross over.