---
title: "List Views"
method: GET
path: "/v3/views"
tags: ["Views"]
---

# List Views

`GET /v3/views`

**List views in the current environment, optionally filtered by the functions they read from.**

Views are tabular projections over `transformations` rows: each view names
one or more functions and a list of columns (JSON-pointer paths into
`extractedJson`), and produces a uniform table that can be filtered,
paginated, and aggregated.

Filters AND together when combined. Pagination is cursor-based on
`viewID`; default limit is 50, maximum 100.

## Query parameters

- `limit` integer
- `functionIDs` string[]
- `functionNames` string[]
- `viewIDs` string[]
- `sortOrder` 'asc' | 'desc'
- `startingAfter` string
- `endingBefore` string
- `viewNameSubstring` string

## Response `200`

The request has succeeded.

- ListViewsResponse — Response containing a list of views
  - `views` View[], required — Array of views
    - `viewID` string, required — Unique identifier of the view
    - `name` string, required — Name of the view
    - `description` string, nullable — Description of the view
    - `currentVersionNum` integer, required — Current version number of the view
    - `columns` ViewColumn[], required — List of columns in the view
      - `name` string, required — Name of the column
      - `valueSchemaPath` string[], required — JSON path to the value in the transformation output schema (e.g., ["invoiceDetails", "invoiceNumber"])
      - `displayOrderIndex` integer, required — Order in which this column should be displayed (0-based index)
    - `filters` ViewFilter[], required — List of filters applied to the view
      - `columnName` string, required — Name of the column to filter on
      - `filterType` 'equals_string' | 'equals_number' | 'less_than_number' | 'less_than_equal_number' | 'greater_than_number' | 'greater_than_equal_number' | 'is_null' | 'is_not_null', required — Type of filter to apply to a view column
      - `string` string, nullable — String value for the filter (required for string filter types)
      - `number` number, float, nullable — Numeric value for the filter (required for number filter types)
    - `aggregations` ViewAggregation[], required — List of aggregations defined for the view
      - `name` string, required — Name of the aggregation
      - `function` 'count' | 'count_distinct' | 'sum' | 'average' | 'min' | 'max', required — Aggregation function to apply to a view column
      - `aggregateColumnName` string, nullable — Name of the column to aggregate (required for count_distinct, sum, average, min, max functions)
      - `groupByColumnName` string, nullable — Name of the column to group by (optional, for grouped aggregations)
      - `displayType` 'table' | 'bar_chart' | 'pie_chart' — How to display the aggregation results
    - `functions` FunctionIdentifier[], required — List of functions that this view queries transformations from
      - `id` string — Unique identifier of function. Provide either id or name, not both.
      - `name` string — Name of function. Must be UNIQUE on a per-environment basis. Provide either id or name, not both.
  - `totalCount` integer, required — Total number of views matching the query

---

[API](https://skmtc.dev/bem-team/apis/bem-api.md) · [All operations](https://skmtc.dev/bem-team/apis/bem-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/bem-team/bem-api/revisions/a6e4624117c6/schema)