Neon One

Neon One Custom Fields API

Standard custom fields and the Custom Objects framework.

GitHub OpenAPI

Operations 18

GET /customFields List standard custom fields #
POST /customFields Create a standard custom field #
GET /customFields/{id} Retrieve a standard custom field #
PUT /customFields/{id} Update a standard custom field #
GET /customObjects List custom objects #
POST /customObjects Create a custom object #
GET /customObjects/{idOrApiAlias} Retrieve a custom object #
PUT /customObjects/{idOrApiAlias} Update a custom object #
PATCH /customObjects/{idOrApiAlias} Partially update a custom object #
DELETE /customObjects/{idOrApiAlias} Delete a custom object #
GET /customObjects/{idOrApiAlias}/fields List fields on a custom object #
POST /customObjects/{idOrApiAlias}/fields Create a field on a custom object #
GET /customObjects/{idOrApiAlias}/records List records of a custom object #
POST /customObjects/{idOrApiAlias}/records Create a record of a custom object #
GET /customObjects/{idOrApiAlias}/records/{id} Retrieve a record of a custom object #
DELETE /customObjects/{idOrApiAlias}/records/{id} Delete a record of a custom object #
GET /customObjects/masterDetailObjects List master/detail custom objects #
GET /customObjects/lookUpObjects List lookup custom objects #

Documentation

📖
Documentation
https://developer.neoncrm.com/accounts/
📖
APIReference
https://developer.neoncrm.com/api-v2/
📖
Documentation
https://developer.neoncrm.com/2025/06/09/api-v2-10-update-households/
📖
Documentation
https://developer.neoncrm.com/transactions/
📖
Documentation
https://developer.neoncrm.com/api-v2-resources/permissions/
📖
Documentation
https://developer.neoncrm.com/2025/10/24/api-v2-11-release-notes/
📖
Documentation
https://developer.neoncrm.com/api-v2-resources/rate-limits/
📖
Documentation
https://developer.neoncrm.com/custom-objects/
📖
Documentation
https://developer.neoncrm.com/2025/04/14/api-v2-10-update-custom-objects/
📖
Documentation
https://developer.neoncrm.com/2020/09/19/api-v2-1-release-notes/
📖
Documentation
https://developer.neoncrm.com/2024/11/22/api-v2-9-updates-november-2024/
📖
Documentation
https://developer.neoncrm.com/webhooks/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/neonone/refs/heads/main/openapi/neonone-custom-fields-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/neonone-custom-fields-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

neonone-custom-fields-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Neon CRM API v2 Custom Fields API
  description: Neon CRM API v2 is a RESTful, JSON-based rebuild of Neon One's legacy API v1, first launched in 2019.
  version: '2.11'
  contact:
    name: Neon One Developer Center
    url: https://developer.neoncrm.com/
  license:
    name: Proprietary
    url: https://neonone.com/
servers:
- url: https://api.neoncrm.com/v2
  description: Production and Sandbox
- url: https://trial.z2systems.com/v2
  description: Trial instances
security:
- basicAuth: []
tags:
- name: Custom Fields
  description: Standard custom fields and the Custom Objects framework.
paths:
  /customFields:
    get:
      operationId: listCustomFields
      tags:
      - Custom Fields
      summary: List standard custom fields
      description: Schema updated in API v2.10 with displayName and validated data types.
      parameters:
      - name: isEventSpecificField
        in: query
        required: false
        schema:
          type: boolean
      - name: attendeeQuestion
        in: query
        required: false
        schema:
          type: boolean
      responses:
        '200':
          description: A list of custom fields.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CustomField'
        '401':
          $ref: '#/components/responses/Unauthorized'
    post:
      operationId: createCustomField
      tags:
      - Custom Fields
      summary: Create a standard custom field
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomField'
      responses:
        '200':
          description: The created custom field.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomField'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /customFields/{id}:
    parameters:
    - name: id
      in: path
      required: true
      description: The ID of the custom field.
      schema:
        type: string
    get:
      operationId: getCustomField
      tags:
      - Custom Fields
      summary: Retrieve a standard custom field
      responses:
        '200':
          description: The requested custom field.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomField'
        '404':
          $ref: '#/components/responses/NotFound'
    put:
      operationId: updateCustomField
      tags:
      - Custom Fields
      summary: Update a standard custom field
      description: Omitting an existing option from the request removes it (fixed in API v2.10).
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomField'
      responses:
        '200':
          description: The updated custom field.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomField'
        '404':
          $ref: '#/components/responses/NotFound'
  /customObjects:
    get:
      operationId: listCustomObjects
      tags:
      - Custom Fields
      summary: List custom objects
      description: Custom Objects framework shipped to API v2.10 on April 12, 2025.
      responses:
        '200':
          description: A list of custom objects.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CustomObject'
        '401':
          $ref: '#/components/responses/Unauthorized'
    post:
      operationId: createCustomObject
      tags:
      - Custom Fields
      summary: Create a custom object
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomObject'
      responses:
        '200':
          description: The created custom object.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomObject'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /customObjects/{idOrApiAlias}:
    parameters:
    - $ref: '#/components/parameters/CustomObjectIdOrApiAlias'
    get:
      operationId: getCustomObject
      tags:
      - Custom Fields
      summary: Retrieve a custom object
      responses:
        '200':
          description: The requested custom object.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomObject'
        '404':
          $ref: '#/components/responses/NotFound'
    put:
      operationId: updateCustomObject
      tags:
      - Custom Fields
      summary: Update a custom object
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomObject'
      responses:
        '200':
          description: The updated custom object.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomObject'
        '404':
          $ref: '#/components/responses/NotFound'
    patch:
      operationId: patchCustomObject
      tags:
      - Custom Fields
      summary: Partially update a custom object
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: true
      responses:
        '200':
          description: The updated custom object.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomObject'
        '404':
          $ref: '#/components/responses/NotFound'
    delete:
      operationId: deleteCustomObject
      tags:
      - Custom Fields
      summary: Delete a custom object
      responses:
        '200':
          description: Deletion confirmation.
        '404':
          $ref: '#/components/responses/NotFound'
  /customObjects/{idOrApiAlias}/fields:
    parameters:
    - $ref: '#/components/parameters/CustomObjectIdOrApiAlias'
    get:
      operationId: listCustomObjectFields
      tags:
      - Custom Fields
      summary: List fields on a custom object
      responses:
        '200':
          description: A list of custom object fields.
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  additionalProperties: true
        '401':
          $ref: '#/components/responses/Unauthorized'
    post:
      operationId: createCustomObjectField
      tags:
      - Custom Fields
      summary: Create a field on a custom object
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: true
      responses:
        '200':
          description: The created field.
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
        '401':
          $ref: '#/components/responses/Unauthorized'
  /customObjects/{idOrApiAlias}/records:
    parameters:
    - $ref: '#/components/parameters/CustomObjectIdOrApiAlias'
    get:
      operationId: listCustomObjectRecords
      tags:
      - Custom Fields
      summary: List records of a custom object
      responses:
        '200':
          description: A list of custom object records.
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  additionalProperties: true
        '401':
          $ref: '#/components/responses/Unauthorized'
    post:
      operationId: createCustomObjectRecord
      tags:
      - Custom Fields
      summary: Create a record of a custom object
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: true
      responses:
        '200':
          description: The created record.
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
        '401':
          $ref: '#/components/responses/Unauthorized'
  /customObjects/{idOrApiAlias}/records/{id}:
    parameters:
    - $ref: '#/components/parameters/CustomObjectIdOrApiAlias'
    - name: id
      in: path
      required: true
      description: The ID of the record.
      schema:
        type: string
    get:
      operationId: getCustomObjectRecord
      tags:
      - Custom Fields
      summary: Retrieve a record of a custom object
      responses:
        '200':
          description: The requested record.
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
        '404':
          $ref: '#/components/responses/NotFound'
    delete:
      operationId: deleteCustomObjectRecord
      tags:
      - Custom Fields
      summary: Delete a record of a custom object
      responses:
        '200':
          description: Deletion confirmation.
        '404':
          $ref: '#/components/responses/NotFound'
  /customObjects/masterDetailObjects:
    get:
      operationId: listMasterDetailObjects
      tags:
      - Custom Fields
      summary: List master/detail custom objects
      responses:
        '200':
          description: A list of master/detail custom objects.
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  additionalProperties: true
  /customObjects/lookUpObjects:
    get:
      operationId: listLookUpObjects
      tags:
      - Custom Fields
      summary: List lookup custom objects
      responses:
        '200':
          description: A list of lookup custom objects.
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  additionalProperties: true
components:
  schemas:
    Error:
      type: object
      properties:
        errors:
          type: array
          items:
            type: object
            properties:
              code:
                type: string
              message:
                type: string
    CustomField:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        displayName:
          type: string
        dataType:
          type: string
          enum:
          - Whole Number
          - Decimal
          - Currency
          - Date
          - Text
          - Email
        component:
          type: string
        options:
          type: array
          items:
            type: object
            additionalProperties: true
      additionalProperties: true
    CustomObject:
      type: object
      properties:
        id:
          type: string
        apiAlias:
          type: string
        name:
          type: string
        objectType:
          type: string
          enum:
          - masterDetail
          - lookUp
      additionalProperties: true
  responses:
    NotFound:
      description: The requested resource was not found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: Missing or invalid Org ID / API key in the Basic Authorization header.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  parameters:
    CustomObjectIdOrApiAlias:
      name: idOrApiAlias
      in: path
      required: true
      description: The ID or API alias of the custom object.
      schema:
        type: string
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: 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.