Developers

Carom has a JSON API over everything it keeps for your team: contacts, organizations, deals, threads, files, tasks, and the rest. A key acts as the user who created it, so anything you build through the API sees what that person sees, and no more.

Reach it directly over HTTPS, or from an AI agent.

#What's here

API referenceEvery operation an API key can call, resource by resource, with its parameters, response, and errors.
OpenAPI specificationThe same operations in machine-readable form, as OpenAPI 3.1.

#Get a key

Create a key in the Carom app under Settings › API keys, and keep it somewhere safe: Carom shows it once. Keys come in two tiers, read and read/write, and an account admin decides whether keys work at all and whether they can write. Authentication covers both.

Send the key as a bearer token to https://api.carom.io. Make a first request walks through one, and Errors and Pagination cover what every response can do. If something is missing or unclear, write to us.

get/users/current

curl https://api.carom.io/users/current \
  -H "Authorization: Bearer $CAROM_API_KEY"

The same, with the CLI

carom auth login
carom me