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

Individual and organization constituent records, contacts, and addresses.

Neon One Accounts 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 Accounts. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 22 operations across 13 paths, and defines 11 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.

22 operations 13 paths 11 schemas 2 DELETE9 GET2 PATCH6 POST3 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 Accounts 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 22

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

Accounts 22

Individual and organization constituent records, contacts, and addresses.

GET
/accounts
List accounts
listAccounts 2 params → 200401
POST
/accounts
Create an account
createAccount body → 200401403
GET
/accounts/{id}
Retrieve an account
getAccount 1 param → 200222401404
PUT
/accounts/{id}
Update an account
updateAccount 1 param body → 200401404
POST
/accounts/search
Search accounts
searchAccounts body → 200401429
GET
/accounts/search/searchFields
List account search fields
listAccountSearchFields → 200
GET
/accounts/search/outputFields
List account output fields
listAccountOutputFields → 200
POST
/accounts/link
Link two accounts
linkAccounts body → 200401
POST
/accounts/unlink
Unlink two previously merged accounts
unlinkAccounts body → 200401
GET
/accounts/{id}/contacts
List contacts on an organization account
listAccountContacts 1 param → 200401
POST
/accounts/{id}/contacts
Add a contact to an organization account
addAccountContact 1 param body → 200401
GET
/accounts/{id}/contacts/{contactId}
Retrieve a contact
getAccountContact 2 params → 200404
PUT
/accounts/{id}/contacts/{contactId}
Update a contact
updateAccountContact 2 params body → 200404
PATCH
/accounts/{id}/contacts/{contactId}
Partially update a contact
patchAccountContact 2 params body → 200404
DELETE
/accounts/{id}/contacts/{contactId}
Remove a contact from an organization account
deleteAccountContact 2 params → 200404
GET
/accounts/{id}/donations
List an account's donations
listAccountDonations 1 param → 200401
GET
/accounts/{id}/pledges
List an account's pledges
listAccountPledges 1 param → 200401
POST
/addresses
Add an address to an account
createAddress body → 200401
GET
/addresses/{addressId}
Retrieve an address
getAddress 1 param → 200404
PUT
/addresses/{addressId}
Update an address
updateAddress 1 param body → 200404
PATCH
/addresses/{addressId}
Partially update an address
patchAddress 1 param body → 200404
DELETE
/addresses/{addressId}
Remove an address
deleteAddress 1 param → 200404

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are Address (9 properties), DonationInput (7 properties), PledgeInput (4 properties), Contact (4 properties). Each schema is shown below with its type and property counts.

Donation
PledgeInput
object
4 properties 2 required
AccountListResponse
object
2 properties
SearchRequest
object
3 properties 2 required
Address
object
9 properties
Contact
object
4 properties
Error
object
1 property
Pledge
DonationInput
object
7 properties 2 required
Account
AccountInput
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

neonone-accounts-api-openapi.yml Raw ↑

Other APIs Neon One publishes across the network.

Neon One Campaigns API
Neon One Custom Fields 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