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

User-definable contact field schema — fields, choice option lists, field groups and tabs, plus primary-value marks on multi-valued fields. The field set differs per account and must be read before writing contact data. 15 operation(s).

Nimble Contacts Fields 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, Custom Fields, and Schema. The published artifact set on APIs.io includes an OpenAPI specification.

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

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

15 operations 9 paths 31 schemas 5 DELETE1 GET4 POST5 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 Fields 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 15

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

Contacts Fields 15

Legacy contacts metadata Contact\'s metadata contains information about all basic and custom fields created in Nimble for a user. Below is it\'s typical structure. Please note tha…

GET
/api/v1/contacts/fields
List all available metadata for company fields
list-company-contacts-fields → 200
POST
/api/v1/contacts/fields
Create new field
post-contact-field body → 200409
DELETE
/api/v1/contacts/fields/{field_id}
Delete contact field by id
delete-contact-field 2 params → 200404406409
PUT
/api/v1/contacts/fields/{field_id}
Update existing field by id
put-contact-field 1 param body → 200404409
POST
/api/v1/contacts/fields/groups
Create new contacts fields group
create-contacts-fields-group body → 200409
DELETE
/api/v1/contacts/fields/groups/{group_id}
Delete contacts fields group by id
delete-contacts-fields-group 2 params → 200404406409
PUT
/api/v1/contacts/fields/groups/{group_id}
Update contacts fields group by id
put-contacts-fields-group 1 param body → 200404409
POST
/api/v1/contacts/fields/tabs
Create new contacts fields tab
post-contacts-fields-tab body → 200409
DELETE
/api/v1/contacts/fields/tabs/{tab_id}
Delete contacts tab by id
delete-contacts-tab-by-id 2 params → 200404406409
PUT
/api/v1/contacts/fields/tabs/{tab_id}
Update contacts fields tab by id
put-contacts-tab-by-id 1 param body → 200404409
POST
/api/v1/contacts/fields/{field_id}/choices
Create choice for field
post-contact-choice-field 1 param body → 200404409
DELETE
/api/v1/contacts/fields/{field_id}/choices/{id}
Delete contact choice by id
delete-contact-choice-field 4 params → 200404406409
PUT
/api/v1/contacts/fields/{field_id}/choices/{id}
Update field choice
put-contacts-field-choice 3 params body → 200404409
DELETE
/api/v1/contact/{contact_id}/field
Delete isprimary mark from field
delete-primary-mark-from-contact-field 1 param body → 200404409
PUT
/api/v1/contact/{contact_id}/field
Mark field with isprimary flag
put-primary-mark-to-contact-field 1 param body → 200404409

Schemas 31

The contract defines 31 schemas that model the data the API accepts and returns. The most detailed are Fields.ContactField (9 properties), Fields.CreateFieldRequest (7 properties), Fields.ContactFieldsTab (6 properties), Errors.ValidationError (5 properties). Each schema is shown below with its type and property counts.

Fields.BooleanFieldValuesType
object
1 property
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…
Fields.TextValidationRule
object
1 property
Fields.DateTimePresentation
object
2 properties 2 required
Fields.NumberFieldValuesType
object
1 property
Fields.FinancialNumberPresentation
object
2 properties 2 required
Fields.ContactFieldsTab
object
6 properties
Fields.PercentageNumberPresentation
object
2 properties 2 required
Errors.ValidationError
object
request was malformed
5 properties 3 required
Fields.CreateFieldRequest
object
7 properties 6 required
Fields.FieldTypeOnFieldCreation
Fields.ContactFieldsGroup
object
5 properties
Fields.UpdateIsPrimaryRequest
object
2 properties 3 required
Fields.IntegerNumberPresentation
object
1 property 1 required
Fields.AddressFieldValuesType
object
1 property
Commons.PossibleValues
object
2 properties
Fields.FieldType
Fields.UserFieldValuesType
object
1 property
Errors.PreflightCheckError
object
4 properties 4 required
Fields.ContactField
object
9 properties
Fields.StringFieldValuesType
object
2 properties
Errors.NotFoundError
object
2 properties 2 required
Fields.DecimalNumberPresentation
object
2 properties 2 required
Errors.PreflightCheckFailures
object
action cannot be applied to all specified contacts
1 property 1 required
Fields.ChoiceFieldValuesType
object
2 properties
Fields.ContactsFieldsMetadata
object
Contain the structure of contacts tabs, groups, and fields.
1 property 1 required
Fields.EmploymentFieldValuesType
object
1 property
Fields.DateTimeFieldValuesType
object
1 property
Fields.AttachmentFieldValuesType
object
1 property
Contacts.ContactType
string
Fields.LongStringFieldValuesType
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nimble-contacts-fields-api-openapi.yml Raw ↑

Other APIs Nimble publishes across the network.

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