• Customermates logo
    CustomermatesDocumentation
  • Introduction
  • Comparison
Getting Started
  • Quickstart
  • Core Concepts
  • From Pipedrive
Connect your AI
  • Connect Claude Code
  • Connect Claude Desktop
  • Connect Codex
  • Connect Cursor
  • Connect Gemini
  • Connect ChatGPT
Integrations
  • MCP
  • Webhooks
  • OpenAPI 3.1.0
  • N8N
Self-Hosting
  • Get Started
  • Architecture & Security
Reference
  • MCP Tool Catalog
  • Filter Syntax
  • API Keys
  • Go back
  1. Introduction
  2. Quickstart

Quickstart

From signup to your first agent-updated deal in five minutes.

Create an account, generate an API key, register Customermates with your AI tool, paste the setup prompt. Five minutes.

1. Create your account

customermates.com/auth/signup. No credit card. The first seven days are free; pick a plan after.

2. Create an API key

Profile → API Keys → New key. Copy the 64-character string immediately — it's shown once.

3. Register Customermates with your AI tool

Pick the page for the tool you use:

  • Claude Code — one terminal command (simplest)
  • Cursor — Settings UI, two clicks
  • Codex — one TOML block in ~/.codex/config.toml
  • Claude Desktop — config file edit + restart
  • ChatGPT — Custom Connector UI (paid plan)

Each page is a 3-step procedure ending with the same setup prompt.

4. Paste this setup prompt as your first message

After you've registered the server, send this to your agent first:

You are now connected to my Customermates CRM through MCP.## About CustomermatesCustomermates is an open-source CRM where the AI I already use keeps the data fresh. Five core entity types:- **Contacts**: people- **Organizations**: companies- **Deals**: sales opportunities with services and total value- **Services**: offerings a deal can include, each with a quantity- **Tasks**: todos assigned to team membersEntities link to each other. A contact belongs to one or more organizations and one or more deals. A deal has contacts, organizations, services (with quantities), and assignees. A task has assignees only. Every entity supports **custom columns** (user-defined fields) and **notes** (markdown).## Before you do anything, ask me for1. My name and role, so you can tailor your replies.2. What I usually do with my CRM, in one sentence.## Rules that keep my data safe- **Never pass `null` on relationship arrays** (`organizationIds`, `dealIds`, `contactIds`, `userIds`, `services`). Null wipes the relationship. Omit the field to keep existing links, pass `[]` to clear all, or use `link_entities` / `unlink_entities` to change specific ids.- **Prefer `link_entities` and `unlink_entities`** over `update_*` with relationship arrays. They merge instead of replacing.- **Custom fields are per-column merge**. Only the columnIds you include are changed; the rest are preserved. To clear one field pass `{ columnId, value: null }`.- **Use the correct per-type custom-column tool**. `update_plain_custom_column` for plain columns, `update_single_select_custom_column` for dropdowns, and so on. The server will tell you if you picked the wrong one.- **Before any create or update**, call `get_entity_configuration` for the entity to learn its custom column ids and filter syntax.- **Destructive actions need confirmation.** For `delete_*` or anything labelled IRREVERSIBLE, confirm with me first unless I explicitly said "just do it".## Suggested first moves1. Call `get_current_user` and `get_company` and tell me who and where I'm working.2. Call `count_entity` for contact, organization, deal, service, and task.3. Call `list_custom_columns` so we don't recreate fields that already exist.4. Ask me what I want to work on first.## Style- Prefer one short paragraph to a bullet wall, unless you're comparing options.- When you're about to run a destructive tool, name the tool and its arguments first.- When I ask "what's happening with X", use `search_all_entities` before guessing the entity type.Ready. Please ask me what I want to focus on.

It tells the agent how to work with your CRM safely — no relationship wipes, right tool per custom-column type, etc.

5. Try a real prompt

  • "Move the Acme deal to stage 'Won' and add a note that the contract was signed today."
  • "Pull the last ten contacts I created. Any without an email address?"
  • "Create a contact for Jane Doe at Initech, link it to the Initech org, and start a deal for 12 hours of consulting."

The agent tells you which tools it used and what changed. No copy-paste, no app switching.

6. Optional: subscribe to a webhook

Want other tools notified when the CRM changes?

Company → Webhooks → New. URL: a throwaway webhook.site. Events: pick contact.created and deal.updated. Save.

Edit a contact. Within a few seconds the delivery shows up at webhook.site with the full payload. That's your CRM telling your stack what changed.

Full webhook docs: Webhooks.

Next

  • Core concepts: entities, custom columns, relations at a glance.
  • From Pipedrive: migration guide.
  • MCP tool catalog: every tool your AI can call.
1. Create your account
2. Create an API key
3. Register Customermates with your AI tool
4. Paste this setup prompt as your first message
5. Try a real prompt
6. Optional: subscribe to a webhook
Next