Nimble CRM API
69
AI ReadinessAI-Aware (B+)69/100
Agent-ready OpenAPI document · curated by JenticCRMContact Managementbearer, oauth241 EndpointsREST
Know of an official OpenAPI document? Contribute it →
For Agents
Create and update contacts, manage deals and pipelines, attach notes and files, and search linked messages on Nimble CRM across 41 endpoints under api.nimble.com/api/v1.
Use for: Create a new contact with email, phone, and company fields, Update the lifecycle stage of an existing Nimble contact, Batch-delete a list of contact IDs that bounced, Attach a discovery-call note to a contact
Not supported: Does not handle email sending, marketing automation, or telephony - use for Nimble CRM contact, deal, pipeline, note, and message operations only.
Jentic publishes the only available OpenAPI specification for Nimble CRM API, keeping it validated and agent-ready. Nimble is a CRM that consolidates contacts, deals, pipelines, messages, and notes alongside social and email signals so small teams can run a sales process from a single record. The API exposes 41 endpoints covering contact CRUD with batch deletes, custom contact fields and field groups, contact notes and tags, deals and deal pipelines with stats, deal notes and file attachments, message search across linked email and social channels, and the authenticated user's own profile. Auth is OAuth 2.0 authorisation code flow returning a bearer token.
Install Jentic One Beta
Connect the Nimble CRM API to your agent
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Nimble CRM API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.
Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.
1
Step 1: Jentic One Host machine
# On the machine that will host your Jentic One instance:
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fnimble.com%2Fnimble" | sh2
Step 2: Agent machine
# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fnimble.com%2Fnimble" | sh
jentic register # connects your agent to your Jentic One instanceJentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.
Capabilities
What an agent can do with Nimble CRM API.
Create, update, and batch-delete contact records through /contacts and /contact/{contact_id}
Define and group custom contact fields through /contact/fields and /contact/fields/group
Attach, edit, and remove contact notes through /contact/{contact_id}/notes
Tag contacts in bulk through PUT /contact/{contact_id}/tags
Track deals through pipeline stages with /deals, /deal/{deal_id}, and /deals/stats
Annotate deals with notes and file attachments through /deal/{deal_id} routes
Resolve the authenticated user via /myself for permission-aware actions
Use Cases
Patterns agents use Nimble CRM API for, with concrete tasks.
★ CRM contact sync from a marketing platform
When a contact is created in a marketing platform, an integration creates the corresponding Nimble record with full firmographic data. POST /contacts creates the record, PUT /contact/{contact_id} updates fields when the marketing record changes, and DELETE /contact/{contact_id} removes contacts that opted out. Custom fields defined through /contact/fields keep marketing attributes alongside Nimble's defaults.
POST a new contact to /contacts with first name, last name, primary email, and company, then PUT /contact/{contact_id} to add a custom 'lifecycle_stage' field value.
Deal pipeline reporting
Sales managers need a daily roll-up of open deals by stage and value. /deals returns deals filtered by pipeline and stage, /deals/stats returns aggregate counts and amounts, and /pipelines lists the current pipeline schema. Together they power a CRM dashboard without scraping the Nimble UI.
Call GET /deals/stats and post the open deal count and total amount to a #sales Slack channel each morning.
Activity logging from a meeting recorder
After a sales call, a meeting-recorder integration creates a contact note and attaches the recording. POST /contact/{contact_id}/notes adds the structured summary, and the matching deal-note endpoint can be used when the call relates to an open opportunity. PUT /contact/{contact_id}/notes/{note_id} edits the note as the human reviewer cleans up the summary.
POST a note to /contact/{contact_id}/notes with the meeting summary text and a reference to the recording URL.
Tag-based campaign segmentation
Marketers need to tag a cohort of contacts before launching a campaign. PUT /contact/{contact_id}/tags assigns one or more tags to a contact, and the agent can iterate over a list of contact IDs returned by GET /contacts/ids to scope the operation to the right segment.
GET /contacts/ids filtered by city=Dublin, then PUT /contact/{contact_id}/tags for each ID with the tag 'dublin-event-2026'.
AI agent CRM updates
An AI agent embedded in Slack or a sales workspace can create contacts, log notes, and update deals on Nimble without the user opening the CRM. Through Jentic, the agent searches for the right Nimble endpoint by intent and Jentic returns the schema with the OAuth bearer token attached server-side.
Search Jentic for 'create a contact in nimble', load POST /contacts, and execute it with name and email parsed from a chat message.
Key Endpoints
41 endpoints — jentic publishes the only available openapi specification for nimble crm api, keeping it validated and agent-ready.
METHOD
PATH
DESCRIPTION
POST
/contacts
Create a new contact
GET
/contacts
List contacts with filters
PUT
/contact/{contact_id}
Update a contact
POST
/contact/{contact_id}/notes
Add a note to a contact
PUT
/contact/{contact_id}/tags
Assign tags to a contact
POST
/deals
Create a deal
GET
/deals/stats
Get aggregate deal stats
GET
/myself
Get the authenticated user profile
POST
/contacts
Create a new contact
GET
/contacts
List contacts with filters
PUT
/contact/{contact_id}
Update a contact
POST
/contact/{contact_id}/notes
Add a note to a contact
PUT
/contact/{contact_id}/tags
Assign tags to a contact
POST
/deals
Create a deal
GET
/deals/stats
Get aggregate deal stats
GET
/myself
Get the authenticated user profile
Jentic AI Readiness Score
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.
N
Nimble CRM API
- AI-Aware (B+)69/100
89
Foundational Compliance63
Developer Experience & Jentic Compatibility54
AI-Readiness & Agent Experience94
Agent Usability75
Security66
AI DiscoverabilityPowered by JenticScoring Framework 1.0.0 | Scoring Engine 0.4.0
Show dimension breakdown
89
Foundational Compliance
Base layer of spec validity and structural soundness.
Grade: ASignals: 4
97%
Lint Results
Aggregated quality score from linter diagnostics, weighted by severity.
100%
Resolution Completeness
Percentage of `$ref` references that resolve successfully.
100%
Specification Validity
Checks whether the API description parses successfully and conforms to its declared specification (e.g., OpenAPI).
60%
Structural Integrity
Structural correctness score based on schema issues using logarithmic dampening.
63
Developer Experience & Jentic Compatibility
Clarity, completeness, and ingestion readiness for developers and tooling.
Grade: B-Signals: 4
0%
Example Density
How richly the API is illustrated with examples.
100%
Example Validity
Percentage of examples that conform to their schemas.
50%
Response Coverage
Percentage of operations with complete response definitions (success, client error, server error).
100%
Tooling Readiness
Health of API ingestion, bundling, and resolution within Jentic pipelines.
54
AI-Readiness & Agent Experience
Semantic breadth, depth, and agent comprehension for AI systems.
Grade: CSignals: 4
58%
Description Coverage
Coverage of descriptions across API elements.
0%
Error Standardization
Coverage of RFC 9457 Problem Details for error responses.
93%
OperationId Quality
Coverage, uniqueness, and casing consistency of operationIds for AI inference.
63%
Summary Coverage
Coverage of summaries across operations/tags/info.
94
Agent Usability
Functional utility, complexity comfort, and AI orchestration readiness.
Grade: A+Signals: 1
94%
Complexity Comfort
Agent comfort level based on API operational and structural complexity.
75
Security
Trust, risk posture, and security compliance.
Grade: A-Signals: 1
75%
Authentication Strength
Average quality of security schemes based on authentication method strength (weakest link for OAuth2).
66
AI Discoverability
Findability, semantic richness, and reasoning readiness.
Grade: BSignals: 1
66%
Descriptive Richness
Clarity and depth of descriptions across API elements.
Score it yourself
Every API in the directory is allowlisted, so you can re-score it with no key required.
npx @jentic/api-scorecard-cli score <openapi-url>Why Jentic?
What agents get from Jentic-routed access to this vendor.
Setup
Wiring Nimble CRM by hand means handling its bearer or OAuth2 auth, building requests against its versioned host (https://api.nimble.com/api/v1), and managing token refresh yourself. Through Jentic you install once, import the Nimble CRM API from the API Directory, store the token once, and your agent calls it.
Permission scoping
Nimble puts the contact id in the URL path (/contact/{contact_id}/...), so a rule can pin your agent to one contact: it can add notes and update tags for that contact and nothing else. You choose the operations it may call, so destructive ones like deleting a contact or deal are not included unless you add them.
Credential isolation
Your Nimble 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.
Intent-based discovery
Agents search Jentic by intent such as 'create a new contact' or 'add a note to a contact', and Jentic returns the matching Nimble operation with its input schema so the agent calls the right endpoint without browsing the reference docs.
Related APIs
Alternatives and complements available in the Jentic catalogue.
FAQs
Specific to using Nimble CRM API through Jentic.
Why is there no official OpenAPI spec for Nimble CRM API?
Nimble does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call Nimble CRM 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 Nimble CRM API use?
Nimble uses OAuth 2.0 authorisation code flow; the resulting access token is sent as Authorization: Bearer <token> on every call. Through Jentic, the bearer token is held in the vault and attached server-side, so the agent never sees the raw token.
Can I batch-delete contacts in Nimble?
Yes. DELETE /contacts accepts a list of contact IDs in the request body and removes them in a single call, useful for cleaning out a list of bounced or unsubscribed contacts.
What are the rate limits for the Nimble CRM API?
Nimble enforces per-account rate limits but does not publish exact thresholds in this OpenAPI spec. If a script issues many writes in a short window expect HTTP 429; back off and retry.
How do I create a deal through Jentic?
Run pip install jentic, search Jentic for 'create a deal in nimble', and load POST /deals. Provide the pipeline ID, stage ID, contact ID, and amount fields, then execute. Jentic attaches the OAuth bearer token automatically.
Is the Nimble CRM API free?
API access is bundled with paid Nimble Business plans. There is no separate API fee, but a paid Nimble subscription is required.
Can I limit what my agent is allowed to do with the Nimble CRM API?
Yes. Because you run Jentic One yourself, your own rules decide which Nimble operations and credentials the agent may use. Since Nimble puts the contact id in the URL path (/contact/{contact_id}/...), a rule can pin the agent to a single contact so it can add notes through POST /contact/{contact_id}/notes and update tags through PUT /contact/{contact_id}/tags and nothing else. You choose the exact operations it may call, so destructive ones like deleting a contact or a deal stay out of reach unless you add them.
GET STARTED