---
title: "GET /v1/reports"
method: GET
path: "/v1/reports"
tags: ["reports"]
---

# GET /v1/reports

`GET /v1/reports`

## Request

- Base URL: `https://help.steep.app` (the document declares no server; this is the origin it was published from)
- URL: `https://help.steep.app/v1/reports`
- Auth: none declared

List reports in the workspace (metadata only, not content). Filter by creator, sharing, team, or metric; page with `limit` and `skip`. For keyword search use search reports; for full content use get report by `id`.

## Query parameters

- `limit` integer: Maximum number of reports to return.
- `skip` integer: Number of reports to skip, for paging.
- `createdBy` string: Only reports created by this user. Pass a workspace member's user `id` from list workspace members, or the literal `me` for the calling user (`me` requires a user token).
- `sharedWith` string: Only reports shared directly with this user, excluding reports they created. Pass a workspace member's user `id` from list workspace members, or the literal `me` for the calling user (`me` requires a user token). Cannot be combined with `teamId`.
- `teamId` string: Only reports shared with this team. Cannot be combined with `sharedWith`.
- `metricId` string: Only reports whose blocks reference this metric (chart, table, big-number or map blocks). Pass a metric `id` from list metrics, search metrics, or get metric by `id`. Use to find which reports reference a given metric.
- `sort` 'createdAt' | 'updatedAt': Field to sort by.
- `order` 'asc' | 'desc': Sort direction.

## Response `200`

Response for status 200

- object
  - `total` number, required
  - `limit` number, required
  - `skip` number, required
  - `data` object[], required
    - `id` string, required: Unique resource ID (opaque).
    - `title` string, required
    - `createdAt` string, date-time, required: When the report was created.
    - `updatedAt` string, date-time, required: When the report was last updated.
    - `author` object, required: The user who created the report. Null if the creator is unknown.
      - `id` string, required: The id of the user who created the report.
      - `name` unknown, required
    - `link` string, required: Link to the report in the Steep app.

## Other responses

- `401`: Response for status 401
- `403`: Response for status 403
- `422`: Response for status 422
- `429`: Response for status 429
- `500`: Response for status 500

---

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