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

# Get goal catalog

> Discover supported goal metrics, canonical units and fixed comparison rules. Goals are explicit user targets, separate from observed records.



## OpenAPI

````yaml /openapi.json get /v1/goals/catalog
openapi: 3.1.1
info:
  title: Vitalog
  version: 1.0.1
  description: >-
    Single-user structured observations with equivalent REST and MCP domain
    services. Environment AUTH_KEY or revocable personal Bearer keys with
    required name, permissions and explicit expiry (including Never); Primary
    key management requires AUTH_KEY; the UI uses separate, root-verified
    30-minute management sessions. MCP clients use OAuth authorization code with
    S256 PKCE, issued after root sign-in. Clients are resolved through HTTPS
    metadata, pre-registration or dynamic registration. OAuth tokens grant MCP
    access only.
servers:
  - url: https://vitalog-api.example.com
    description: Production REST and MCP API
  - url: http://localhost:3000
    description: Loopback development; production requires TLS ingress
security: []
paths:
  /v1/goals/catalog:
    get:
      tags:
        - Goals
      summary: Get goal catalog
      description: >-
        Discover supported goal metrics, canonical units and fixed comparison
        rules. Goals are explicit user targets, separate from observed records.
      operationId: health_get_goal_catalog
      parameters: []
      responses:
        '200':
          description: Successful domain response
          content:
            application/json:
              schema:
                $schema: https://json-schema.org/draft/2020-12/schema
                type: object
                properties:
                  catalog_version:
                    type: string
                    const: 1.0.4
                  metrics:
                    maxItems: 200
                    type: array
                    items:
                      $ref: '#/components/schemas/Schema_aa134a892a9e___schema0'
                required:
                  - catalog_version
                  - metrics
                additionalProperties: false
        '401':
          description: UNAUTHORIZED
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: FORBIDDEN
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: NOT_FOUND
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '408':
          description: TIMEOUT
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: >-
            VERSION_CONFLICT, IDEMPOTENCY_CONFLICT, DAILY_TOTAL_EXISTS,
            CATALOG_VERSION_MISMATCH
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '413':
          description: LIMIT_EXCEEDED
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '422':
          description: VALIDATION_ERROR
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: RATE_LIMITED
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: INTERNAL_ERROR
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '503':
          description: UNAVAILABLE
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - staticKey: []
        - apiKey: []
        - browserSession: []
components:
  schemas:
    Schema_aa134a892a9e___schema0:
      type: object
      properties:
        metric:
          type: string
          enum:
            - measurement:weight
            - nutrient:energy_kcal
            - nutrient:protein_g
            - nutrient:carbohydrate_g
            - nutrient:fat_g
            - nutrient:fiber_g
            - hydration:water_ml
            - activity:active_energy_kcal
            - activity:exercise_minutes
        label:
          type: string
          minLength: 1
          maxLength: 100
        unit:
          type: string
          minLength: 1
          maxLength: 20
        accepted_units:
          maxItems: 10
          type: array
          items:
            $ref: '#/components/schemas/Schema_aa134a892a9e___schema1'
        period:
          type: string
          enum:
            - daily
            - ongoing
        direction:
          type: string
          enum:
            - maximum
            - minimum
            - target
      required:
        - metric
        - label
        - unit
        - accepted_units
        - period
        - direction
      additionalProperties: false
    Error:
      type: object
      additionalProperties: false
      required:
        - code
        - message
        - catalog_version
        - issues
      properties:
        code:
          type: string
          enum:
            - VALIDATION_ERROR
            - NOT_FOUND
            - VERSION_CONFLICT
            - IDEMPOTENCY_CONFLICT
            - DAILY_TOTAL_EXISTS
            - CATALOG_VERSION_MISMATCH
            - LIMIT_EXCEEDED
            - UNAUTHORIZED
            - FORBIDDEN
            - RATE_LIMITED
            - UNAVAILABLE
            - TIMEOUT
            - INTERNAL_ERROR
        message:
          type: string
        catalog_version:
          type: string
        issues:
          type: array
          items:
            type: object
            properties:
              path:
                type: string
              reason:
                type: string
              message:
                type: string
              suggested_keys:
                type: array
                items:
                  type: string
              discovery:
                type: object
        existing_id:
          type: string
        current_version:
          type: integer
        current_catalog_version:
          type: string
    Schema_aa134a892a9e___schema1:
      type: string
      minLength: 1
      maxLength: 20
  securitySchemes:
    staticKey:
      type: http
      scheme: bearer
      description: >-
        Environment AUTH_KEY. Full ledger access and primary API-key
        administration. Not OAuth or JWT.
    apiKey:
      type: http
      scheme: bearer
      description: >-
        Generated opaque vlk_ key with a required name, explicit read/edit
        permissions, optional administrative inspection and chosen expiry
        (including Never). Enforces the same ceiling on REST and MCP; cannot
        administer credentials or account settings. Not OAuth or JWT.
    browserSession:
      type: http
      scheme: bearer
      description: >-
        Opaque vls_ browser token, valid for 30 days unless revoked. Read-only
        REST access. The UI stores it in a host-only HttpOnly SameSite=Lax
        cookie; it never reaches browser JavaScript. Key administration and MCP
        reject this token.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.