Reference

API Documentation

Available on AI Pro Plan

Quick Summary: The Relius REST API lets you build custom integrations, sync data with other systems, and automate workflows. Available on the AI Pro plan.

Overview

The Relius API follows RESTful conventions and returns JSON responses. Use it to:

  • Sync member data with other systems (CRM, email marketing, etc.)
  • Build custom check-in kiosks or apps
  • Create automated workflows and reports
  • Integrate with church-specific tools

All API requests require authentication and are rate-limited to ensure fair usage across all customers.

Base URL

https://api.relius.ai/v1

All API endpoints are relative to this base URL. The current version is v1.

Authentication

All API requests must include an API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

Getting Your API Key

  1. Go to Administration → Security → API Keys
  2. Click Generate New Key
  3. Give your key a descriptive name (e.g., "Website Integration")
  4. Copy the key immediately—you won't be able to see it again

Important: Keep your API key secret. Don't commit it to version control or expose it in client-side code. If a key is compromised, revoke it immediately.

Core Endpoints

People

GET
/people

List all people (paginated)

GET
/people/:id

Get a specific person

POST
/people

Create a new person

PATCH
/people/:id

Update a person

Groups

GET
/groups

List all groups

GET
/groups/:id/members

Get members of a group

POST
/groups/:id/members

Add member to group

Events

GET
/events

List events (with date filters)

GET
/events/:id/registrations

Get event registrations

POST
/events/:id/checkin

Check in a person

Giving

GET
/donations

List donations (with date/donor filters)

GET
/donations/summary

Get giving summary/totals

Rate Limits

API requests are rate-limited to ensure fair usage:

Limit TypeLimit
Per minute60 requests
Per hour1,000 requests
Per day10,000 requests

Rate limit headers are included in every response. If you exceed limits, you'll receive a 429 Too Many Requests response.

Example Request

# Get all people
curl -X GET https://api.relius.ai/v1/people \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json"
# Response
{
  "data": [
    {
      "id": "abc123",
      "first_name": "John",
      "last_name": "Smith",
      "email": "john@example.com",
      "created_at": "2024-01-15T10:30:00Z"
    }
  ],
  "pagination": {
    "page": 1,
    "per_page": 25,
    "total": 150
  }
}

Webhooks

Webhooks let you receive real-time notifications when events occur in Relius. Configure webhooks in Administration → Integrations → Webhooks.

Available webhook events:

  • person.created — New person added
  • person.updated — Person profile updated
  • donation.created — New donation recorded
  • event.checkin — Person checked into event
  • group.member_added — Person added to group

Full API Reference

For complete endpoint documentation, request/response schemas, and interactive examples, visit our API reference portal.

View Full API Docs →

Related Topics

Integrations →Security Settings →FAQ →