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

# List Health Scores

> Returns health scores (sleep, recovery, readiness, etc.) for a user.



## OpenAPI

````yaml https://api.openwearables.io/openapi.json get /api/v1/users/{user_id}/health-scores
openapi: 3.1.0
info:
  title: Open Wearables API
  version: 0.1.0
servers: []
security: []
paths:
  /api/v1/users/{user_id}/health-scores:
    get:
      tags:
        - 'External: Health Scores'
      summary: List Health Scores
      description: Returns health scores (sleep, recovery, readiness, etc.) for a user.
      operationId: list_health_scores_api_v1_users__user_id__health_scores_get
      parameters:
        - name: user_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            title: User Id
        - name: start_date
          in: query
          required: false
          schema:
            anyOf:
              - type: string
                description: >-
                  ISO 8601 datetime (e.g. `2023-11-07T05:31:56Z`) or Unix
                  timestamp in seconds. Date-only strings (e.g. `2023-11-07`)
                  are also accepted and normalized to midnight UTC.
                examples:
                  - '2023-11-07T05:31:56Z'
                  - '2023-11-07'
                format: date-time
              - type: 'null'
            title: Start Date
        - name: end_date
          in: query
          required: false
          schema:
            anyOf:
              - type: string
                description: >-
                  ISO 8601 datetime (e.g. `2023-11-07T05:31:56Z`) or Unix
                  timestamp in seconds. Date-only strings (e.g. `2023-11-07`)
                  are also accepted and normalized to midnight UTC.
                examples:
                  - '2023-11-07T05:31:56Z'
                  - '2023-11-07'
                format: date-time
              - type: 'null'
            title: End Date
        - name: category
          in: query
          required: false
          schema:
            anyOf:
              - $ref: '#/components/schemas/HealthScoreCategory'
              - type: 'null'
            title: Category
        - name: provider
          in: query
          required: false
          schema:
            anyOf:
              - $ref: '#/components/schemas/ProviderName'
              - type: 'null'
            title: Provider
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            maximum: 1000
            minimum: 1
            default: 50
            title: Limit
        - name: offset
          in: query
          required: false
          schema:
            type: integer
            minimum: 0
            default: 0
            title: Offset
        - name: X-Open-Wearables-API-Key
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: X-Open-Wearables-Api-Key
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedResponse_HealthScoreResponse_'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - OAuth2PasswordBearer: []
components:
  schemas:
    HealthScoreCategory:
      type: string
      enum:
        - sleep
        - recovery
        - readiness
        - activity
        - stress
        - resilience
        - body_battery
        - strain
      title: HealthScoreCategory
    ProviderName:
      type: string
      enum:
        - apple
        - samsung
        - google
        - garmin
        - polar
        - suunto
        - whoop
        - strava
        - oura
        - fitbit
        - ultrahuman
        - unknown
        - internal
      title: ProviderName
      description: Supported data providers.
    PaginatedResponse_HealthScoreResponse_:
      properties:
        data:
          items:
            $ref: '#/components/schemas/HealthScoreResponse'
          type: array
          title: Data
        pagination:
          $ref: '#/components/schemas/Pagination'
        metadata:
          $ref: '#/components/schemas/TimeseriesMetadata'
      type: object
      required:
        - data
        - pagination
        - metadata
      title: PaginatedResponse[HealthScoreResponse]
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    HealthScoreResponse:
      properties:
        category:
          $ref: '#/components/schemas/HealthScoreCategory'
        value:
          anyOf:
            - type: number
            - type: integer
            - type: 'null'
          title: Value
          description: >-
            Overall numeric score. Range varies by provider and category — see
            HEALTH_SCORE_RANGES for scale.
        qualifier:
          anyOf:
            - type: string
            - type: 'null'
          title: Qualifier
          description: Textual rating from the provider, e.g. GOOD or EXCELLENT
        recorded_at:
          type: string
          format: date-time
          title: Recorded At
        zone_offset:
          anyOf:
            - type: string
              maxLength: 10
              pattern: ^[+-]\d{2}:\d{2}$
            - type: 'null'
          title: Zone Offset
          description: Timezone offset in the format '+01:00' or '-05:30'
          examples:
            - '+01:00'
            - '-05:30'
        components:
          anyOf:
            - additionalProperties:
                $ref: '#/components/schemas/ScoreComponent'
              type: object
            - type: 'null'
          title: Components
        id:
          type: string
          format: uuid
          title: Id
        data_source_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Data Source Id
        provider:
          anyOf:
            - $ref: '#/components/schemas/ProviderName'
            - type: 'null'
      type: object
      required:
        - category
        - recorded_at
        - id
        - data_source_id
        - provider
      title: HealthScoreResponse
    Pagination:
      properties:
        next_cursor:
          anyOf:
            - type: string
            - type: 'null'
          title: Next Cursor
          description: Cursor to fetch next page, null if no more data
          example: eyJpZCI6IjEyMzQ1Njc4OTAiLCJ0cyI6MTcwNDA2NzIwMH0
        previous_cursor:
          anyOf:
            - type: string
            - type: 'null'
          title: Previous Cursor
          description: Cursor to fetch previous page
        has_more:
          type: boolean
          title: Has More
          description: Whether more data is available
        total_count:
          anyOf:
            - type: integer
            - type: 'null'
          title: Total Count
          description: Total number of records matching the query
          example: 150
      type: object
      required:
        - has_more
      title: Pagination
    TimeseriesMetadata:
      properties:
        resolution:
          anyOf:
            - type: string
              enum:
                - raw
                - 1min
                - 5min
                - 15min
                - 1hour
            - type: 'null'
          title: Resolution
        sample_count:
          anyOf:
            - type: integer
            - type: 'null'
          title: Sample Count
        start_time:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Start Time
        end_time:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: End Time
      type: object
      title: TimeseriesMetadata
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    ScoreComponent:
      properties:
        value:
          anyOf:
            - type: number
            - type: integer
            - type: 'null'
          title: Value
          description: >-
            Numeric score value. Range varies by provider and category — see
            HEALTH_SCORE_RANGES for scale.
        qualifier:
          anyOf:
            - type: string
            - type: 'null'
          title: Qualifier
          description: Textual rating from the provider, e.g. GOOD or EXCELLENT
      type: object
      title: ScoreComponent
      description: A single constituent of a health score (e.g. deep sleep percentage).
  securitySchemes:
    OAuth2PasswordBearer:
      type: oauth2
      flows:
        password:
          scopes: {}
          tokenUrl: /api/v1/auth/login

````