---
title: "List the company's pinned Home metric widgets"
method: GET
path: "/companies/{companyId}/metrics/pins"
tags: ["Overview"]
---

# List the company's pinned Home metric widgets

`GET /companies/{companyId}/metrics/pins`

## Request

- Base URL: `https://api.medianfi.com/api/v1`
- URL: `https://api.medianfi.com/api/v1/companies/{companyId}/metrics/pins`
- Auth: HTTP bearer

Returns the server-authoritative pinned-widget list for the Home board, ordered by position. Returns 404 unless `practice_metrics` is in the company's `additionalMetrics` list.

## Response `200`

Pinned widgets

- PinnedMetricsResponse
  - `success` true, required
  - `data` object, required
    - `pins` PinnedMetric[], required
      - `widgetKey` string, required
      - `position` integer, required

## Other responses

- `401`: Authentication required
- `403`: Insufficient permissions or not a company member
- `404`: practice_metrics is not in this company's additionalMetrics list

---

[API](https://skmtc.dev/medianfi/apis/median-api.md) · [All operations](https://skmtc.dev/medianfi/apis/median-api/llms.txt) · [OpenAPI document](https://skmtc.dev/medianfi/apis/median-api/revisions/20090ea32b0d?raw)