> ## 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 Research Consent

> Returns consent and eligibility information for opt-in community research pilots.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/community/research-consent
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/research-consent:
    get:
      tags:
        - Community Preferences & Research
      summary: Get Research Consent
      description: >-
        Returns consent and eligibility information for opt-in community
        research pilots.
      operationId: getCommunityResearchConsent
      responses:
        '200':
          description: Research consent status loaded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResearchConsentResponse'
              examples:
                success:
                  summary: Research consent status loaded.
                  value:
                    status: Success
                    data:
                      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'
        '401':
          description: Missing or invalid API key or member bearer token.
        '403':
          description: The authenticated account is not an eligible church member.
components:
  schemas:
    ResearchConsentResponse:
      type: object
      properties:
        status:
          type: string
          const: Success
        data:
          type: object
          properties:
            research_pilots:
              $ref: '#/components/schemas/ResearchConsent'
    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`.

````