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

# List views

`GET /v1/views`

## Request

- Base URL: `https://api.folk.app`
- URL: `https://api.folk.app/v1/views`
- Auth: HTTP bearer

Returns the views of the groups the user can access, then the user's personal views, in the order of the app's sidebar.

## Query parameters

- `limit` integer
- `cursor` string
- `combinator` 'and' | 'or'
- `filter` object

## Response `200`

A paginated list of views. The `data.items` field contains the list of views, and the `data.pagination.nextLink` field contains a link to the next page of results, if available.

- object
  - `data` object, required
    - `items` View[], required
      - union: A view of a group, or a personal view of the user. Its settings depend on its `type`: `sort` for table views, `groupBy` and `columns` for kanban views.
        - TableView: A view displaying the entities as rows.
          - `id` string, required
          - `groupId` string, nullable, required: The group the view belongs to, `null` for personal views, which belong to no group.
          - `name` string, required
          - `entityType` string, required: The entity type of the view: `person`, `company`, or the name of an object type of the group.
          - `filter` object, nullable, required: The filter of the view, `null` when the view has no filter. Unlike the search endpoints, the filter is a list of conditions.
            - `combinator` 'and' | 'or', required: The logical operator combining the conditions.
            - `conditions` object[], required: The conditions of the filter, in order. The same field can appear in several conditions.
              - …
          - `visibleFields` string[], required: The fields shown by the view, in display order, with the same keys as the filter. The name column is always shown and never listed.
          - `position` object, required: The position of the view in the list of views of its group, or among the user's personal views, as in the app's sidebar.
            - `after` string, nullable, required: The id of the view just before this one in its group, or among the personal views, `null` for the first view.
          - `createdAt` string, date-time, required
          - `createdBy` object, nullable, required: The user who created the view, `null` when it was created by folk.
            - `id` string, required
            - `fullName` string, required
            - `email` string, required
          - `type` 'table', required
          - `sort` object, required: The sort of the view. When the sorted field no longer exists, the default sort of the entity type is returned.
            - `field` string, required
            - `direction` 'asc' | 'desc', required
        - KanbanView: A view displaying the entities as cards, in columns.
          - `id` string, required
          - `groupId` string, nullable, required: The group the view belongs to, `null` for personal views, which belong to no group.
          - `name` string, required
          - `entityType` string, required: The entity type of the view: `person`, `company`, or the name of an object type of the group.
          - `filter` object, nullable, required: The filter of the view, `null` when the view has no filter. Unlike the search endpoints, the filter is a list of conditions.
            - `combinator` 'and' | 'or', required: The logical operator combining the conditions.
            - `conditions` object[], required: The conditions of the filter, in order. The same field can appear in several conditions.
              - …
          - `visibleFields` string[], required: The fields shown by the view, in display order, with the same keys as the filter. The name column is always shown and never listed.
          - `position` object, required: The position of the view in the list of views of its group, or among the user's personal views, as in the app's sidebar.
            - `after` string, nullable, required: The id of the view just before this one in its group, or among the personal views, `null` for the first view.
          - `createdAt` string, date-time, required
          - `createdBy` object, nullable, required: The user who created the view, `null` when it was created by folk.
            - `id` string, required
            - `fullName` string, required
            - `email` string, required
          - `type` 'kanban', required
          - `groupBy` string, required: The single select field the columns come from.
          - `columns` object[], required: The columns, in display order: one per option of the `groupBy` field, plus the "No value" column.
            - `option` string, nullable, required: The label of the option of the `groupBy` field, `null` for the "No value" column.
            - `hidden` boolean, required
    - `pagination` object, required
      - `nextLink` string
  - `deprecations` string[]

## Other responses

- `400`: The request was unacceptable, often due to missing an invalid parameter.
- `401`: No valid API key provided.
- `403`: The API key doesn’t have permissions to perform the request.
- `404`: The requested resource doesn’t exist.
- `422`: The request was unacceptable, often due to missing or invalid parameters.
- `429`: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.
- `500`: Something went wrong on our end.
- `503`: The server is overloaded or down for maintenance.

## Changes

- **2026-11-03** `c6818f3ba60d`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/folk/apis/folk-external-api/changes/v1/views/get.md)

---

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