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

# Check service health



## OpenAPI

````yaml /openapi/pocketmusala-developer-api-v1.yaml get /v1/health
openapi: 3.1.0
info:
  title: PocketMusala Developer API
  version: 1.0.0
  summary: Mosque sync API for trusted external servers.
  license:
    name: Proprietary
    identifier: LicenseRef-PocketMusala-Proprietary
  description: >
    The PocketMusala Developer API lets trusted external servers sync approved
    mosque profile, prayer, announcement, and event data. API key creation,
    scope selection, rotation, and revocation stay inside the authenticated
    PocketMusala Developer API portal.
servers:
  - url: https://api.pocketmusala.com
    description: Official API
security:
  - bearerAuth: []
tags:
  - name: Health
    description: Service availability endpoints.
  - name: Capabilities
    description: Supported resources, fields, scopes, and prayer keys.
  - name: Snapshot
    description: Combined read endpoints for weekly sync verification.
  - name: Profile
    description: Approved public mosque profile fields.
  - name: Announcements
    description: Mosque announcement sync endpoints.
  - name: Prayers
    description: Manual prayer-time row sync endpoints.
  - name: Events
    description: Mosque event sync endpoints.
paths:
  /v1/health:
    get:
      tags:
        - Health
      summary: Check service health
      operationId: getHealth
      responses:
        '200':
          description: Service is available.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthResponse'
        4XX:
          $ref: '#/components/responses/Error'
      security: []
components:
  schemas:
    HealthResponse:
      type: object
      required:
        - ok
        - version
        - service
      properties:
        ok:
          type: boolean
          const: true
        version:
          type: string
          example: v1
        service:
          type: string
          example: mosque-profile-sync
    ErrorEnvelope:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
            - requestId
            - troubleshooting
          properties:
            code:
              type: string
              examples:
                - missing_api_key
                - malformed
                - revoked
                - wrong_community
                - missing_scope
                - invalid_argument
                - invalid_prayer_time
                - not_found
            message:
              type: string
            requestId:
              type: string
            troubleshooting:
              $ref: '#/components/schemas/TroubleshootingState'
    TroubleshootingState:
      type: object
      required:
        - code
        - severity
        - adminSummary
        - developerSummary
      properties:
        code:
          type: string
        severity:
          type: string
          enum:
            - success
            - warning
            - error
        adminSummary:
          type: string
        developerSummary:
          type: string
  responses:
    Error:
      description: Stable JSON error envelope.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: PocketMusala Developer API key from the authenticated portal.

````