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

Volunteers, groups, opportunities, roles, shifts, and time sheets.

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

This API exposes 14 operations across 7 paths, and defines 4 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.

14 operations 7 paths 4 schemas 2 DELETE6 GET1 PATCH4 POST1 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 Volunteers 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 14

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

Volunteers 14

Volunteers, groups, opportunities, roles, shifts, and time sheets.

GET
/volunteers
List volunteers
listVolunteers → 200401
GET
/opportunities
List volunteer opportunities
listVolunteerOpportunities → 200401
POST
/opportunities
Create a volunteer opportunity
createVolunteerOpportunity body → 200401
GET
/opportunities/{id}
Retrieve a volunteer opportunity
getVolunteerOpportunity 1 param → 200404
PUT
/opportunities/{id}
Update a volunteer opportunity
updateVolunteerOpportunity 1 param body → 200404
PATCH
/opportunities/{id}
Partially update a volunteer opportunity
patchVolunteerOpportunity 1 param body → 200404
DELETE
/opportunities/{id}
Delete a volunteer opportunity
deleteVolunteerOpportunity 1 param → 200404
POST
/opportunities/{id}/addVolunteers
Add volunteers to an opportunity
addVolunteersToOpportunity 1 param body → 200401
GET
/opportunities/{opportunityId}/shifts
List shifts for a volunteer opportunity
listOpportunityShifts 1 param → 200401
POST
/opportunities/{opportunityId}/shifts
Create a shift for a volunteer opportunity
createOpportunityShift 1 param body → 200401
GET
/timesheets
List volunteer time sheets
listTimeSheets → 200401
POST
/timesheets
Create a volunteer time sheet entry
createTimeSheet body → 200401
GET
/timesheets/{id}
Retrieve a volunteer time sheet entry
getTimeSheet 1 param → 200404
DELETE
/timesheets/{id}
Delete a volunteer time sheet entry
deleteTimeSheet 1 param → 200404

Schemas 4

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

VolunteerOpportunity
object
3 properties
VolunteerShift
object
4 properties
Error
object
1 property
Volunteer
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

neonone-volunteers-api-openapi.yml Raw ↑

Other APIs Neon One publishes across the network.

Neon One Accounts API
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 Webhooks API