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

# Get Goals

> Get user goals.

- **limit**: Maximum number of goals to return
- **include_inactive**: If True, includes inactive/completed goals



## OpenAPI

````yaml /api-reference/openapi.json get /v1/dev/user/goals
openapi: 3.1.0
info:
  contact:
    name: Omi
    url: https://omi.me/
  description: >-
    Programmatic access to your Omi data - memories, conversations, action
    items, goals, folders, and API keys. Build custom integrations, analytics
    dashboards, and automation workflows.
  license:
    name: MIT
    url: https://github.com/BasedHardware/omi/blob/main/LICENSE
  title: Omi Developer API
  version: 1.0.0
servers:
  - description: Production
    url: https://api.omi.me
security: []
tags:
  - description: Read and write user memories - timeless facts, preferences, and insights.
    name: Memories
  - description: Create and retrieve conversation transcripts with AI-generated summaries.
    name: Conversations
  - description: Retrieve user-defined folders for organizing conversations.
    name: Folders
  - description: Manage tasks and to-dos extracted from conversations or created manually.
    name: Action Items
  - description: Manage user goals and progress history.
    name: Goals
  - description: Create, list, and revoke developer API keys.
    name: API Keys
paths:
  /v1/dev/user/goals:
    get:
      tags:
        - Goals
      summary: Get Goals
      description: |-
        Get user goals.

        - **limit**: Maximum number of goals to return
        - **include_inactive**: If True, includes inactive/completed goals
      operationId: listGoals
      parameters:
        - in: query
          name: limit
          required: false
          schema:
            default: 10
            title: Limit
            type: integer
        - in: query
          name: include_inactive
          required: false
          schema:
            default: false
            title: Include Inactive
            type: boolean
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/DeveloperGoal'
                title: Response Listgoals
                type: array
          description: Successful Response
        '401':
          $ref: '#/components/responses/Error401'
        '403':
          $ref: '#/components/responses/Error403'
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      security:
        - developerApiKey: []
components:
  schemas:
    DeveloperGoal:
      properties:
        created_at:
          format: date-time
          title: Created At
          type: string
        current_value:
          title: Current Value
          type: number
        goal_type:
          title: Goal Type
          type: string
        id:
          title: Id
          type: string
        is_active:
          title: Is Active
          type: boolean
        max_value:
          title: Max Value
          type: number
        min_value:
          title: Min Value
          type: number
        target_value:
          title: Target Value
          type: number
        title:
          title: Title
          type: string
        unit:
          anyOf:
            - type: string
            - type: 'null'
          title: Unit
        updated_at:
          format: date-time
          title: Updated At
          type: string
      required:
        - id
        - title
        - goal_type
        - target_value
        - current_value
        - min_value
        - max_value
        - is_active
        - created_at
        - updated_at
      title: DeveloperGoal
      type: object
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          title: Detail
          type: array
      title: HTTPValidationError
      type: object
    ErrorResponse:
      properties:
        detail:
          anyOf:
            - type: string
            - type: array
            - type: object
          description: Error detail returned by the API.
      required:
        - detail
      title: ErrorResponse
      type: object
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          title: Location
          type: array
        msg:
          title: Message
          type: string
        type:
          title: Error Type
          type: string
      required:
        - loc
        - msg
        - type
      title: ValidationError
      type: object
  responses:
    Error401:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
      description: Missing or invalid authentication credentials.
    Error403:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
      description: Authenticated, but the token does not grant the required scope.
  securitySchemes:
    developerApiKey:
      bearerFormat: Omi Developer API key
      description: 'Send `Authorization: Bearer <omi_developer_api_key>`.'
      scheme: bearer
      type: http

````