vCita Views API
The Views API from vCita — 3 operation(s) for views.
The Views API from vCita — 3 operation(s) for views.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/vcita:vcita-views-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Clients Views API
description: Unified OpenAPI specification for clients domain
version: '3.0'
x-generated:
sourceFiles:
- activity_sources.json
- 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_search
files:
- merged
- search.json
- type: schema
name: ErrorResponse
resolution: Renamed to ErrorResponse_notes
files:
- merged
- notes.json
totalPaths: 54
totalComponents: 27
servers:
- url: https://api.vcita.biz
description: Unified API Gateway server
tags:
- name: Views
paths:
/business/search/v1/views:
get:
summary: Get all views
description: '## Overview
Retrieve all views for the authenticated business.
## Authentication
**Available for Staff, App, and Directory Tokens.**'
parameters:
- name: pinned
in: query
description: Filter by displayed views
required: false
schema:
type: boolean
- 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:
views:
- uid: abc123def456
name: All Clients
description: View showing all active clients
view_type: client
level: account
columns:
- label: Client Name
type: ContactFullName
identifier: contact_full_name
sortable: true
sort_options: {}
- label: Email
type: Email
identifier: email
sortable: false
sort_options: {}
- label: Created At
type: CreationDate
identifier: created_at
sortable: true
sort_options: {}
filter: '[{"key":"fields_filter.first_name","label":"First Name","value":"John","type":"text"}]'
sorting_column: contact_full_name
sorting_direction: desc
order: 1
pinned: true
tags:
- Views
security: []
operationId: getBusinessSearchV1Views
x-operation-id-source: derived
post:
summary: Create a new view
description: '## Overview
Create 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: []
operationId: postBusinessSearchV1Views
x-operation-id-source: derived
/business/search/v1/views/bulk:
post:
summary: Bulk update views
description: '## Overview
Update multiple views in bulk - Update multiple views in bulk - 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:
message: Views updated successfully
tags:
- Views
requestBody:
content:
application/json:
schema:
type: object
properties:
views:
type: array
description: Array of view updates. Each item contains the view UID and the fields to update at the same level (flat structure, NOT nested under 'updates').
items:
type: object
properties:
uid:
type: string
description: View UID to update
x-reference-to: view
pinned:
type: boolean
description: Whether the view is displayed/pinned
order:
type: integer
description: View display order
name:
type: string
description: View name
required:
- uid
example:
- uid: view_uid_1
pinned: true
order: 1
- uid: view_uid_2
pinned: false
order: 2
name: Updated Name
required:
- views
security: []
operationId: postBusinessSearchV1ViewsBulk
x-operation-id-source: derived
/business/search/v1/views/{uid}:
delete:
summary: Delete a view
description: '## Overview
Delete a custom view - Delete a custom view - Available for **Staff, App, and Directory Tokens**.'
parameters:
- name: uid
in: path
required: true
description: View UID
schema:
type: string
- 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:
message: View deleted successfully
tags:
- Views
security: []
operationId: deleteBusinessSearchV1ViewsByUid
x-operation-id-source: derived
get:
summary: Get a specific view
description: '## Overview
Retrieve a specific view by UID.
## Authentication
**Available for Staff, App, and Directory Tokens.**'
parameters:
- name: uid
in: path
required: true
description: View UID
schema:
type: string
- name: type
in: query
required: false
description: View type (system or custom)
schema:
type: string
enum:
- system
- custom
- 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: abc123def456
name: All Clients
description: View showing all active clients
view_type: client
level: account
columns:
- label: Client Name
type: ContactFullName
identifier: contact_full_name
sortable: true
sort_options: {}
- label: Email
type: Email
identifier: email
sortable: false
sort_options: {}
filter: '[{"key":"fields_filter.first_name","label":"First Name","value":"John","type":"text"}]'
sorting_column: contact_full_name
sorting_direction: desc
order: 1
pinned: true
tags:
- Views
security: []
operationId: getBusinessSearchV1ViewsByUid
x-operation-id-source: derived
put:
summary: Update a view
description: '## Overview
Update an existing view - Available for **Staff, App, and Directory Tokens**.
## Request Body Requirements
The `view` object must contain **at least one updatable field** (e.g., `name`, `level`, `columns`, `filter`, `description`, `order`, `pinned`). Sending an empty view object will result in no changes being made.
## Updatable Fields
- `name`: View name
- `description`: View description
- `level`: View visibility level (''account'' or ''staff'')
- `columns`: Array of column definitions
- `filter`: Filter configuration (JSON string)
- `sorting_column`: Column to sort by
- `sorting_direction`: Sort direction (''asc'' or ''desc'')
- `order`: Display order
- `pinned`: Whether the view is displayed/pinned'
parameters:
- name: uid
in: path
required: true
description: View UID
schema:
type: string
- 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: abc123def456
name: Updated View Name
description: Updated description
view_type: client
level: staff
columns:
- label: Client Name
type: ContactFullName
identifier: contact_full_name
sortable: true
sort_options: {}
- label: Tags
type: Tags
identifier: tags
sortable: false
sort_options: {}
filter: '[{"key":"tags_filter","label":"Tags","value":["important"],"type":"tags"}]'
sorting_column: contact_full_name
sorting_direction: asc
order: 2
pinned: false
tags:
- Views
requestBody:
content:
application/json:
schema:
type: object
properties:
view:
type: object
description: View object containing at least one updatable field. Cannot be empty.
minProperties: 1
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.
name:
type: string
description: View name
description:
type: string
description: View description
columns:
type: array
items:
$ref: '#/components/schemas/ViewColumn'
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 "[]").
x-reference-to: view_filter
sorting_column:
type: string
description: Column to sort by
sorting_direction:
type: string
enum:
- asc
- desc
description: Sort direction
order:
type: integer
description: View display order
pinned:
type: boolean
description: Whether the view is displayed/pinned
required:
- view
security: []
operationId: putBusinessSearchV1ViewsByUid
x-operation-id-source: derived
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
securitySchemes:
ActivitySources:
type: http
scheme: bearer
description: 'Provide a valid bearer token in the Authorization header. Example: ''Authorization: Bearer {token}'''
Bearer:
type: http
scheme: bearer
bearerFormat: JWT
description: 'Provide a valid bearer token in the Authorization header. Example: ''Authorization: Bearer {app_token}'''
Notes:
type: http
scheme: bearer
bearerFormat: JWT
description: 'Provide a valid bearer token in the Authorization header. Example: ''Authorization: Bearer {token}'''
ClientMessaging:
type: http
scheme: bearer
bearerFormat: JWT
description: 'Provide a valid client bearer token in the Authorization header. Example: ''Authorization: Bearer {client_token}'''
x-provenance:
method: searched
source: https://developers.intandem.tech:443/reference
harvested: '2026-11-15'
tool: harvest-readme-openapi.py
note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
assembled_from:
- https://developers.intandem.tech/reference/bulkupdateclients.md
- https://developers.intandem.tech/reference/createactivitysource.md
- https://developers.intandem.tech/reference/delete_business-clients-v1-matters-matter-uid-collaborators-staff-uid.md
- https://developers.intandem.tech/reference/delete_business-clients-v1-matters-matter-uid-notes-note-uid.md
- https://developers.intandem.tech/reference/delete_business-clients-v1-matters-matter-uid-tags.md
- https://developers.intandem.tech/reference/delete_business-clients-v1-tags.md
- https://developers.intandem.tech/reference/delete_business-search-v1-views-uid.md
- https://developers.intandem.tech/reference/delete_platform-v1-clients-client-id.md
- https://developers.intandem.tech/reference/delete_platform-v1-fields-field-id.md
- https://developers.intandem.tech/reference/delete_v3-clients-client-notes-uid.md
- https://developers.intandem.tech/reference/get_business-clients-v1-contacts-client-uid-matters.md
- https://developers.intandem.tech/reference/get_business-clients-v1-matters-matter-uid-collaborators.md
- https://developers.intandem.tech/reference/get_business-clients-v1-matters-matter-uid-notes-note-uid.md
- https://developers.intandem.tech/reference/get_business-clients-v1-matters-matter-uid-notes.md
- https://developers.intandem.tech/reference/get_business-clients-v1-matters-matter-uid-tags.md
- https://developers.intandem.tech/reference/get_business-clients-v1-matters-uid.md
- https://developers.intandem.tech/reference/get_business-clients-v1-matters.md
- https://developers.intandem.tech/reference/get_business-clients-v1-settings.md
- https://developers.intandem.tech/reference/get_business-search-v1-view-filters.md
- https://developers.intandem.tech/reference/get_business-search-v1-views-columns.md
- https://developers.intandem.tech/reference/get_business-search-v1-views-uid.md
- https://developers.intandem.tech/reference/get_business-search-v1-views.md
- https://developers.intandem.tech/reference/get_client-payments-v1-apps-primary-provider-connected-application.md
- https://developers.intandem.tech/reference/get_client-payments-v1-cards-get-new-card.md
- https://developers.intandem.tech/reference/get_client-payments-v1-carts-cart-uid.md
- https://developers.intandem.tech/reference/get_client-payments-v1-client-packages.md
- https://developers.intandem.tech/reference/get_client-payments-v1-deposits-deposit-uid.md
- https://developers.intandem.tech/reference/get_client-payments-v1-deposits.md
- https://developers.intandem.tech/reference/get_client-payments-v1-invoices.md
- https://developers.intandem.tech/reference/get_client-payments-v1-packages-package-id.md
- https://developers.intandem.tech/reference/get_client-payments-v1-packages.md
- https://developers.intandem.tech/reference/get_client-payments-v1-payment-requests-payment-request-uid-checkout.md
- https://developers.intandem.tech/reference/get_client-payments-v1-payment-requests.md
- https://developers.intandem.tech/reference/get_client-payments-v1-payments.md
- https://developers.intandem.tech/reference/get_client-payments-v1-product-orders.md
- https://developers.intandem.tech/reference/get_platform-v1-clients-client-id-estimates.md
- https://developers.intandem.tech/reference/get_platform-v1-clients-client-id-invoices.md
- https://developers.intandem.tech/reference/get_platform-v1-clients-client-id-payments.md
- https://developers.intandem.tech/reference/get_platform-v1-clients-client-id.md
- https://developers.intandem.tech/reference/get_platform-v1-clients-merges-possible-merge-master.md
- https://developers.intandem.tech/reference/get_platform-v1-clients-payment-client-packages-validate.md
- https://developers.intandem.tech/reference/get_platform-v1-clients.md
- https://developers.intandem.tech/reference/get_platform-v1-fields-field-id.md
- https://developers.intandem.tech/reference/get_platform-v1-fields.md
- https://developers.intandem.tech/reference/get_v2-search.md
- https://developers.intandem.tech/reference/get_v3-clients-client-notes-uid.md
- https://developers.intandem.tech/reference/get_v3-clients-client-notes.md
- https://developers.intandem.tech/reference/get_v3-clients-client-settings-client-uid.md
- https://developers.intandem.tech/reference/getactivitysource.md
- https://developers.intandem.tech/reference/listactivitysources.md
- https://developers.intandem.tech/reference/post_business-clients-v1-apps-app-code-name-import.md
- https://developers.intandem.tech/reference/post_business-clients-v1-contacts-client-uid-matters.md
- https://developers.intandem.tech/reference/post_business-clients-v1-matters-matter-uid-collaborators.md
- https://developers.intandem.tech/reference/post_business-clients-v1-matters-matter-uid-notes.md
- https://developers.intandem.tech/reference/post_business-clients-v1-matters-matter-uid-tags.md
- https://developers.intandem.tech/reference/post_business-search-v1-views-bulk.md
- https://developers.intandem.tech/reference/post_business-search-v1-views.md
- https://developers.intandem.tech/reference/post_client-messaging-v1-messages.md
- https://developers.intandem.tech/reference/post_client-payments-v1-cards-save-card-session.md
- https://developers.intandem.tech/reference/post_client-payments-v1-cards.md
- https://developers.intandem.tech/reference/post_client-payments-v1-carts.md
- https://developers.intandem.tech/reference/post_platform-v1-clients-payment-client-packages-update-usage.md
- https://developers.intandem.tech/reference/post_platform-v1-clients.md
- https://developers.intandem.tech/reference/post_platform-v1-fields.md
- https://developers.intandem.tech/reference/post_v3-clients-client-notes.md
- https://developers.intandem.tech/reference/put_business-clients-v1-matters-matter-uid-nest.md
- https://developers.intandem.tech/reference/put_business-clients-v1-matters-matter-uid-notes-note-uid.md
- https://developers.intandem.tech/reference/put_business-clients-v1-matters-matter-uid-reassign.md
- https://developers.intandem.tech/reference/put_business-clients-v1-matters-uid.md
- https://developers.intandem.tech/reference/put_business-clients-v1-settings.md
- https://developers.intandem.tech/reference/put_business-clients-v1-tags.md
- https://developers.intandem.tech/reference/put_business-search-v1-views-uid.md
- https://developers.intandem.tech/reference/put_platform-v1-clients-client-id.md
- https://developers.intandem.tech/reference/put_platform-v1-clients-merges-merge-clients.md
# --- truncated at 32 KB (39 KB total) ---
# Full source: https://artifacts.apis.io/vcita/openapi/vcita-views-api-openapi.yml