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

# List dashboard home metrics

> Returns the named dashboard home-metric catalog with per-company availability. Includes one `fx-rate:{CURRENCY}` card per non-USD company currency. API keys always receive the Métricas-group cards (`day-pnl-usd`, `commissions-net`, `cost-centers-net`) without the metrics-password cookie; those still respect `cost_centers_enabled` / `mesas_enabled` / `cheques_enabled` / `limits_enabled`. Employee sessions need the matching `*.view` permission for gated cards and skip the UI password gate on this surface.



## OpenAPI

````yaml /docs/openapi.json get /api/home-metrics
openapi: 3.0.0
info:
  title: FinSync API Documentation
  version: 1.0.0
  description: API documentation for FinSync application
  contact:
    name: FinSync Support
    email: support@finsync.com
servers:
  - url: https://api.finsync.ar
    description: Direct Fly API (preferred for API keys and webhooks)
  - url: https://finsync.ar
    description: Same-origin via finsync.ar (Vercel rewrite)
security:
  - apiKey: []
tags:
  - name: Clients
    description: Operations related to clients and their accounts
  - name: Tags
    description: >-
      Company-scoped client labels (Configuración > Etiquetas). Distinct from
      the special Centro de resultados / Centro de costos tag used for budget
      clients.
  - name: Accounts
    description: Operations related to account balances
  - name: Cost Centers
    description: Company centros de resultados (cost_center_id) and their budgets
  - name: Operations
    description: Operations for creating and managing financial operations
  - name: Operation Types
    description: Company operation types management
  - name: Transaction Types
    description: Company transaction types management
  - name: WhatsApp Tools
    description: >-
      Company-scoped WhatsApp bot operation tools (Configuración > WhatsApp >
      Tools). Same WhatsAppOperationTool rows as the dashboard. Authenticate
      with x-api-key.
  - name: External client
    description: >-
      Exports for external (portal-linked) clients. Authenticate with
      `x-api-key` (company-owned client ID) or `Authorization: Bearer` (Auth.js
      session for an ExternalAccessGrant).
  - name: Mesas
    description: >-
      Company FX trading desks (mesas). Same records and paths as the dashboard
      Mesas module. Integrators authenticate with x-api-key; the dashboard uses
      an employee session. Superadmin must set mesas_enabled first; there is no
      public PATCH for that flag. created_by / opened_by / closed_by are null
      for API-key callers.
  - name: Home metrics
    description: >-
      Named dashboard home metrics (list + values). API keys receive the
      Métricas-group cards (day P&L, commissions, cost centers) without the
      metrics-password cookie. Employee sessions need the matching view
      permission; they still skip the UI password gate on this surface.
paths:
  /api/home-metrics:
    get:
      tags:
        - Home metrics
      summary: List dashboard home metrics
      description: >-
        Returns the named dashboard home-metric catalog with per-company
        availability. Includes one `fx-rate:{CURRENCY}` card per non-USD company
        currency. API keys always receive the Métricas-group cards
        (`day-pnl-usd`, `commissions-net`, `cost-centers-net`) without the
        metrics-password cookie; those still respect `cost_centers_enabled` /
        `mesas_enabled` / `cheques_enabled` / `limits_enabled`. Employee
        sessions need the matching `*.view` permission for gated cards and skip
        the UI password gate on this surface.
      responses:
        '200':
          description: Catalog with availability
          content:
            application/json:
              schema:
                type: object
                required:
                  - metrics
                properties:
                  metrics:
                    type: array
                    items:
                      $ref: '#/components/schemas/HomeMetricListItem'
        '401':
          description: Authentication required
        '500':
          description: Server error
      security:
        - apiKey: []
        - bearerAuth: []
components:
  schemas:
    HomeMetricListItem:
      type: object
      required:
        - id
        - label
        - description
        - group
        - available
        - unavailable_reason
      properties:
        id:
          type: string
          description: >-
            Static catalog id (`mesa-volumes`, `ops-month`, …) or a per-pair FX
            card `fx-rate:{CURRENCY}` such as `fx-rate:ARS`. The legacy
            `fx-rates` id expands to every company pair.
          example: fx-rate:ARS
        label:
          type: string
        description:
          type: string
        group:
          type: string
          enum:
            - operator
            - metrics
        available:
          type: boolean
        unavailable_reason:
          type: string
          nullable: true
          enum:
            - mesas_disabled
            - operations_forbidden
            - cheques_disabled
            - cheques_forbidden
            - limits_disabled
            - metrics_forbidden
            - cost_centers_disabled
            - actor_unavailable
            - null
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: API Key for authentication
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Auth.js session / access token for logged-in users (employees for most
        dashboard APIs; external portal users with an ExternalAccessGrant for
        `/api/external-client/history` and `/api/external-client/history/pdf`).

````

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