---
title: "List Charts Endpoint"
method: GET
path: "/api/v2/charts"
tags: ["APPS_V2"]
---

# List Charts Endpoint

`GET /api/v2/charts`

## Request

- Base URL: `https://api.myaltimate.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.myaltimate.com/api/v2/charts`
- Auth: one of:
  - HTTP bearer
  - HTTP bearer

List charts whose dataset is visible on the requesting tenant's
platform and whose dataset's feature flag (if any) is on.

## Headers

- `x-tenant` string, required
- `x-user-group-id` string, nullable
- `x-timezone` string, nullable

## Response `200`

Successful Response

- ChartDescriptor[]
  - `name` string, required
  - `label` string, required
  - `dataset` string, required
  - `chart_type` string, required
  - `x` string, required
  - `series` string[], required
  - `stacked` boolean, required
  - `filters` FilterDescriptor[], required
    - `key` string, required
    - `label` string, required
    - `listable` boolean, required
    - `options` OptionDescriptor[], nullable
      - `value` string, required
      - `label` string, nullable
    - `required` boolean
    - `comparison` boolean
    - `comparison_default` string
  - `related` RelatedDescriptor, required: Wire form of `apps.catalog.relations.RelatedNames` — the symmetrised page-affinity edges of one dataset/chart/summary, split by kind. This module owns no catalog lookups (see the module docstring's import rules), so nothing here builds a `RelatedDescriptor` from a `RelatedNames` — that projection lives in `apps.api.serializers`, the layer that already resolves `apps.catalog.RELATIONS`.
    - `datasets` string[], required
    - `charts` string[], required
    - `summaries` string[], required
  - `reference` ReferenceLineDescriptor, required
    - `of` string, nullable, required
    - `percentile` number, nullable, required
    - `label` string, required
    - `color` PaletteColorDescriptor, required: Wire form of `apps.specs.palette.PaletteColor` — a color stepped per surface. Colors live ONLY in descriptors; the frontend never hardcodes a chart color.
      - `light` string, required
      - `dark` string, required
    - `value` number, nullable
  - `series_colors` object, required
  - `series_from` string, nullable
  - `show_change` boolean
  - `show_total` boolean
  - `show_zero` boolean
  - `caption` string, nullable
  - `stack_offset` string
  - `secondary_axis_series` string[]
  - `estimate_pairs` EstimatePairDescriptor[]
    - `actual` string, required
    - `estimate` string, required
  - `tooltip_series` string[]
  - `tooltip_estimate_pairs` EstimatePairDescriptor[]
    - `actual` string, required
    - `estimate` string, required
  - `tooltip_decomposes` string, nullable

## Other responses

- `403`: Not supported for public user
- `422`: Validation Error

## Changes

- **2026-10-14** `1b2d675195d7`: 3 info
  - added the optional property `items/caption` to the response with the `200` status
  - added the optional property `items/show_total` to the response with the `200` status
  - added the optional property `items/show_zero` to the response with the `200` status
- **2026-10-07** `b4beb9e80982`: 2 info
  - added the optional property `items/secondary_axis_series` to the response with the `200` status
  - added the optional property `items/stack_offset` to the response with the `200` status
- **2026-09-24** `eb8306fa77dd`: 2 info
  - added the optional property `items/filters/items/comparison` to the response with the `200` status
  - added the optional property `items/filters/items/comparison_default` to the response with the `200` status
- **2026-09-04** `51aa5d004c49`: 3 info
  - added the optional property `items/tooltip_decomposes` to the response with the `200` status
  - added the optional property `items/tooltip_estimate_pairs` to the response with the `200` status
  - added the optional property `items/tooltip_series` to the response with the `200` status
- **2026-09-02** `fcb62c79da95`: 2 info
  - added the optional property `items/estimate_pairs` to the response with the `200` status
  - added the optional property `items/filters/items/required` to the response with the `200` status

[Operation history](https://skmtc.dev/myaltimate/apis/myaltimate-api/changes/api/v2/charts/get.md)

---

[API](https://skmtc.dev/myaltimate/apis/myaltimate-api.md) - [All operations](https://skmtc.dev/myaltimate/apis/myaltimate-api/llms.txt) - [OpenAPI document](https://skmtc.dev/myaltimate/apis/myaltimate-api/revisions/727657ce54e9?raw)