Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Neon One Custom Fields API

Standard custom fields and the Custom Objects framework.

Neon One Custom Fields API is one of 12 APIs that Neon One publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Custom Fields. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 18 operations across 9 paths, and defines 3 schemas. It is described by OpenAPI 3.0.3, at version 2.11.

Requests are made against 2 base URLs: https://api.neoncrm.com/v2, https://trial.z2systems.com/v2.

18 operations 9 paths 3 schemas 2 DELETE9 GET1 PATCH4 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
2.11
Base URL
https://api.neoncrm.com/v2
Authentication
HTTP Basic
Resource Areas
1

Authentication & Security 1

Neon One Custom Fields API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (basicAuth). By default, every request must be authenticated.

  • basicAuth — HTTP Basic Authentication. Username is the Neon CRM organization's Org ID; password is an API key generated for a system user under Settings User Management.

Paths & Operations 18

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

Custom Fields 18

Standard custom fields and the Custom Objects framework.

GET
/customFields
List standard custom fields
listCustomFields 2 params → 200401
POST
/customFields
Create a standard custom field
createCustomField body → 200401
GET
/customFields/{id}
Retrieve a standard custom field
getCustomField 1 param → 200404
PUT
/customFields/{id}
Update a standard custom field
updateCustomField 1 param body → 200404
GET
/customObjects
List custom objects
listCustomObjects → 200401
POST
/customObjects
Create a custom object
createCustomObject body → 200401
GET
/customObjects/{idOrApiAlias}
Retrieve a custom object
getCustomObject 1 param → 200404
PUT
/customObjects/{idOrApiAlias}
Update a custom object
updateCustomObject 1 param body → 200404
PATCH
/customObjects/{idOrApiAlias}
Partially update a custom object
patchCustomObject 1 param body → 200404
DELETE
/customObjects/{idOrApiAlias}
Delete a custom object
deleteCustomObject 1 param → 200404
GET
/customObjects/{idOrApiAlias}/fields
List fields on a custom object
listCustomObjectFields 1 param → 200401
POST
/customObjects/{idOrApiAlias}/fields
Create a field on a custom object
createCustomObjectField 1 param body → 200401
GET
/customObjects/{idOrApiAlias}/records
List records of a custom object
listCustomObjectRecords 1 param → 200401
POST
/customObjects/{idOrApiAlias}/records
Create a record of a custom object
createCustomObjectRecord 1 param body → 200401
GET
/customObjects/{idOrApiAlias}/records/{id}
Retrieve a record of a custom object
getCustomObjectRecord 2 params → 200404
DELETE
/customObjects/{idOrApiAlias}/records/{id}
Delete a record of a custom object
deleteCustomObjectRecord 2 params → 200404
GET
/customObjects/masterDetailObjects
List master/detail custom objects
listMasterDetailObjects → 200
GET
/customObjects/lookUpObjects
List lookup custom objects
listLookUpObjects → 200

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are CustomField (6 properties), CustomObject (4 properties), Error (1 property). Each schema is shown below with its type and property counts.

CustomObject
object
4 properties
Error
object
1 property
CustomField
object
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

neonone-custom-fields-api-openapi.yml Raw ↑

Other APIs Neon One publishes across the network.

Neon One Accounts API
Neon One Campaigns API
Neon One Donations API
Neon One Events API
Neon One Households API
Neon One Memberships API
Neon One Orders API
Neon One Properties API
Neon One Store API
Neon One Volunteers API
Neon One Webhooks API