> ## 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 Hosted Auth Configuration

> Returns public church branding, enabled sign-in providers, and whether a redirect URL is allowed.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/auth/config
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/auth/config:
    get:
      tags:
        - Hosted Auth
      summary: Get Hosted Auth Configuration
      description: >-
        Returns public church branding, enabled sign-in providers, and whether a
        redirect URL is allowed.
      operationId: getAuthConfig
      parameters:
        - name: client_key
          in: query
          required: true
          description: Client API key copied from Developer Access.
          schema:
            type: string
        - name: redirect_uri
          in: query
          required: true
          description: Callback URL to check against the saved redirect list.
          schema:
            type: string
            format: uri
      responses:
        '200':
          description: Hosted auth configuration returned.
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
              example:
                client:
                  id: 12
                  name: Example Church
                  public_uuid: 11111111-2222-3333-4444-555555555555
                  image_url: https://cdn.example.com/clients/example.png
                redirect_uri_allowed: true
                providers:
                  - google
                  - apple
                  - email
        '404':
          $ref: '#/components/responses/NotFound'
        '422':
          $ref: '#/components/responses/ValidationError'
      security: []
components:
  responses:
    NotFound:
      description: The requested resource was not found in the authenticated church.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    ValidationError:
      description: One or more request fields failed validation.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  schemas:
    ErrorResponse:
      type: object
      description: >-
        Error response. Validation failures also include an `errors` object
        keyed by field name.
      properties:
        status:
          type: string
          example: Error
        message:
          type: string
          example: The request could not be completed.
        error:
          type:
            - string
            - 'null'
          example: null
        error_message:
          type:
            - string
            - 'null'
          example: null
        errors:
          type: object
          additionalProperties: true
  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`.

````