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 Contacts API

Contact records — the Nimble platform root object. Create, read, update and delete person and company contacts, search them with keyword or the advanced JSON query syntax, manage notes and tags. Contact fields are returned as arrays of labelled {value, label, modifier} objects rather than flat scalars. 19 operation(s).

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

Tagged areas include Contacts, CRM, Search, and Notes. The published artifact set on APIs.io includes an OpenAPI specification.

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

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

19 operations 11 paths 68 schemas 3 DELETE9 GET4 POST3 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 Contacts 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 19

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

Contacts 19

Contacts details Typical response to this request is a dictionary with 2 keys (unless otherwise specified by the specific API): meta and resources.

DELETE
/api/v1/contacts
Delete list of contacts
delete-contacts-list-2 4 params → 200404406409
GET
/api/v1/contacts
Contact List
list-contacts 11 params → 200409
GET
/api/v1/contacts/ids
Contact ids list
list-contacts-ids 9 params → 200409
GET
/api/v1/contact
Returns standard contact listings
list-contacts-for-identifiers 6 params → 200
POST
/api/v1/contact
Create new contact
post-contact body → 200402409
DELETE
/api/v1/contact/{contact_id}
Delete contact by id
delete-contact 3 params → 200403404409
GET
/api/v1/contact/{contact_id}
Returns contact data by its id
get-contact 7 params → 200
PUT
/api/v1/contact/{contact_id}
Updates contact by its id
put-contact 3 params body → 200403404406409
GET
/api/v1/contacts/metadatadeprecated
(D) List contacts fields metadata
list-contacts-fields-metadata → 200
POST
/api/v1/contacts/notes
Create contacts note
post-contact-note body → 201409
DELETE
/api/v1/contacts/notes/{note_id}
Delte contact note by id
delete-contact-note 1 param → 200404409
GET
/api/v1/contacts/notes/{note_id}
Returns note by id
get-contact-note 1 param → 200404409
POST
/api/v1/contacts/notes/{note_id}
Create contact note with id
post-contact-note-with-id 1 param body → 201404409
PUT
/api/v1/contacts/notes/{note_id}
Update contact note by id
put-contact-note 1 param body → 200404409
GET
/api/v1/contacts/{contact_id}/notes
List contact notes
list-contacts-contact-notes 3 params → 200409
POST
/api/v1/contacts/{contact_id}/notes
Create a contact note
post-contact-note-for-contact 1 param body → 201404409
PUT
/api/v1/contacts/{contact_id}/tags
Assign tags to contact
put-contact-tags 1 param body → 200403404409
GET
/api/v1/contacts/proceedings_providers
List contacts proceeding providers
list-contacts-proceeding-providers → 200
GET
/api/v1/contacts/{contact_id}/proceedings
List contact proceedings
list-contact-proceedings 8 params → 200404409

Schemas 68

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

Contacts.ContactUpdateRequest
object
3 properties
Commons.PaginationMeta
object
4 properties 4 required
Contacts.EmailListsContext
object
2 properties
Messages.EmailListConfirmationMessageRequest
object
3 properties 3 required
Contacts.ContactsListing
object
2 properties 2 required
Contacts.ContactView
object
user perspective on a specific contact
23 properties 18 required
Contacts.UploadedContactFile
object
8 properties
Errors.PaymentError
object
3 properties 3 required
Contacts.ContactViewContextKinds
Contacts.ContactViewContext
Sequences.SequenceProgressionOutcomes
Sequences.InSequenceContactExitDetails
object
3 properties
Contacts.ContactsIdsListing
object
2 properties 2 required
Proceedings.Proceeding
object
6 properties 6 required
Contacts.UserLastContactedView
object
3 properties
Contacts.LeadInStageInfo
object
info about stage where lead is
6 properties
Attachments.OneDriveAttachmentData
Contacts.ContactFieldsGroup
object
6 properties 6 required
Errors.NotAcceptableError
object
2 properties 2 required
Messages.EmailList
object
9 properties
Proceedings.ProceedingProvider
object
3 properties 3 required
Proceedings.ProceedingTypeDef
object
2 properties
Messages.MessageTemplateContentSpecification
object
8 properties 2 required
Contacts.LastContactedDataContext
object
2 properties
Contacts.ShortContact
object
8 properties 7 required
Errors.PreflightCheckError
object
4 properties 4 required
Contacts.OwnerId
stringnull
Describes id of user who is owning this contact. Keep in mind that the creator and owner may be different. If null - owner will be unassigned. If not specified…
Contacts.InSequenceContactInfoContext
object
2 properties
Contacts.FieldPresentationType
string
Contacts.LeadsDataContext
object
2 properties
Contacts.ContactFile
object
2 properties
Contacts.CreateContactRequest
object
8 properties 1 required
Contacts.ContactsRemovedResponse
object
2 properties 2 required
Commons.PushData
object
an object containing the push data from the server to the client
6 properties 6 required
Contacts.EmployerInfo
object
employer's info
3 properties
Contacts.FieldPresentationWidth
string
Errors.ForbiddenError
object
1 property 1 required
Sequences.InSequenceContactInfo
object
14 properties
Messages.MessagingAccount
object
7 properties
Messages.MessageTemplateContentMode
string
Messages.Attachment
object
5 properties 5 required
Sequences.CompletedSequenceStepRecord
object
4 properties
Errors.ValidationError
object
request was malformed
5 properties 3 required
Contacts.EmployersDataContext
object
2 properties
Messages.MessagingAccountIdentifier
object
2 properties 2 required
Settings.MessagingAccountIdentifier
object
2 properties 2 required
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.ContactNote
object
9 properties 9 required
Contacts.LastContactedDirectedContainer
object
3 properties
Accounts.ShortUserInfo
object
5 properties 5 required
Contacts.ContactField
object
8 properties 8 required
Contacts.Reminder
object
5 properties 5 required
Errors.PreflightCheckFailures
object
action cannot be applied to all specified contacts
1 property 1 required
Contacts.SingleContactNoteSpec
object
2 properties 1 required
Contacts.SelectBoxFieldPresentation
object
4 properties 4 required
Contacts.LastContacted
object
6 properties 5 required
Contacts.FieldGroupType
string
Errors.NotFoundError
object
2 properties 2 required
Contacts.ContactNoteSpec
object
3 properties 3 required
Attachments.GoogleDriveAttachmentData
Attachments.DropboxAttachmentData
Contacts.ContactNotice
object
6 properties 6 required
Contacts.FieldsMetadata
object
2 properties 2 required
Contacts.ContactFilesContext
object
2 properties
Attachments.AttachmentData
object
9 properties 9 required
Contacts.SimpleFieldPresentation
object
2 properties 2 required
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

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nimble-contacts-api-openapi.yml Raw ↑

Other APIs Nimble publishes across the network.

Nimble Activities 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 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 Contacts 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.