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

# Get list of habits

> Get a list of habits (Notion sourced)



## OpenAPI

````yaml /api-reference/openapi.yaml get /habits
openapi: 3.1.0
info:
  title: ONVY Health API
  description: >-
    AI-powered holistic health services API with data merging and metrics
    calculation
  version: 1.0.0
  contact:
    name: ONVY Support
    email: support@onvy.health
    url: https://onvy.health
  license:
    name: Proprietary
    url: https://onvy.health/terms
servers:
  - url: https://api.onvy.health
    description: Public API
security:
  - bearerAuth: []
tags:
  - name: static
    description: Static configuration endpoints
  - name: users
    description: User management
  - name: baselines
    description: User baseline metrics
  - name: daily-records
    description: Daily health records
  - name: chat
    description: AI chat completions
  - name: facts
    description: User facts for individualization
  - name: activities
    description: User activities (workouts and mindfulness sessions)
  - name: ai-summaries
    description: |
      AI-generated summaries. This is how ONVY exposes domain-specific
      insights such as meal nutrition analysis, sleep insights, workouts,
      and daily, weekly, nutrition, trend, and impact analysis. Most
      summary types are system-generated; the public create surface
      currently accepts `type=meal`.
  - name: custom-records
    description: Custom records and types
  - name: meals
    description: Nutrition meal tracking
paths:
  /habits:
    get:
      tags:
        - static
      summary: Get list of habits
      description: Get a list of habits (Notion sourced)
      operationId: getHabits
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HabitList'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalError'
components:
  schemas:
    HabitList:
      title: HabitList
      type: array
      items:
        type: object
        required:
          - name
          - id
          - created_time
          - last_edited_time
          - archived
          - in_trash
          - url
          - category
          - playUnexpectedImpact
          - playImpact
          - title
          - description
        properties:
          name:
            type: string
            description: The name identifier of the mindfulness activity
          id:
            type: string
            format: uuid
            description: Unique identifier for the activity
          created_time:
            type: string
            format: date-time
            description: ISO 8601 timestamp when the activity was created
          last_edited_time:
            type: string
            format: date-time
            description: ISO 8601 timestamp when the activity was last modified
          cover:
            type:
              - string
              - 'null'
            format: uri
            description: URL to the cover image for the activity
          archived:
            type: boolean
            description: Whether the activity is archived
          in_trash:
            type: boolean
            description: Whether the activity is in trash
          url:
            type: string
            format: uri
            description: The primary URL for accessing the activity
          public_url:
            type:
              - string
              - 'null'
            format: uri
            description: Public URL if the activity is publicly accessible
          potentialImpacts:
            type: object
            description: Object containing various impact categories and their details
            additionalProperties:
              type: object
              required:
                - impact
              properties:
                impact:
                  type: number
                  format: float
                  minimum: 0
                  maximum: 1
                  description: Numerical impact value (0-1 scale)
                description:
                  type: string
                  description: Text description explaining the impact
          playUnexpectedImpact:
            type: boolean
            description: Whether to play unexpected impact animations or effects
          category:
            type: string
            description: The category classification of the activity
          playImpact:
            type: boolean
            description: Whether to play impact animations or effects
          title:
            type: string
            description: Human-readable title of the activity
          description:
            type: string
            description: Detailed description of the activity
    ValidationError:
      type: object
      title: ValidationError
      required:
        - error
      properties:
        error:
          type: string
          minLength: 1
      additionalProperties: false
  responses:
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ValidationError'
    InternalError:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ValidationError'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: OAuth bearer token for Health API authentication

````