> ## Documentation Index
> Fetch the complete documentation index at: https://docs.thefaithapp.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Church Branches

> Retrieve a paginated list of branches for the authenticated user's church. Supports optional pagination.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/branches
openapi: 3.1.0
info:
  title: TheFaithApp Partner API
  version: 1.0.0
  description: >-
    The v1 API for third-party apps that sign in TheFaithApp members and access
    church-scoped content and workflows.
  contact:
    name: TheFaithApp Support
    email: support@thefaithapp.com
servers:
  - url: https://api.thefaithapp.com
    description: Production
security:
  - apiKeyAuth: []
    bearerAuth: []
tags:
  - name: Hosted Auth
    description: Sign members in through the hosted TheFaithApp authentication flow.
  - name: Core Experience
    description: Load member context and the personalized home experience.
  - name: Content
    description: >-
      Read sermons, media, YouTube videos, devotionals, and streaming
      configuration.
  - name: Engagement
    description: Manage member favorites and devotional bookmarks.
  - name: Churches
    description: Read church profiles, public directory records, and branch information.
  - name: Events & Volunteers
    description: >-
      Browse events and volunteer opportunities, then manage registrations and
      commitments.
  - name: Notifications & Bulletins
    description: Read church and member notifications and published bulletins.
  - name: Prayer
    description: Submit a prayer request for the authenticated member.
  - name: Member Connections
    description: Manage the member’s campus and ministry connections.
  - name: Community Groups
    description: >-
      Discover groups and manage membership, feeds, attendance, study guides,
      and leader notes.
  - name: Community Preferences & Research
    description: >-
      Manage community preferences, summaries, and consent-based research
      participation.
  - name: Resource Sharing
    description: Offer shared resources and manage member loan requests and transitions.
  - name: Mutual Aid
    description: >-
      Manage needs and offers, private responses, safety reports, and member
      activity.
  - name: Analytics
    description: Record product analytics events and retrieve aggregate metrics.
  - name: Notification Analytics
    description: Record and summarize notification delivery, open, and click events.
paths:
  /v1/branches:
    get:
      tags:
        - Churches
      summary: Get Church Branches
      description: >-
        Retrieve a paginated list of branches for the authenticated user's
        church. Supports optional pagination.
      operationId: getBranches
      parameters:
        - name: page
          in: query
          description: 'Page number for pagination (default: 1).'
          required: false
          schema:
            type: integer
            default: 1
      responses:
        '200':
          description: Paginated list of church branches.
          content:
            application/json:
              schema:
                type: object
                properties:
                  current_page:
                    type: integer
                    description: Current page number of the result set.
                    example: 1
                  data:
                    type: array
                    description: List of branch objects.
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                          description: Unique identifier for the branch.
                          example: 1
                        client_id:
                          type: integer
                          description: ID of the church/client this branch belongs to.
                          example: 2
                        name:
                          type: string
                          description: Name of the branch.
                          example: Reno Branch
                        location:
                          type: string
                          description: Physical address of the branch.
                          example: 596 Sheila Lane Reno, NV 89501
                        pastor:
                          type: string
                          description: Name of the branch pastor.
                          example: Katelyn C. Warne
                        contact:
                          type: string
                          description: Contact phone number for the branch.
                          example: +1 775-370-2016
                        created_at:
                          type: string
                          format: date-time
                          description: Timestamp when the branch was created.
                          example: '2025-05-03T06:32:50.000000Z'
                        updated_at:
                          type: string
                          format: date-time
                          description: Timestamp when the branch was last updated.
                          example: '2025-05-03T06:32:50.000000Z'
                        deleted_at:
                          type:
                            - string
                            - 'null'
                          format: date-time
                          description: >-
                            Timestamp when the branch was deleted, or null if
                            not deleted.
                          example: null
                        gatherings:
                          type: array
                          description: List of gatherings/meetings for this branch.
                          items:
                            type: object
                            properties:
                              id:
                                type: integer
                                description: Unique identifier for the gathering.
                                example: 1
                              branch_id:
                                type: integer
                                description: ID of the branch this gathering belongs to.
                                example: 1
                              gathering_type_id:
                                type: integer
                                description: >-
                                  ID of the gathering type. Possible values:

                                  - `1`: Service - Regular worship services
                                  including Sunday services, midweek services,
                                  etc.

                                  - `2`: Study - Bible study groups, Sunday
                                  school, discipleship classes

                                  - `3`: Prayer - Regular prayer gatherings,
                                  prayer vigils

                                  - `4`: Youth - Youth services, youth meetings,
                                  youth activities

                                  - `5`: Children - Children's church, Sunday
                                  school, children's activities

                                  - `6`: Food Pantry - Food distribution
                                  services, community feeding programs

                                  - `7`: Outreach - Community outreach,
                                  evangelism programs

                                  - `8`: Fellowship - Fellowship meals, social
                                  gatherings, community events

                                  - `9`: Choir - Choir rehearsals, music
                                  ministry practices

                                  - `10`: Counseling - Pastoral counseling,
                                  support groups
                                example: 1
                              name:
                                type: string
                                description: Name of the gathering.
                                example: Sunday First Service
                              day_of_week:
                                type: string
                                description: Day of the week when the gathering occurs.
                                example: Sunday
                              start_time:
                                type: string
                                format: date-time
                                description: Start time of the gathering.
                                example: '2025-05-24T10:00:00.000000Z'
                              end_time:
                                type: string
                                format: date-time
                                description: End time of the gathering.
                                example: '2025-05-24T11:00:00.000000Z'
                              description:
                                type: string
                                description: Description of the gathering.
                                example: This is our weekly sunday service
                              is_active:
                                type: boolean
                                description: Whether the gathering is currently active.
                                example: true
                              created_at:
                                type: string
                                format: date-time
                                description: Timestamp when the gathering was created.
                                example: '2025-05-24T07:09:55.000000Z'
                              updated_at:
                                type: string
                                format: date-time
                                description: Timestamp when the gathering was last updated.
                                example: '2025-05-24T08:24:44.000000Z'
                              deleted_at:
                                type:
                                  - string
                                  - 'null'
                                format: date-time
                                description: >-
                                  Timestamp when the gathering was deleted, or
                                  null if not deleted.
                                example: null
                  first_page_url:
                    type: string
                    format: uri
                    description: URL to the first page of results.
                    example: https://api.thefaithapp.com/v1/branches?page=1
                  from:
                    type: integer
                    description: Index of the first item returned.
                    example: 1
                  last_page:
                    type: integer
                    description: Last page number of the result set.
                    example: 1
                  last_page_url:
                    type: string
                    format: uri
                    description: URL to the last page of results.
                    example: https://api.thefaithapp.com/v1/branches?page=1
                  links:
                    type: array
                    description: Pagination navigation links.
                    items:
                      type: object
                      properties:
                        url:
                          type:
                            - string
                            - 'null'
                          format: uri
                          description: URL for the page link, or null if not available.
                          example: null
                        label:
                          type: string
                          description: >-
                            Label for the page link (e.g., 'Next', 'Previous',
                            or page number).
                          example: '&laquo; Previous'
                        active:
                          type: boolean
                          description: Whether this page link is active.
                          example: false
                  next_page_url:
                    type:
                      - string
                      - 'null'
                    format: uri
                    description: >-
                      URL to the next page of results, or null if on the last
                      page.
                    example: null
                  path:
                    type: string
                    format: uri
                    description: Base path for the paginated results.
                    example: https://api.thefaithapp.com/v1/branches
                  per_page:
                    type: integer
                    description: Number of items per page.
                    example: 10
                  prev_page_url:
                    type:
                      - string
                      - 'null'
                    format: uri
                    description: >-
                      URL to the previous page of results, or null if on the
                      first page.
                    example: null
                  to:
                    type: integer
                    description: Index of the last item returned.
                    example: 1
                  total:
                    type: integer
                    description: Total number of items available.
                    example: 1
              examples:
                success:
                  summary: Successful response
                  value:
                    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://api.thefaithapp.com/v1/branches?page=1
                    from: 1
                    last_page: 1
                    last_page_url: https://api.thefaithapp.com/v1/branches?page=1
                    links:
                      - url: null
                        label: '&laquo; Previous'
                        active: false
                      - url: https://api.thefaithapp.com/v1/branches?page=1
                        label: '1'
                        active: true
                      - url: null
                        label: Next &raquo;
                        active: false
                    next_page_url: null
                    path: https://api.thefaithapp.com/v1/branches
                    per_page: 10
                    prev_page_url: null
                    to: 1
                    total: 1
        '401':
          description: Unauthorized - Missing or invalid API key or member bearer token.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Unauthorized
        '404':
          description: User or branches not found.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: User not found
components:
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: >-
        Client API key copied from Developer Access in the TheFaithApp
        dashboard.
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: Sanctum
      description: Member access token returned by `POST /v1/auth/token`.

````