---
updatedAt: 2026-04-28T16:08:28.000Z
agentTools:
  projectIndex: https://developers.intandem.tech/llms.txt
---

# Create a new view

## Overview
Create a new custom view - Create a new custom view - Available for **Staff, App, and Directory Tokens**.

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Clients",
    "description": "Unified OpenAPI specification for clients domain",
    "version": "3.0",
    "x-generated": {
      "sourceFiles": [
        "legacy_v1_platform_clients.json",
        "search.json",
        "legacy_v1_clients.json",
        "manage_clients.json",
        "client_settings.json",
        "notes.json",
        "clients_payments.json",
        "client_messaging.json",
        "crm_views.json"
      ],
      "pathNormalizations": [
        {
          "file": "legacy_v1_platform_clients.json",
          "basePath": "/platform/v1",
          "transformations": [
            {
              "original": "/fields",
              "normalized": "/platform/v1/fields",
              "basePath": "/platform/v1"
            },
            {
              "original": "/fields/{field_id}",
              "normalized": "/platform/v1/fields/{field_id}",
              "basePath": "/platform/v1"
            }
          ]
        },
        {
          "file": "legacy_v1_clients.json",
          "basePath": "/platform/v1",
          "transformations": [
            {
              "original": "/clients",
              "normalized": "/platform/v1/clients",
              "basePath": "/platform/v1"
            },
            {
              "original": "/clients/bulk",
              "normalized": "/platform/v1/clients/bulk",
              "basePath": "/platform/v1"
            },
            {
              "original": "/clients/merges/merge_clients",
              "normalized": "/platform/v1/clients/merges/merge_clients",
              "basePath": "/platform/v1"
            },
            {
              "original": "/clients/merges/possible_merge_master",
              "normalized": "/platform/v1/clients/merges/possible_merge_master",
              "basePath": "/platform/v1"
            },
            {
              "original": "/clients/payment/client_packages/update_usage",
              "normalized": "/platform/v1/clients/payment/client_packages/update_usage",
              "basePath": "/platform/v1"
            },
            {
              "original": "/clients/payment/client_packages/validate",
              "normalized": "/platform/v1/clients/payment/client_packages/validate",
              "basePath": "/platform/v1"
            },
            {
              "original": "/clients/{client_id}",
              "normalized": "/platform/v1/clients/{client_id}",
              "basePath": "/platform/v1"
            },
            {
              "original": "/clients/{client_id}/estimates",
              "normalized": "/platform/v1/clients/{client_id}/estimates",
              "basePath": "/platform/v1"
            },
            {
              "original": "/clients/{client_id}/invoices",
              "normalized": "/platform/v1/clients/{client_id}/invoices",
              "basePath": "/platform/v1"
            },
            {
              "original": "/clients/{client_id}/payments",
              "normalized": "/platform/v1/clients/{client_id}/payments",
              "basePath": "/platform/v1"
            }
          ]
        },
        {
          "file": "manage_clients.json",
          "basePath": "/business/clients",
          "transformations": [
            {
              "original": "/v1/apps/{app_code_name}/import",
              "normalized": "/business/clients/v1/apps/{app_code_name}/import",
              "basePath": "/business/clients"
            },
            {
              "original": "/v1/contacts/{client_uid}/matters",
              "normalized": "/business/clients/v1/contacts/{client_uid}/matters",
              "basePath": "/business/clients"
            },
            {
              "original": "/v1/matters",
              "normalized": "/business/clients/v1/matters",
              "basePath": "/business/clients"
            },
            {
              "original": "/v1/matters/{matter_uid}/collaborators",
              "normalized": "/business/clients/v1/matters/{matter_uid}/collaborators",
              "basePath": "/business/clients"
            },
            {
              "original": "/v1/matters/{matter_uid}/collaborators/{staff_uid}",
              "normalized": "/business/clients/v1/matters/{matter_uid}/collaborators/{staff_uid}",
              "basePath": "/business/clients"
            },
            {
              "original": "/v1/matters/{matter_uid}/nest",
              "normalized": "/business/clients/v1/matters/{matter_uid}/nest",
              "basePath": "/business/clients"
            },
            {
              "original": "/v1/matters/{matter_uid}/notes",
              "normalized": "/business/clients/v1/matters/{matter_uid}/notes",
              "basePath": "/business/clients"
            },
            {
              "original": "/v1/matters/{matter_uid}/notes/{note_uid}",
              "normalized": "/business/clients/v1/matters/{matter_uid}/notes/{note_uid}",
              "basePath": "/business/clients"
            },
            {
              "original": "/v1/matters/{matter_uid}/reassign",
              "normalized": "/business/clients/v1/matters/{matter_uid}/reassign",
              "basePath": "/business/clients"
            },
            {
              "original": "/v1/tags",
              "normalized": "/business/clients/v1/tags",
              "basePath": "/business/clients"
            },
            {
              "original": "/v1/matters/{matter_uid}/tags",
              "normalized": "/business/clients/v1/matters/{matter_uid}/tags",
              "basePath": "/business/clients"
            },
            {
              "original": "/v1/matters/{uid}",
              "normalized": "/business/clients/v1/matters/{uid}",
              "basePath": "/business/clients"
            },
            {
              "original": "/v1/settings",
              "normalized": "/business/clients/v1/settings",
              "basePath": "/business/clients"
            }
          ]
        },
        {
          "file": "clients_payments.json",
          "basePath": "/client/payments",
          "transformations": [
            {
              "original": "/v1/apps/primary_provider_connected_application",
              "normalized": "/client/payments/v1/apps/primary_provider_connected_application",
              "basePath": "/client/payments"
            },
            {
              "original": "/v1/cards",
              "normalized": "/client/payments/v1/cards",
              "basePath": "/client/payments"
            },
            {
              "original": "/v1/cards/get_new_card",
              "normalized": "/client/payments/v1/cards/get_new_card",
              "basePath": "/client/payments"
            },
            {
              "original": "/v1/cards/save_card_session",
              "normalized": "/client/payments/v1/cards/save_card_session",
              "basePath": "/client/payments"
            },
            {
              "original": "/v1/carts",
              "normalized": "/client/payments/v1/carts",
              "basePath": "/client/payments"
            },
            {
              "original": "/v1/carts/{cart_uid}",
              "normalized": "/client/payments/v1/carts/{cart_uid}",
              "basePath": "/client/payments"
            },
            {
              "original": "/v1/client_packages",
              "normalized": "/client/payments/v1/client_packages",
              "basePath": "/client/payments"
            },
            {
              "original": "/v1/deposits",
              "normalized": "/client/payments/v1/deposits",
              "basePath": "/client/payments"
            },
            {
              "original": "/v1/deposits/{deposit_uid}",
              "normalized": "/client/payments/v1/deposits/{deposit_uid}",
              "basePath": "/client/payments"
            },
            {
              "original": "/v1/invoices",
              "normalized": "/client/payments/v1/invoices",
              "basePath": "/client/payments"
            },
            {
              "original": "/v1/packages",
              "normalized": "/client/payments/v1/packages",
              "basePath": "/client/payments"
            },
            {
              "original": "/v1/packages/{package_id}",
              "normalized": "/client/payments/v1/packages/{package_id}",
              "basePath": "/client/payments"
            },
            {
              "original": "/v1/payment_requests",
              "normalized": "/client/payments/v1/payment_requests",
              "basePath": "/client/payments"
            },
            {
              "original": "/v1/payment_requests/{payment_request_uid}/checkout",
              "normalized": "/client/payments/v1/payment_requests/{payment_request_uid}/checkout",
              "basePath": "/client/payments"
            },
            {
              "original": "/v1/payments",
              "normalized": "/client/payments/v1/payments",
              "basePath": "/client/payments"
            },
            {
              "original": "/v1/product_orders",
              "normalized": "/client/payments/v1/product_orders",
              "basePath": "/client/payments"
            }
          ]
        },
        {
          "file": "client_messaging.json",
          "basePath": "/client/messaging",
          "transformations": [
            {
              "original": "/v1/messages",
              "normalized": "/client/messaging/v1/messages",
              "basePath": "/client/messaging"
            }
          ]
        },
        {
          "file": "crm_views.json",
          "basePath": "/business/search/v1",
          "transformations": [
            {
              "original": "/views",
              "normalized": "/business/search/v1/views",
              "basePath": "/business/search/v1"
            },
            {
              "original": "/views/{uid}",
              "normalized": "/business/search/v1/views/{uid}",
              "basePath": "/business/search/v1"
            },
            {
              "original": "/views/bulk",
              "normalized": "/business/search/v1/views/bulk",
              "basePath": "/business/search/v1"
            },
            {
              "original": "/views_columns",
              "normalized": "/business/search/v1/views_columns",
              "basePath": "/business/search/v1"
            },
            {
              "original": "/view_filters",
              "normalized": "/business/search/v1/view_filters",
              "basePath": "/business/search/v1"
            }
          ]
        }
      ],
      "pathConflicts": [],
      "componentConflicts": [
        {
          "type": "schema",
          "name": "ErrorResponse",
          "resolution": "Renamed to ErrorResponse_notes",
          "files": [
            "merged",
            "notes.json"
          ]
        }
      ],
      "totalPaths": 52,
      "totalComponents": 24
    }
  },
  "servers": [
    {
      "url": "https://api.vcita.biz",
      "description": "Unified API Gateway server"
    }
  ],
  "paths": {
    "/business/search/v1/views": {
      "post": {
        "summary": "Create a new view",
        "description": "## Overview\nCreate a new custom view - Create a new custom view - Available for **Staff, App, and Directory Tokens**.",
        "parameters": [
          {
            "name": "Authorization",
            "in": "header",
            "description": "The format of the API authorization header should be: 'Authorization': \"Bearer API_TOKEN\"",
            "required": true,
            "x-example": "Bearer abc...123",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "example": {
                  "success": true,
                  "data": {
                    "view": {
                      "uid": "new456abc789",
                      "name": "Custom Client View",
                      "description": "My custom view for clients",
                      "view_type": "client",
                      "level": "staff",
                      "columns": [
                        {
                          "label": "Client Name",
                          "type": "ContactFullName",
                          "identifier": "contact_full_name",
                          "sortable": true,
                          "sort_options": {}
                        },
                        {
                          "label": "Phone",
                          "type": "Phone",
                          "identifier": "phone",
                          "sortable": false,
                          "sort_options": {}
                        }
                      ],
                      "filter": "[]",
                      "sorting_column": "contact_full_name",
                      "sorting_direction": "asc",
                      "order": 5,
                      "pinned": false
                    }
                  }
                }
              }
            }
          }
        },
        "tags": [
          "Views"
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "view": {
                    "type": "object",
                    "properties": {
                      "level": {
                        "type": "string",
                        "enum": [
                          "account",
                          "staff"
                        ],
                        "description": "View level. 'account' level views are visible to all staff members in the business, while 'staff' level views are private to the creating staff member."
                      },
                      "view_type": {
                        "type": "string",
                        "enum": [
                          "client"
                        ],
                        "description": "Type of view. Currently only 'client' views are supported."
                      },
                      "columns": {
                        "type": "array",
                        "items": {
                          "$ref": "#/components/schemas/ViewColumn"
                        },
                        "description": "Array of column definitions"
                      },
                      "sorting_column": {
                        "type": "string",
                        "enum": [
                          "matter_name_tokenized.raw",
                          "last_client_activity",
                          "first_name.raw",
                          "created_at",
                          "matter_name",
                          "photo_path",
                          "last_activity_time",
                          "contact_full_name",
                          "review_score",
                          "last_interaction"
                        ],
                        "description": "Column to sort by. Must be one of the allowed sorting column values."
                      },
                      "sorting_direction": {
                        "type": "string",
                        "enum": [
                          "asc",
                          "desc"
                        ],
                        "description": "Sort direction (asc or desc)"
                      },
                      "filter": {
                        "type": "string",
                        "description": "Filter configuration as a JSON-encoded string. Must be a valid JSON string that parses to either an object or array (e.g., \"{}\" or \"[]\"). Example: \"[{\\\"key\\\":\\\"fields_filter.first_name\\\",\\\"value\\\":\\\"John\\\"}]\"",
                        "x-reference-to": "view_filter"
                      },
                      "name": {
                        "type": "string",
                        "description": "View name"
                      },
                      "description": {
                        "type": "string",
                        "description": "View description"
                      },
                      "order": {
                        "type": "integer",
                        "description": "View order"
                      }
                    },
                    "required": [
                      "level",
                      "view_type",
                      "columns",
                      "sorting_column",
                      "sorting_direction",
                      "filter",
                      "name",
                      "description",
                      "order"
                    ]
                  }
                },
                "required": [
                  "view"
                ]
              }
            }
          }
        },
        "security": []
      }
    }
  },
  "components": {
    "schemas": {
      "ViewColumn": {
        "type": "object",
        "properties": {
          "label": {
            "type": "string",
            "description": "Column label"
          },
          "type": {
            "type": "string",
            "description": "Column type"
          },
          "identifier": {
            "type": "string",
            "description": "Column identifier"
          },
          "sortable": {
            "type": "boolean",
            "description": "Whether column is sortable"
          },
          "sort_options": {
            "type": "object",
            "description": "Sort options for the column"
          }
        },
        "required": [
          "label",
          "type",
          "identifier",
          "sortable"
        ]
      }
    }
  }
}
```