GET
/
v1
/
open
/
branches
Get Church Branches
curl --request GET \
  --url https://app.thefaithapp.com/api/v1/open/branches \
  --header 'Authorization: Bearer <token>' \
  --header 'X-API-Key: <x-api-key>'
{
  "current_page": 1,
  "data": [
    {
      "id": 1,
      "client_id": 2,
      "name": "Reno Branch",
      "location": "596 Sheila Lane Reno, NV 89501",
      "pastor": "Katelyn C. Warne",
      "contact": "+1 775-370-2016",
      "created_at": "2025-05-03T06:32:50.000000Z",
      "updated_at": "2025-05-03T06:32:50.000000Z",
      "deleted_at": null,
      "gatherings": [
        {
          "id": 1,
          "branch_id": 1,
          "gathering_type_id": 1,
          "name": "Sunday First Service",
          "day_of_week": "Sunday",
          "start_time": "2025-05-24T10:00:00.000000Z",
          "end_time": "2025-05-24T11:00:00.000000Z",
          "description": "This is our weekly sunday service",
          "is_active": true,
          "created_at": "2025-05-24T07:09:55.000000Z",
          "updated_at": "2025-05-24T08:24:44.000000Z",
          "deleted_at": null
        }
      ]
    }
  ],
  "first_page_url": "https://app.thefaithapp.com/api/v1/open/branches?page=1",
  "from": 1,
  "last_page": 1,
  "last_page_url": "https://app.thefaithapp.com/api/v1/open/branches?page=1",
  "links": [
    {
      "url": null,
      "label": "&laquo; Previous",
      "active": false
    },
    {
      "url": "https://app.thefaithapp.com/api/v1/open/branches?page=1",
      "label": "1",
      "active": true
    },
    {
      "url": null,
      "label": "Next &raquo;",
      "active": false
    }
  ],
  "next_page_url": null,
  "path": "https://app.thefaithapp.com/api/v1/open/branches",
  "per_page": 10,
  "prev_page_url": null,
  "to": 1,
  "total": 1
}
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.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
X-API-Key
string
required

Your client API key from the dashboard (Settings page).

Query Parameters

​
page
integer
default:1

Page number for pagination (default: 1).

Response

Paginated list of church branches.

​
current_page
integer

Current page number of the result set.

Example:

1

​
data
object[]

List of branch objects.

​
first_page_url
string<uri>

URL to the first page of results.

Example:

"https://app.thefaithapp.com/api/v1/open/branches?page=1"

​
from
integer

Index of the first item returned.

Example:

1

​
last_page
integer

Last page number of the result set.

Example:

1

​
last_page_url
string<uri>

URL to the last page of results.

Example:

"https://app.thefaithapp.com/api/v1/open/branches?page=1"

​
links
object[]

Pagination navigation links.

​
next_page_url
string<uri> | null

URL to the next page of results, or null if on the last page.

Example:

null

​
path
string<uri>

Base path for the paginated results.

Example:

"https://app.thefaithapp.com/api/v1/open/branches"

​
per_page
integer

Number of items per page.

Example:

10

​
prev_page_url
string<uri> | null

URL to the previous page of results, or null if on the first page.

Example:

null

​
to
integer

Index of the last item returned.

Example:

1

​
total
integer

Total number of items available.

Example:

1