FOfolk
Views

Create a view

Changed on

Create a view in a group: a table view, or a kanban view grouped by a single select field. The settings that aren't sent get the defaults of the entity type and the view type.

post/v1/views

Request

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

Headers

Idempotency-Keystring

A unique key, such as a UUID, that makes retrying this request safe: a retry with the same key and body returns the original response without running the operation again. Keys are kept for 24 hours after the request completes.

Example:8e03978e-40d5-43e8-bc93-6894a57f9324

Request body

OR

Example request

{
  "groupId": "grp_92ab3f1c-0386-434d-82d7-a91eb6badd71",
  "entityType": "person",
  "filter": {
    "conditions": [
      {
        "field": "jobTitle",
        "operator": "like"
      }
    ]
  },
  "visibleFields": [
    "jobTitle",
    "companies",
    "emails"
  ],
  "sort": {
    "field": "interactionMetadata.user.lastInteractedAt"
  }
}

Response

The created view.

deprecationsstring[]

Example response

{
  "data": {
    "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"
    }
  },
  "deprecations": [
    "This field is deprecated"
  ]
}

Changes