How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Nimble Leads API

Lead transitions through contact pipelines — move a lead between stages, mark it exited successfully or unsuccessfully, and undo a transition. 7 operation(s).

Nimble Leads API is one of 12 APIs that Nimble publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Leads, Pipelines, and Sales. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 7 operations across 5 paths, and defines 39 schemas. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against a single base URL, https://app.nimble.com.

7 operations 5 paths 39 schemas 1 DELETE4 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1
Base URL
https://app.nimble.com
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Nimble Leads API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-Nimble-Token (ApiKey). By default, every request must be authenticated.

Paths & Operations 7

Across 5 paths, the API surfaces 7 operations — 1 DELETE, 4 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Leads 7
POST
/api/v2/leads/{lead_id}/{pipeline_id}/successful
Exit lead from pipeline successfully
mark-lead-exited-successful 2 params body → 200404406
PUT
/api/v2/leads/{lead_id}/{pipeline_id}/successful
Update the 'successful exit' transition
put-lead-exit-successful 2 params body → 200404406
POST
/api/v2/leads/{lead_id}/{pipeline_id}/unsuccessful
Exit lead from a pipeline unsuccessfully
mark-lead-exited-unsuccessfully 2 params body → 200404406
PUT
/api/v2/leads/{lead_id}/{pipeline_id}/unsuccessful
Update the 'unsuccessful exit' transition
put-lead-exit-unsuccessful 2 params body → 200404406
POST
/api/v2/leads/{lead_id}/{pipeline_id}/move
Move lead to a pipeline stage
move-lead 2 params body → 200404406
POST
/api/v2/leads/{lead_id}/{pipeline_id}/undo
Undo lead won/lost transition
undo-lead-transition 2 params → 200404406
DELETE
/api/v2/leads/{lead_id}/{pipeline_id}
Clear leads transitions
delete-lead-transitions 2 params → 200404406

Schemas 39

The contract defines 39 schemas that model the data the API accepts and returns. The most detailed are Contacts.ContactView (23 properties), Sequences.InSequenceContactInfo (14 properties), Attachments.AttachmentData (9 properties), Messages.EmailList (9 properties). Each schema is shown below with its type and property counts.

Attachments.GoogleDriveAttachmentData
Contacts.Principals
object
Explicitly defines users and groups that have an action permission. If any set - no one can.
2 properties 2 required
Contacts.ContactType
string
Contacts.ContactPrivacy
object
Defines scopes of object visibility and editability. Edit permission means that group or user also is able to read an object. No duplication, if id in edit Pri…
2 properties 2 required
Contacts.UserLastContactedView
object
3 properties
Sequences.InSequenceContactInfo
object
14 properties
Contacts.EmailListsContext
object
2 properties
Messages.EmailListConfirmationMessageRequest
object
3 properties 3 required
Contacts.ContactNotice
object
6 properties 6 required
Attachments.OneDriveAttachmentData
Sequences.SequenceProgressionOutcomes
Contacts.ExitLeadSuccessfullyRequest
object
2 properties
Contacts.Reminder
object
5 properties 5 required
Messages.MessageTemplateContentSpecification
object
8 properties 2 required
Contacts.InSequenceContactInfoContext
object
2 properties
Contacts.LastContacted
object
6 properties 5 required
Contacts.LastContactedDirectedContainer
object
3 properties
Messages.MessageTemplateContentMode
string
Settings.MessagingAccountIdentifier
object
2 properties 2 required
Messages.MessagingAccountIdentifier
object
2 properties 2 required
Contacts.ContactViewContext
Sequences.InSequenceContactExitDetails
object
3 properties
Accounts.ShortUserInfo
object
5 properties 5 required
Contacts.ContactFilesContext
object
2 properties
Contacts.UploadedContactFile
object
8 properties
Messages.Attachment
object
5 properties 5 required
Attachments.DropboxAttachmentData
Contacts.ExitLeadUnsuccessfullyRequest
object
3 properties
Contacts.ContactView
object
user perspective on a specific contact
23 properties 18 required
Contacts.EmployerInfo
object
employer's info
3 properties
Attachments.AttachmentData
object
9 properties 9 required
Messages.EmailList
object
9 properties
Contacts.LeadsDataContext
object
2 properties
Contacts.LeadInStageInfo
object
info about stage where lead is
6 properties
Contacts.EmployersDataContext
object
2 properties
Contacts.LastContactedDataContext
object
2 properties
Contacts.ContactFile
object
2 properties
Messages.MessagingAccount
object
7 properties
Sequences.CompletedSequenceStepRecord
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nimble-leads-api-openapi.yml Raw ↑

Other APIs Nimble publishes across the network.

Nimble Activities API
Nimble Contacts API
Nimble Contacts Fields API
Nimble Contacts Pipelines API
Nimble Deals API
Nimble Deals Fields API
Nimble Deals Pipelines API
Nimble Deals Pipelines Fields API
Nimble Messages API
Nimble Tasks API
Nimble Users API
Where this information came from

This is an independent, third-party profile of Nimble Leads API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.