Skip to main content

API Keys

Network

API Keys allow your church to integrate Apostolic Path with external systems through the REST API. This is an advanced feature available exclusively on the Network tier.

What Are API Keys?​

API keys are credentials that allow external applications to securely access your church's data through the Apostolic Path API. Each key is:

  • Scoped to your church's data only
  • Rate-limited to prevent abuse
  • Individually manageable so you can create, rotate, and revoke keys as needed

Creating an API Key​

  1. Navigate to Settings > API Keys
  2. Click Create API Key
  3. Enter a name for the key (e.g., "Church Website Integration," "Custom Dashboard")
  4. Click Create
  5. Copy the key immediately — it will only be shown once
caution

Store your API key securely. It will only be displayed once at creation time. If you lose it, you'll need to create a new one.

Managing API Keys​

The API Keys page shows all your keys with:

  • Key name — Your descriptive label
  • Key prefix — The first few characters for identification
  • Created date
  • Last used — When the key was last used for an API call
  • Status (active or revoked)

Revoking a Key​

If a key is compromised or no longer needed:

  1. Find the key in the API Keys list
  2. Click Revoke
  3. The key will immediately stop working
  4. Any applications using it will need to be updated with a new key

Rate Limiting​

Each API key has its own rate limit to ensure fair usage and platform stability. Rate limits are applied per key, so having multiple keys gives you more capacity if needed.

API Documentation​

For technical documentation on the API endpoints, authentication, and data formats, contact the Apostolic Path team through the Network plan support channel.