FOfolk
Views

List views

Changed on

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

get/v1/views

Request

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

Query parameters

limitinteger

The number of items to return.

cursorstring

A cursor for pagination across multiple pages of results. Don’t include this parameter on the first call. Use the pagination.nextLink value returned in a previous response to request subsequent results.

combinator'and' | 'or'

The logical operator to combine multiple filters.

filterobject

A record of filters to apply, following the format filter[attribute][operator]=value. Filterable attributes: groupId (eq, in), name (eq, like), entityType (eq, in: person, company or the name of an object type), type (eq: table, kanban). A groupId the user can not access returns no views.

Response

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.

deprecationsstring[]

Example response

{
  "data": {
    "items": [
      {
        "id": "viw_3f1c9a2e-0386-434d-82d7-a91eb6badd71",
        "groupId": "grp_92ab3f1c-0386-434d-82d7-a91eb6badd71",
        "name": "Hot leads",
        "entityType": "person",
        "filter": {
          "combinator": "and",
          "conditions": [
            {
              "field": "interactionMetadata.workspace.lastInteractedAt",
              "operator": "gt",
              "value": "30-days-ago"
            }
          ]
        },
        "visibleFields": [
          "jobTitle",
          "companies",
          "emails"
        ],
        "position": {
          "after": "viw_1b2c3d4e-0386-434d-82d7-a91eb6badd71"
        },
        "createdAt": "2025-07-17T09:00:00.000Z",
        "createdBy": {
          "id": "usr_bc984b3f-0386-434d-82d7-a91eb6badd71",
          "fullName": "John Doe",
          "email": "john.doe@example.com"
        },
        "type": "table",
        "sort": {
          "field": "interactionMetadata.user.lastInteractedAt",
          "direction": "desc"
        }
      },
      {
        "id": "viw_8e7d6c5b-0386-434d-82d7-a91eb6badd71",
        "groupId": "grp_92ab3f1c-0386-434d-82d7-a91eb6badd71",
        "name": "Pipeline",
        "entityType": "person",
        "filter": {
          "combinator": "and",
          "conditions": [
            {
              "field": "interactionMetadata.workspace.lastInteractedAt",
              "operator": "gt",
              "value": "30-days-ago"
            }
          ]
        },
        "visibleFields": [
          "jobTitle",
          "companies",
          "emails"
        ],
        "position": {
          "after": "viw_1b2c3d4e-0386-434d-82d7-a91eb6badd71"
        },
        "createdAt": "2025-07-17T09:00:00.000Z",
        "createdBy": {
          "id": "usr_bc984b3f-0386-434d-82d7-a91eb6badd71",
          "fullName": "John Doe",
          "email": "john.doe@example.com"
        },
        "type": "kanban",
        "groupBy": "customFieldValues.grp_92ab3f1c-0386-434d-82d7-a91eb6badd71.Stage",
        "columns": [
          {
            "option": "Lead",
            "hidden": false
          },
          {
            "option": "Qualified",
            "hidden": false
          },
          {
            "option": "Lost",
            "hidden": true
          },
          {
            "option": null,
            "hidden": false
          }
        ]
      }
    ],
    "pagination": {
      "nextLink": "https://api.folk.app/v1/views?limit=20&cursor=eyJvZmZzZXQiOjIwfQ%3D%3D"
    }
  },
  "deprecations": [
    "This field is deprecated"
  ]
}

Changes