> ## 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 Community Summary

> Returns the authenticated member's group counts, mutual-aid availability, research-pilot status, and shared-resource availability.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/community/summary
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/community/summary:
    get:
      tags:
        - Community Preferences & Research
      summary: Get Community Summary
      description: >-
        Returns the authenticated member's group counts, mutual-aid
        availability, research-pilot status, and shared-resource availability.
      operationId: getCommunitySummary
      responses:
        '200':
          description: Community summary loaded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommunitySummaryResponse'
              examples:
                success:
                  summary: Community summary loaded.
                  value:
                    status: Success
                    data:
                      summary:
                        active_group_count: 2
                        pending_group_count: 1
                        mutual_aid:
                          enabled: true
                          eligible: true
                          categories:
                            - slug: one_time_transport
                              label: One-time transport
                              default_expiry_days: 3
                              allowed_kinds:
                                - need
                                - offer
                              allowed_visibilities:
                                - church
                                - campus
                                - community_group
                                - leaders
                              always_review: false
                              enabled: true
                              require_review: false
                              expiry_days: 3
                              max_expiry_days: 6
                          allow_church_visibility: true
                          show_author_names: true
                          default_contact_preference: in_app
                          default_visibility_order:
                            - community_group
                            - campus
                            - leaders
                          my_active_post_count: 1
                        research_pilots:
                          enabled: true
                          eligible: true
                          research_only: true
                          automated_matching: false
                          consent_version: 2026-07
                          active: true
                          pilot_keys:
                            - recurring_rides
                          consented_at: '2026-07-18T09:30:00.000000Z'
                        resource_library:
                          enabled: true
                          eligible: true
                          medical_equipment_staff_reviewed: true
                          exact_locations_hidden: true
        '401':
          description: Missing or invalid API key or member bearer token.
        '403':
          description: The authenticated account is not an eligible church member.
components:
  schemas:
    CommunitySummaryResponse:
      type: object
      required:
        - status
        - data
      properties:
        status:
          type: string
          const: Success
        data:
          type: object
          required:
            - summary
          properties:
            summary:
              type: object
              properties:
                active_group_count:
                  type: integer
                  minimum: 0
                pending_group_count:
                  type: integer
                  minimum: 0
                mutual_aid:
                  type: object
                  properties:
                    enabled:
                      type: boolean
                    eligible:
                      type: boolean
                    categories:
                      type: array
                      description: Mutual-aid categories enabled for this church.
                      items:
                        type: object
                        required:
                          - slug
                          - label
                          - default_expiry_days
                          - allowed_kinds
                          - allowed_visibilities
                          - always_review
                          - enabled
                          - require_review
                          - expiry_days
                          - max_expiry_days
                        properties:
                          slug:
                            $ref: '#/components/schemas/MutualAidCategory'
                          label:
                            type: string
                          default_expiry_days:
                            type: integer
                            minimum: 1
                          allowed_kinds:
                            type: array
                            items:
                              type: string
                              enum:
                                - need
                                - offer
                          allowed_visibilities:
                            type: array
                            items:
                              $ref: '#/components/schemas/MutualAidVisibility'
                          always_review:
                            type: boolean
                          enabled:
                            type: boolean
                          require_review:
                            type: boolean
                          expiry_days:
                            type: integer
                            minimum: 1
                          max_expiry_days:
                            type: integer
                            minimum: 1
                    allow_church_visibility:
                      type: boolean
                    show_author_names:
                      type: boolean
                    default_contact_preference:
                      type: string
                      enum:
                        - in_app
                        - leader
                    default_visibility_order:
                      type: array
                      items:
                        $ref: '#/components/schemas/MutualAidVisibility'
                    my_active_post_count:
                      type: integer
                      minimum: 0
                research_pilots:
                  $ref: '#/components/schemas/ResearchConsent'
                resource_library:
                  type: object
                  properties:
                    enabled:
                      type: boolean
                    eligible:
                      type: boolean
                    medical_equipment_staff_reviewed:
                      type: boolean
                    exact_locations_hidden:
                      type: boolean
    MutualAidCategory:
      type: string
      enum:
        - meals_groceries
        - one_time_transport
        - clothing_household
        - school_supplies
        - practical_help
        - employment_information
        - donation_drive
        - other
        - temporary_housing
        - emergency_financial_support
        - medical_equipment
    MutualAidVisibility:
      type: string
      enum:
        - church
        - campus
        - community_group
        - leaders
    ResearchConsent:
      type: object
      properties:
        enabled:
          type: boolean
        eligible:
          type: boolean
        research_only:
          type: boolean
          const: true
        automated_matching:
          type: boolean
          const: false
        consent_version:
          type: string
          example: 2026-07
        active:
          type: boolean
        pilot_keys:
          type: array
          items:
            type: string
        consented_at:
          type:
            - string
            - 'null'
          format: date-time
  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`.

````