canonical: https://jentic.com/apis/parma.ai/parma

# Parma CRM API

Jentic publishes the only available OpenAPI specification for Parma CRM API, keeping it validated and agent-ready. The Parma API exposes relationship management, deal tracking, note-taking, group organization, and pipeline management for modern CRM workflows. It powers AI-driven relationship tracking, sales pipeline automation, and collaborative note-taking for teams managing complex professional networks.

## For AI agents

Manage relationships, deals, notes, groups, and sales pipelines programmatically across 12 endpoints with markdown-enabled note-taking.

## Scope

Covers relationship management, deal tracking, note-taking, group organization, and pipeline management. Does not handle email syncing, calendar integration, or third-party CRM imports - use for core CRM data operations only.

## Capabilities

- Create and update relationship records with contact details
- Track deals through custom sales pipelines
- Create markdown-formatted notes linked to relationships
- Organize relationships into groups for segmentation
- List and filter relationships by name, type, or email
- Retrieve pipeline stages and deal progress
- Update deal status and move deals through pipeline stages
- Link relationships to groups and manage group memberships
- Search relationships and deals with pagination support
- Retrieve relationship-specific notes and group associations

## Use cases

### AI-Powered Relationship Intelligence

Build AI agents that automatically create and update relationship records after meetings or interactions. POST `/api/v1/relationships` creates new contacts with name, type, email, and phone, while PATCH `/api/v1/relationships/{id}` updates existing records. Agents can enrich CRM data by searching external sources and updating relationship context.

Example prompt: POST `/api/v1/relationships` with contact details, then POST `/api/v1/notes` to add meeting summary

### Automated Note-Taking and Context Capture

Capture meeting notes, interaction summaries, and relationship context using markdown-formatted notes linked to relationships. POST `/api/v1/notes` accepts markdown content and relationship_id, enabling automated note creation from meeting transcripts or email summaries. GET `/api/v1/relationships/{relationship_id}/notes` retrieves full note history.

Example prompt: POST `/api/v1/notes` with markdown content and relationship_id after each meeting or interaction

### Deal Pipeline Automation

Track sales opportunities through custom pipeline stages by managing deals programmatically. GET `/api/v1/deals` lists all deals with pagination, while GET `/api/v1/deals/{id}` retrieves deal-specific details including stage, value, and associated relationship. Automate deal updates based on customer actions or time-based triggers.

Example prompt: GET `/api/v1/deals` to list pipeline, then update deal stage when trigger conditions are met

### Agent-Driven CRM via Jentic

An AI agent managing professional relationships can create contacts, log interactions as markdown notes, track deals, and organize relationships into groups through Jentic without holding Parma credentials in context. Jentic resolves intents like 'log a meeting with client X' to POST `/api/v1/notes` with the appropriate schema.

Example prompt: Search Jentic for 'create a CRM note', load POST `/api/v1/notes` schema, and execute with relationship context

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/api/v1/relationships` | Create a new relationship record |
| GET | `/api/v1/relationships` | List and search relationships with filtering |
| POST | `/api/v1/notes` | Create a markdown-formatted note |
| GET | `/api/v1/relationships/{relationship_id}/notes` | Retrieve all notes for a relationship |
| GET | `/api/v1/deals` | List all deals with pagination |
| PATCH | `/api/v1/relationships/{id}` | Update relationship information |
| GET | `/api/v1/pipelines` | List all sales pipelines |

## Key resources

- **Relationships** — Contact records with name, type, email, phone, and group associations
- **Deals** — Sales opportunities tracked through pipeline stages
- **Notes** — Markdown-formatted notes linked to relationships
- **Groups** — Relationship segmentation and organization collections
- **Pipelines** — Custom sales pipeline stages and deal flow configuration

## Why Jentic

- **Setup:** Wiring the Parma CRM API by hand means learning its bearer token auth (or its OAuth2 flow), setting the app.parma.ai host, and handling error and retry logic yourself. Through Jentic you install once, import Parma CRM from the API Directory, store the token once, and your agent calls it.
- **Permission scoping:** Parma puts the relationship id in the URL path (`/api/v1/relationships/{id}`), so a rule can pin your agent to reads and updates on relationships you name. You choose the operations it may call, so creating new relationships or writing notes is not included unless you add them.
- **Credential handling:** Your Parma 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 CRM contact' or 'log a meeting note on a relationship', and Jentic returns the matching Parma operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Pipedrive API** — Sales CRM with pipeline management, deal tracking, and activity scheduling
- **HubSpot CRM API** — Full-featured CRM with marketing automation, sales, and service hub integrations

## FAQ

### Why is there no official OpenAPI spec for Parma API?

Parma does not publish an OpenAPI specification for their CRM API. Jentic generates and maintains this spec based on Parma's API documentation so that AI agents and developers can call Parma API via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer.

### What authentication does the Parma API use?

The Parma API supports Bearer token authentication (retrieve your API token from https://app.parma.ai/api) and OAuth 2.0 authorization code flow with optional PKCE. Through Jentic, credentials live in the encrypted vault and are injected at execution time so they never enter agent context.

### Can I create notes with markdown formatting?

Yes. POST `/api/v1/notes` accepts markdown-formatted content in the content field, allowing rich text formatting including headers, lists, links, and emphasis. This is ideal for automated note-taking from meeting transcripts or email summaries.

### How do I organize relationships into groups?

Use POST `/api/v1/relationships/{relationship_id}/groups` with a group_id to link a relationship to a group. GET `/api/v1/relationships/{relationship_id}/groups` returns all groups a relationship belongs to. DELETE removes the association.

### Can AI agents update deals through Jentic?

Yes. Search Jentic for 'update a Parma deal', load the appropriate endpoint schema, and execute with deal ID and updated fields. Jentic handles authentication and request formatting so agents can automate deal pipeline progression.

### What is the rate limit for the Parma API?

Parma does not publish specific rate limits in their documentation. Use reasonable request patterns and implement exponential backoff on 429 responses. Contact Parma support for account-specific rate limit information.

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

Yes. Because you run Jentic One yourself, your own rules decide which Parma operations and credentials the agent can use. Since Parma puts the relationship id in the URL path (`/api/v1/relationships/{id}`), you can pin the agent to reads and updates on the specific relationships you name. You choose the operations it may call, so creating new relationships or writing notes with POST `/api/v1/notes` is not included unless you add them.