Nimble API Documentation
This is the complete API documentation for connecting to the Nimble API using MindCloud's Universal API. If you are new to MindCloud, start with the Introduction to see how one API can sit in front of many different apps.
MindCloud is an integration company that offers one normalized API to access 3,100+ apps from a single place. It cleans up provider-specific quirks, keeps requests and responses consistent, and centralizes authentication so you do not need to manage separate flows for every app. Browse other apps.
Meet Nimble: Manage Nimble contacts, leads, deals, pipelines, notes, and draft messages. Keep reading to get started.
Quickstart
Before you run your first Nimble request, you need three things:
- A MindCloud account — sign in or create an account at MindCloud.
- A MindCloud API Key — create one in API Keys. Keep it on your server.
- At least one Nimble connection — create or choose one in Connections. Note its
connectionId.
Every Nimble action uses the same URL pattern:
https://connect.mindcloud.co/v1/universal/nimble/latest/actions/{actionSlug}You need a MindCloud API Key and a Nimble connection. Then call an action such as Get Contact:
curl --request GET \
--url "https://connect.mindcloud.co/v1/universal/nimble/latest/actions/get-contact" \
--header "Authorization: Bearer $MINDCLOUD_API_KEY" \
--get \
--data-urlencode "connectionId=$CONNECTION_ID"Every response comes back in the same envelope, with your rows in a data array:
{
"success": true,
"data": [
{ "id": "1042", "name": "Ava" }
],
"meta": {}
}After your first request works, use Shape your requests to control arguments, pagination, filtering, fields, and errors.
Authentication
Authentication has two layers. Your MindCloud API Key authenticates the request to MindCloud, sent as a Bearer token in the Authorization header. The connectionId selects the connected Nimble account that should run the action. MindCloud stores and refreshes the Nimble credentials behind that connection, so you never send provider tokens with your requests.
Pass connectionId in the query string for GET and DELETE actions, and in the JSON body for POST, PUT, and PATCH actions. Keep your MindCloud API Key on your server; do not ship it in browser code, mobile apps, public repositories, or logs.
Nimble actions
All 24 published actions for this Nimble version. Each page documents the endpoint, arguments, and response controls.
- PUTAssign Tags to Contact
- POSTCreate Contact
- POSTCreate Contact Note
- POSTCreate Deal
- POSTCreate Draft Message
- DELETEDelete Contact
- DELETEDelete Contact Note
- DELETEDelete Deal
- PUTExit Lead from Pipeline Successfully
- PUTExit Lead from Pipeline Unsuccessfully
- GETGet Contact
- GETGet Current User
- GETGet Deal
- GETList Contact Notes
- GETList Contact Pipelines
- GETList Contact Proceedings
- GETList Contacts
- GETList Deal Pipelines
- GETList Deals
- PUTMove Lead To Pipeline Stage
- GETSearch Contacts by Identifiers
- PUTUpdate Contact
- PUTUpdate Contact Note
- PUTUpdate Deal
Related apps
More Sales & CRM apps on the Universal API, behind the same REST shape. Or browse all apps.