Skip to main content

​
TheFaithApp Partner API

TheFaithApp v1 is the supported API for third-party web and mobile apps. It lets an integration sign in members through hosted auth and work with the member’s church-scoped content and workflows.

​
Base URL

All request and response bodies use JSON unless an endpoint explicitly documents a file response, such as a CSV export.

​
Authentication at a glance

Protected requests require two credentials:
  • The client API key identifies the partner app and church.
  • The bearer token identifies the signed-in member.
  • The member token must belong to the same church as the client API key.
The hosted-auth setup and code-exchange endpoints do not use these headers. They accept the client key in the request so a member can sign in before an access token exists.

Make your first request

Complete hosted sign-in and load the current member.

Understand hosted auth

Learn redirects, state validation, PKCE, token storage, and logout.

Build with Flutter

Add member sign-in and authenticated API requests to an Android or iOS app.

Build with React Native

Add hosted sign-in to an Expo or React Native app.

Add giving in Flutter

Render authenticated general and campaign giving in a Flutter app.

Add giving in React Native

Render authenticated general and campaign giving in React Native or Expo.

​
What you can build

  • Personalized church home experiences
  • Audio and video sermon libraries, transcripts, chapters, and insights
  • Devotionals, live streams, favorites, and bookmarks
  • Church discovery and public church profiles
  • Event registration and volunteer workflows
  • Member campus and ministry connections, community groups, and group resources
  • Shared-resource lending and mutual-aid needs and offers
  • Member notifications and bulletins
  • Hosted church giving experiences
  • Prayer request submission
  • Confidential, member-owned Pastoral Care requests and follow-up preferences
  • Product and notification analytics
Chat and messaging routes are not part of this partner reference.

​
Context headers

Some content changes with the member’s local date or timezone:

​
Request safety

Use an idempotency strategy in your own application for user actions. A network retry can otherwise submit the same logical action more than once when an endpoint does not expose an idempotency key. Keep API keys and member tokens out of browser logs, analytics payloads, crash reports, source control, and public screenshots.

​
Versioning

The version is part of every endpoint path. Backward-compatible fields may be added to v1 responses over time, so clients should ignore fields they do not recognize. A breaking contract change requires a new API version.