Skip to main content
GET
/
v1
/
branches
Get Church Branches
curl --request GET \
  --url https://api.thefaithapp.com/v1/branches \
  --header 'Authorization: Bearer <token>' \
  --header 'X-API-Key: <x-api-key>'
{
  "current_page": 123,
  "data": [
    {}
  ],
  "data[].gatherings": [
    {}
  ],
  "per_page": 123,
  "total": 123
}
Retrieves a paginated list of branches for the authenticated user’s church.
  • Requires both an API key and a Firebase ID token.
  • Supports optional pagination.
  • Each branch includes its associated gatherings/meetings with details like name, schedule, and status.

Request inputs

X-API-Key
string
required
Your client API key from the dashboard (Settings page).
page
number
Page number for pagination (default: 1).

Response fields

current_page
number
The current page of branch results.
data
object[]
required
Branch records returned for the authenticated member’s church.
data[].gatherings
object[]
Active gatherings attached to each branch, formatted for app display.
per_page
number
The maximum number of branch records returned in this page.
total
number
The total number of matching branches across all pages.

Example response

{
  "current_page": 1,
  "data": [
    {
      "id": 4,
      "name": "Downtown Campus",
      "location": "Kololo, Kampala",
      "gatherings": [
        {
          "id": 21,
          "name": "Morning Service",
          "day_of_week": "Sunday",
          "start_time": "08:00",
          "end_time": "10:00",
          "is_active": true
        }
      ]
    }
  ],
  "per_page": 10,
  "total": 1
}