Skip to content

Build on VivreCRM with the API

A REST API for everything in your CRM: contacts, leads, deals, companies, tasks, pipelines, imports, reports and webhooks. JSON in, JSON out, with an API key.

Browse the reference Download the OpenAPI spec
Your first request
$ curl "https://api.vivrecrm.com/api/v1/contacts/" \
    -H "X-Api-Key: $VIVRE_API_KEY"
200 OK
{
  "count": 248,
  "next": "https://api.vivrecrm.com/api/v1/contacts/?cursor=cD0y",
  "results": [
    {
      "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
      "full_name": "Asha Rao",
      "email": "[email protected]",
      "company": { "name": "Kaveri Foods" }
    }
  ]
}

Your first request in three steps

  1. Make an API key. In VivreCRM, open Developers, then API keys. A key belongs to one organization and acts with the role of the person who made it.
  2. Send it with every request as X-Api-Key: <key>. Authorization: Api-Key <key> works too.
  3. Call any endpoint under the base URL. Start with GET /contacts/ and you will see your own records.

How every endpoint behaves

Learn these once and they hold across the whole API.

IDs
Every record's id is a UUID. Use it in paths, such as /contacts/{id}/.
Pagination
Lists come in pages. Follow the next and previous URLs until next is null.
Safe retries
Send an Idempotency-Key header on a write, and a retry within 24 hours replays the first result instead of creating a duplicate.
Errors
A failed request returns a status code and a JSON body. detail holds a message, or a message for each field that failed.
Search and order
Lists take search to filter and ordering to sort. Prefix a field with - to sort descending.
Your permissions
A key can do what its scopes and the person's role allow, in its own organization only.

The reference

237 endpoints in 14 groups, generated from the live API.

Included in Pro

API access comes with the Pro plan. Try VivreCRM free, then upgrade when you are ready to build.

See plans

Rather not write code?

Connect Claude, Cursor or another AI assistant to VivreCRM and ask for what you need in plain language.

Connect your AI assistant