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 API

Deals on the /api/v2 surface — create, update and delete deals, attach notes and files, manage deal tags, list overdue activity and read the won-last-month rollup. 18 operation(s).

Nimble Deals 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, Sales, and Pipeline Management. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 18 operations across 11 paths, and defines 43 schemas. It is described by OpenAPI 3.2.0, at version v1.

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

18 operations 11 paths 43 schemas 4 DELETE6 GET4 POST4 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 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 18

Across 11 paths, the API surfaces 18 operations — 4 DELETE, 6 GET, 4 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

Deals 18

Deals management

GET
/api/v2/deals
List all user's deals
list-user-deals 2 params → 200
POST
/api/v2/deals
Create new deal
create-new-deal body → 200409
GET
/api/v2/deals/tags
List deals tags
list-deals-tags 2 params → 200
POST
/api/v2/deals/tags
Add tags to deals
post-deals-tags body → 200406409
PUT
/api/2/deals/tags/{tag_name}
Update deals' tag by name
put-deals-tag 1 param body → 200406409
DELETE
/api/2/deals/tags/{tag_name}
Delete deals tag by name
delete-deals-tag 1 param body → 200406
GET
/api/v2/deals/widget/won_last_month
Get sum of all deals amount won last month
get-won-last-month-deals-sum → 200
GET
/api/v2/deals/{deal_id}
Get deal by id
get-deal 1 param → 200404
DELETE
/api/v2/deals/{deal_id}
Delete deal by id
delete-deal 1 param → 200403404
PUT
/api/v2/deals/{deal_id}
Update deal by id
put-deal 1 param body → 200409
POST
/api/v2/deals/{deal_id}/files
Store deal file
store-deal-file 1 param body → 201
PUT
/api/v2/deals/{deal_id}/files/{file_id}
Update deal file
put-deal-file 2 params body → 200
DELETE
/api/v2/deals/{deal_id}/files/{file_id}
Delete deal file
delete-deal-file 2 params → 200
GET
/api/v2/deals/{deal_id}/files/{file_id}/url
Get deal file download url
get-deal-file-download-url 2 params → 200404
POST
/api/v2/deals/{deal_id}/notes
Create note to the deal
create-deal-note 1 param body → 201409
PUT
/api/v2/deals/{deal_id}/notes/{note_id}
Update deal note by id
put-deal-note 2 params body → 200404409
DELETE
/api/v2/deals/{deal_id}/notes/{note_id}
Delete deal note by id
delete-deal-note 2 params → 200
GET
/api/v2/deals/{deal_id}/overdue
List deals' overdue activities
list-deals-overdue-activities 3 params → 200409

Schemas 43

The contract defines 43 schemas that model the data the API accepts and returns. The most detailed are Accounts.User (21 properties), Deals.DealView (19 properties), Activities.Activity (18 properties), Legacy.UserMetadata (11 properties). Each schema is shown below with its type and property counts.

Deals.DealNote
object
6 properties
Deals.RelatedExternalContact
object
external contact related to this deal
2 properties
Deals.EmploymentInfo
object
Information about date employment
4 properties
Contacts.AssigmentProgress
object
6 properties 6 required
Commons.Comment
object
5 properties 5 required
Activities.Activity
object
18 properties 17 required
Commons.Tag
object
2 properties 1 required
Deals.Principals
object
2 properties 2 required
Deals.StoreFileRequest
Deals.StoreAzureFileRequest
object
1 property
Contacts.ContactsAlreadyLeadsError
object
3 properties
Contacts.ContactType
string
Errors.NotAcceptableError
object
2 properties 2 required
Deals.RelatedContact
object
Contacts related to deal
3 properties
Accounts.User
object
21 properties 20 required
Contacts.ShortContact
object
8 properties 7 required
Errors.PreflightCheckError
object
4 properties 4 required
Deals.FieldsValues
object
Fields of the deals which was filled up by the owner/creator
2 properties
Deals.ExternalFileMetadata
object
metadata for files from external sources (dropbox, google drive, one drive)
3 properties
Deals.StoreExternalFileRequest
object
3 properties
Errors.ForbiddenError
object
1 property 1 required
Deals.AzureFileMetadata
object
metadata for files uploaded from device using Azure JS SDK
2 properties
Deals.DealPrivacy
object
2 properties 2 required
Legacy.UserMetadata
object
11 properties 11 required
Settings.UserPermissions
object
users permission
Sequences.SequenceBriefInfo
object
2 properties 2 required
Errors.ValidationError
object
request was malformed
5 properties 3 required
Deals.DealStageTransition
object
5 properties 4 required
Deals.NamedFieldsValues
object
Fields of the deals which was filled up by the owner/creator
2 properties
Activities.ActivityTypeDef
object
6 properties 6 required
Accounts.ShortUserInfo
object
5 properties 5 required
Errors.PreflightCheckFailures
object
action cannot be applied to all specified contacts
1 property 1 required
Contacts.NotEditableContactsError
object
3 properties
Deals.DealFile
object
6 properties
Deals.DealPipelineTransitions
object
5 properties 4 required
Deals.EditDealRequest
object
9 properties
Errors.NotFoundError
object
2 properties 2 required
Deals.CreateDealRequest
object
9 properties 4 required
Deals.UpdateDealFileRequest
object
1 property
Deals.ShortSavedDeal
object
5 properties
Deals.DealsList
object
List of user deals
2 properties
Deals.DealView
object
19 properties
Pipeline.DealStage
object
Stage in the deals pipeline
11 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nimble-deals-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 Fields API
Nimble Deals Pipelines 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 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.