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 Deals Pipelines API

Deal pipelines and stages — create and reshape pipelines, add and archive stages, set lost reasons, and read the deal book grouped by stage or by owner. 13 operation(s).

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

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

This API exposes 13 operations across 9 paths, and defines 53 schemas. It is described by OpenAPI 3.2.0, at version v1.

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

13 operations 9 paths 53 schemas 2 DELETE4 GET5 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 Deals Pipelines 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 13

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

Deals Pipelines 13

Pipelines management

GET
/api/v2/deals/pipelines
List deals pipelines
list-deals-pipelines → 200
POST
/api/v2/deals/pipelines
Create new deals pipeline
post-deals-pipelines body → 201409
GET
/api/v2/deals/pipelines/{pipeline_id}
Get deals' pipeline by id
get-deals-pipeline 1 param → 200404
PUT
/api/v2/deals/pipelines/{pipeline_id}
Update deals' pipeline by id
put-deals-pipeline 1 param body → 200403404409
DELETE
/api/v2/deals/pipelines/{pipeline_id}
Delete deals' pipeline by id
delete-deals-pipeline 1 param → 200403
GET
/api/v2/deals/pipelines/{pipeline_id}/deals
List pipeline's deals separated by stages
list-pipeline-deals-by-stages 6 params → 200
GET
/api/v2/deals/pipelines/{pipeline_id}/owners
List pipeline's deals separated by owners
list-pipeline-deals-by-owner 4 params → 200
POST
/api/v2/deals/pipelines/{pipeline_id}/archive
Archive deals pipeline
mark-deals-pipeline-archived 1 param → 200
POST
/api/v2/deals/pipelines/{pipeline_id}/unarchive
Un-archive deals' pipeline
mark-deals-pipeline-unarchived 1 param → 200
POST
/api/v2/deals/pipelines/{pipeline_id}/lost_reasons
Add new lost reason to deals pipeline
post-deals-pipeline-lost-reason 1 param body → 201403404406
POST
/api/v2/deals/pipelines/{pipeline_id}/stages
Create new deals pipeline stage
post-deals-pipeline-stage 1 param body → 201403404409
PUT
/api/v2/deals/pipelines/{pipeline_id}/stages/{stage_id}
Update deals pipeline stage
put-deals-pipeline-stage 2 params body → 200403404409
DELETE
/api/v2/deals/pipelines/{pipeline_id}/stages/{stage_id}
Archive deals pipeline stage
mark-deals-pipeline-stage-archived 2 params → 200

Schemas 53

The contract defines 53 schemas that model the data the API accepts and returns. The most detailed are Deals.DealView (19 properties), Pipeline.DealsPipeline (13 properties), Pipeline.DealStage (11 properties), Contacts.ShortContact (8 properties). Each schema is shown below with its type and property counts.

Deals.RelatedExternalContact
object
external contact related to this deal
2 properties
Pipeline.AddressFieldValuesType
object
1 property
Errors.ForbiddenError
object
1 property 1 required
Fields.FieldPresentation
how values of the field should look. Must match to corresponding fieldtype. Date and number fields must have an appropriate presentation. There is no presentat…
Pipeline.StringFieldValuesType
object
2 properties
Fields.DateTimePresentation
object
2 properties 2 required
Deals.DealsByOwnerGroup
object
Grouped data about owners and deals related to it + meta
3 properties
Deals.FieldsValues
object
Fields of the deals which was filled up by the owner/creator
2 properties
Deals.DealPipelineTransitions
object
5 properties 4 required
Deals.AzureFileMetadata
object
metadata for files uploaded from device using Azure JS SDK
2 properties
Deals.DealPipelineFieldsTabMember
Deals.DealPrivacy
object
2 properties 2 required
Deals.IDealField
object
6 properties
Fields.FinancialNumberPresentation
object
2 properties 2 required
Errors.ValidationError
object
request was malformed
5 properties 3 required
Fields.PercentageNumberPresentation
object
2 properties 2 required
Pipeline.NumberFieldValuesType
object
1 property
Errors.ActionCanNotBeCompleted
object
Action can not be complited becouse of reason described in error message
2 properties
Deals.DealsStageGroup
object
Grouped data about stage and deals in it + meta
3 properties
Fields.IntegerNumberPresentation
object
1 property 1 required
Pipeline.DealsPipeline
object
13 properties
Pipeline.UserFieldValuesType
object
1 property
Deals.DealPipelineField
object
Fields of DealsPipeline
Deals.DealStageTransition
object
5 properties 4 required
Pipeline.EditDealStageRequest
object
4 properties
Pipeline.EditDealsPipelineRequest
object
Updates pipeline
3 properties
Pipeline.CreateDealsPipelineFieldRequest
object
6 properties 3 required
Deals.EmploymentInfo
object
Information about date employment
4 properties
Deals.ExternalFileMetadata
object
metadata for files from external sources (dropbox, google drive, one drive)
3 properties
Contacts.ShortContact
object
8 properties 7 required
Deals.DealPipelineFieldsGroup
object
Accounts.ShortUserInfo
object
5 properties 5 required
Pipeline.BooleanFieldValuesType
object
1 property
Pipeline.FieldTypeOnFieldCreation
Errors.NotFoundError
object
2 properties 2 required
Pipeline.LongStringFieldValuesType
object
1 property
Fields.DecimalNumberPresentation
object
2 properties 2 required
Pipeline.CreateDealsPipelineGroupRequest
object
4 properties
Pipeline.DealStage
object
Stage in the deals pipeline
11 properties
Deals.DealView
object
19 properties
Deals.DealPipelineFieldsTab
object
4 properties
Pipeline.CreateDealsPipelineRequest
object
7 properties 7 required
Pipeline.DateTimeFieldValuesType
object
1 property
Pipeline.CreateDealStageRequest
object
Stage in the pipeline where deals will be placed
6 properties
Deals.DealFile
object
6 properties
Deals.RelatedContact
object
Contacts related to deal
3 properties
Deals.NamedFieldsValues
object
Fields of the deals which was filled up by the owner/creator
2 properties
Pipeline.LeadLostReason
object
2 properties
Deals.Principals
object
2 properties 2 required
Deals.BaseDealPipelineFieldsTabMember
object
1 property
Contacts.ContactType
string
Pipeline.ChoiceFieldValuesType
object
2 properties
Commons.PossibleValues
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nimble-deals-pipelines-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 Fields API
Nimble Leads API
Nimble Messages API
Nimble Tasks API
Nimble Users API
Where this information came from

This is an independent, third-party profile of Nimble Deals Pipelines 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.