API Reference

The Holy API is a RESTful JSON API for third-party developers and integration partners.

Base URL

https://api.holyplatform.com/v1

Authentication

All API requests require a valid Bearer token. See Authentication for details.

Request Format

Content-Type: application/json
All request bodies must be valid JSON
Dates use ISO 8601 format (2026-03-15T10:30:00Z)

Response Format

All responses follow a consistent structure:

Success Response

{
  "data": {
    "id": "abc123",
    "first_name": "John",
    "last_name": "Smith",
    "email": "john@example.com"
  }
}

List Response (Paginated)

{
  "data": [
    { "id": "abc123", "first_name": "John", "last_name": "Smith" },
    { "id": "def456", "first_name": "Jane", "last_name": "Smith" }
  ],
  "meta": {
    "page": 1,
    "per_page": 25,
    "total": 142,
    "total_pages": 6
  }
}

Error Response

{
  "error": {
    "code": "not_found",
    "message": "Person not found",
    "status": 404
  }
}

HTTP Status Codes

Code	Description
`200`	Success
`201`	Created
`204`	No Content (successful delete)
`400`	Bad Request (invalid input)
`401`	Unauthorized (missing or invalid token)
`403`	Forbidden (insufficient permissions)
`404`	Not Found
`422`	Unprocessable Entity (validation error)
`429`	Too Many Requests (rate limited)
`500`	Internal Server Error

Rate Limiting

API requests are rate limited per API key. Rate limit headers are included in every response:

X-RateLimit-Limit: 100
X-RateLimit-Remaining: 95
X-RateLimit-Reset: 1710500400

Available Resources

The API provides full CRUD operations for the following resources:

Resource	Description
People	Manage your church directory
Groups	Create and manage groups and memberships
Donations	Record and retrieve giving data
Funds	Manage giving fund designations
Events	Create and manage events
Attendance	Record and retrieve attendance data

Detailed endpoint documentation for each resource is available within the API section.

On this page