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

# Health check

> Returns API and database health status. No authentication required.

Returns the health status of the API and its dependencies. No authentication required.

Use this endpoint to verify the API is reachable before starting an integration flow.
A `200` response with `status: "ok"` means the API and database are healthy. A `503`
response with `status: "degraded"` means the database check failed - the API process is
running but cannot serve data requests.


## OpenAPI

````yaml GET /health
openapi: 3.1.0
info:
  title: Structural API
  version: '1.0'
  description: |
    Bidirectional data translation between construction management platforms.
    One integration gives you normalized access to every connected platform.
  contact:
    email: support@structural.app
    url: https://structural.app
servers:
  - url: https://api.structural.app/api/v1
    description: Production
security: []
paths:
  /health:
    get:
      tags:
        - Health
      summary: Health check
      description: Returns API and database health status. No authentication required.
      operationId: getHealth
      responses:
        '200':
          description: API is healthy
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      status:
                        type: string
                        enum:
                          - ok
                        example: ok
                      timestamp:
                        type: string
                        format: date-time
                        example: '2026-04-11T12:00:00.000Z'
                      checks:
                        type: object
                        properties:
                          database:
                            type: string
                            enum:
                              - ok
                              - fail
                            example: ok
        '503':
          description: API is degraded
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      status:
                        type: string
                        enum:
                          - degraded
                        example: degraded
                      timestamp:
                        type: string
                        format: date-time
                      checks:
                        type: object
                        properties:
                          database:
                            type: string
                            enum:
                              - fail
                            example: fail

````