Nimble API Access

Learn how to access the Nimble API for your business.

Ionia avatar
Written by Ionia
Updated over a week ago

What is an API

An API (Application Programming Interface) is a set of rules, protocols, and tools that allows different software applications to communicate with each other. It defines the methods and data formats that applications can use to request and exchange information. APIs are commonly used to enable integration between different systems, allowing them to share data and functionality seamlessly. They are essential for building software solutions that leverage the capabilities of multiple applications or services.

In Nimble, you can sync Contacts, Tasks, and now Deals through the API.

Obtaining an API Key 

Please follow the steps outlined here to obtain an API key for your account. Generate an API key.

Syncing Deals

With Nimble's API now able to sync deals, users can seamlessly integrate their deal data with other software applications or services to continuously sync deal data or migrate deal data from their current CRM to Nimble. Get started here: Deals API

Here's some of what you can do:

  • List all user's deals

  • Create and delete deals

  • Add and update Tags

  • List Deal standard and pipeline Fields

  • Create, Update, and Deleted Deal Pipelines

  • List pipeline deals by stage and/or owners

  • Add, update, and delete custom deal fields

  • Many more deal options

Accessing Your Account Programmatically

To use API keys to access your account programmatically, please follow the guide at with two important changes:

  1. Send API request to instead of

  2. The only form of accepted authentication is through the HTTP header. Your API request must have an Authorization header with a value like this: Bearer API-KEY.

Python request example

import requests 

apikey = "YOUR_API_KEY"

result = requests.get("", headers={"Authorization": "Bearer " + apikey})


cURL example

curl -H "Authorization: Bearer YOUR_API_KEY"


API Access over REST API 

(Older Accounts and Third-Party Developers Only)

The Nimble platform offers access to stored data via our APIs. Older accounts and third-party developers may use our REST API. If you are a normal end-user, please use API Access via an admin-generated token.

GET contact list and contact detail, includes simple SEARCH – available
CREATE/UPDATE/DELETE contact - available
GET contact list with advanced SEARCH - available
GET/CREATE/UPDATE/DELETE custom fields and groups via metadata API - available
GET/CREATE/UPDATE/DELETE notes related to contacts - available
CREATE related activities - available
GET related activities - TBD
GET related messages - TBD
GET related social - TBD
MERGE contact - TBD
Given the early state of the API, some aspects of the API are subject to change.
We are building the API with a few main use cases in mind: widgets/extensions to Nimble, web clients (including our own), mobile clients, and ultimately 2-way data integrations with other services. We aspire to make an API that is simple to use, easy to read, and flexible.
For Nimble API Access, please email and include the following:
App Name
App Description
Redirect URL for oAuth callback

To read our API documentation, please visit

Important note to developers:

If you have started to receive a "redirect_uri_mismatch" error when making the token request, please check to make sure that if you provide a callback uri as part of the original authorization request that you are also including it in the token request. The oauth spec states that if the redirect uri is part of the authorization request then it must also be included and match exactly in the token request. We have found that our upgraded oauth service enforces this whereas our previous one did not.

If you have any questions, please send us an email at

Did this answer your question?