Improved: API Reference Responses & Examples
We’ve updated the Volunteer API documentation with improvements from our recent docs audit, making it clearer what to expect from every endpoint — especially when a request fails.This release includes updates such as:
- Documented
401 unauthorized responses on every endpoint
- Documented
429 rate limit responses, including the per-minute limit and the Retry-After and X-RateLimit-* headers
- Documented
500 server error responses on every endpoint
- Added
404, 422, 403, and 400 responses where they apply
- Standardized error shapes into shared, reusable schemas
- Rewrote
200 success examples with realistic, current sample data
- Typed previously untyped
200 responses so response structure now renders correctly
- Fixed malformed list examples so paginated
data, links, and meta display correctly
- Added a reminder to send
Accept: application/json to ensure errors return as JSON
New: Volunteer API Documentation Changelog
We’ve launched the Volunteer API Documentation Changelog to make it easier to follow updates to the Volunteer API and developer documentation.This changelog will include updates such as:
- New and updated Volunteer API endpoints
- Volunteer, opportunity, shift, registration, and participation data updates
- Request and response schema changes
- New fields, objects, filters, and parameters
- Deprecation notices and breaking changes
- Improvements to examples, guides, recipes, and API reference documentation
Last modified on June 1, 2026
