canonical: https://jentic.com/apis/cavyro.com/cavyro

# Cavyro API

The Cavyro API runs a workspace CRM that tracks contacts, companies, and deals and moves them through configurable pipeline stages. It manages projects, tasks, docs, calendar events, and dashboards in the same workspace, with custom fields, bulk actions, and a recycle bin across records. Webhook subscriptions, saved reports, and workspace-wide search round out the surface.

## For AI agents

Create contacts and companies, move deals through pipeline stages, run projects and tasks, and search the workspace through the Cavyro CRM API.

## Scope

Does not handle payment processing, email campaign sending, or accounting ledgers. Use for CRM contacts, deals, pipelines, and project tasks only.

## Capabilities

- Create and update contacts and companies with custom fields
- Move deals through configurable pipeline stages
- Build pipelines and configure their stages
- Manage projects, tasks, and task lists
- Run saved reports and dashboards over workspace data
- Search across contacts, companies, deals, and projects
- Subscribe to webhook event types for record changes

## Use cases

### AI Agent Deal Updates

An AI agent connected through Jentic can keep a sales pipeline current: it creates a contact, opens a deal for them in a pipeline, and moves the deal to the next stage as it progresses. Cavyro handles stage order and feed events so the agent records the change rather than clicking through the board.

Example prompt: Create a contact, add a deal for them to a pipeline, and move the deal to the next stage

### Pipeline Configuration

Set up how opportunities flow by creating pipelines and defining their stages. Cavyro lets you add, update, and reorder stages so the CRM reflects a team's real sales process.

Example prompt: Create a new pipeline and add an ordered set of stages for it

### Project and Task Management

Coordinate delivery work alongside sales by creating projects, task lists, and tasks with owners and due dates. Cavyro supports bulk task actions and subtasks so the agent can keep execution in step with the deal.

Example prompt: Create a project, add a task list, and add a task with an owner and due date

### Workspace Reporting

Measure pipeline health by running saved reports and reading dashboards over workspace data. Cavyro exposes deal reports by type and dashboard widgets for recurring views.

Example prompt: Run a saved report on deals closed this quarter and return the summary figures

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/api/v1/contacts` | Create a contact |
| GET | `/api/v1/deals` | List deals |
| POST | `/api/v1/companies` | Create a company |
| POST | `/api/v1/pipelines` | Create a pipeline |
| POST | `/api/v1/projects` | Create a project |
| POST | `/api/v1/campaigns` | Create a campaign |
| GET | `/api/v1/search` | Search the workspace |

## Key resources

- **Contacts** — Contact creation, updates, merges, and custom fields
- **Companies** — Company records, links, and subscriptions
- **Deals** — Deals, bulk status and priority updates, and stage moves
- **Pipelines** — Pipeline creation and stage configuration
- **Projects** — Projects, folders, and membership
- **Tasks** — Task lists, tasks, subtasks, and bulk actions

## AI readiness

This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.

- **Score:** 87 / 100
- **Maturity:** AI-Ready
- **Dimensions:**
  - Foundational Compliance: 71 / 100
  - Developer Experience & Jentic Compatibility: 100 / 100
  - AI-Readiness & Agent Experience: 100 / 100
  - Agent Usability: 94 / 100
  - Security: 100 / 100
  - AI Discoverability: 58 / 100
- **View full report:** https://jentic.com/apis/cavyro.com/cavyro/scorecard
- **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/
- **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview

### Score it yourself

Every API in the directory is allowlisted, so you can re-score it with no key required.

- **Score your own API:** https://jentic.com/scorecard.md
- **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md

```sh
npx @jentic/api-scorecard-cli score <openapi-url>
```

## Why Jentic

- **Setup:** Wiring Cavyro by hand means handling its bearer-token auth, passing an X-Workspace-Id header on workspace-scoped calls, and tracking paths for contacts, deals, pipelines, and tasks yourself. Through Jentic you install once, import Cavyro from the API Directory, store the token once, and your agent calls it.
- **Permission scoping:** You choose which Cavyro operations the agent may call, such as creating contacts and moving deals, so bulk-delete and recycle-bin purge operations are not included unless you add them.
- **Credential handling:** Your Cavyro bearer token is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'create a contact' or 'move a deal stage', and Jentic returns the matching Cavyro operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Salesforce API** — Salesforce is a broad CRM platform with deep customization and automation.
- **Pipedrive API** — Pipedrive is a sales-first CRM centered on deal pipelines.
- **Copper API** — Copper is a CRM that syncs tightly with Google Workspace contacts and email.

## FAQ

### What authentication does the Cavyro API use?

The Cavyro API authenticates with a bearer token sent in the Authorization header, and workspace-scoped operations additionally require an `X-Workspace-Id` header naming the workspace, per its OpenAPI spec. Through Jentic the token is stored encrypted by your own Jentic One instance and injected at call time, so it stays out of the agent's prompt and logs.

### Can I move deals through pipeline stages with the Cavyro API?

Yes. You can create pipelines, define their stages, add deals to a pipeline, and move a deal from one stage to the next. Bulk operations let you reassign, re-stage, or update the status of many deals at once.

### Can I manage projects and tasks with the Cavyro API?

Yes. The API creates projects, folders, task lists, tasks, and subtasks, with owners, due dates, and bulk actions. This lets the agent keep delivery work in step with the sales pipeline in the same workspace.

### Is there a Cavyro MCP server?

You do not need an MCP server to give your agent the Cavyro API. Jentic connects it directly from the API Directory: import Cavyro, store your token once, and your agent updates contacts and deals through the operations the API already exposes. Operations are discovered on demand, so no extra tool definitions are loaded into the agent's context.

### Can I limit what my agent is allowed to do with the Cavyro API?

Yes. Write a rule that allows only the operations the agent needs, for example creating contacts and moving deals, and leave out bulk-delete and recycle-bin purge operations. The agent keeps the pipeline current within those bounds, and every call it makes is logged.

### How do I update a deal through Jentic with the Cavyro API?

Search Jentic for 'move a deal stage', which returns the Cavyro operation with its input schema, then supply the deal and target stage and the agent runs it. To run it on your own infrastructure, install Jentic One from its GitHub repo.