vCita Clients API
The Clients API from vCita — 3 operation(s) for clients.
The Clients API from vCita — 3 operation(s) for clients.
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-clients-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 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: Clients
paths:
/platform/v1/clients:
get:
description: '## Overview
Retrieves a paginated list of clients for the business. Supports searching by various attributes and filtering by update timestamp.
## Authentication
**Available for Staff, App, and Directory Tokens.**
Directory tokens require the `X-On-Behalf-Of` header with the target business UID. The endpoint is business-scoped, and a directory token carries no business context on its own — without this header no business can be resolved and the request cannot return clients. The target business must belong to the directory, otherwise the request is rejected as unauthorized.'
parameters:
- description: Search Term
in: query
name: search_term
required: false
schema:
type: string
- description: Search By - email/uid/phone/updated_at
in: query
name: search_by
required: false
schema:
type: string
- description: 'Specify the updated_at filter range, available operators for updated_at: gte, lte. example: updated_at[gte]=2019-01-01'
in: query
name: updated_at
required: false
schema:
type: string
- description: 'Page number of results. Default: 1'
in: query
name: page
required: false
schema:
type: integer
- description: 'How many items to return per page. Default: 25. Max: 100'
in: query
name: per_page
required: false
schema:
type: integer
- description: Business UID to act on behalf of. Required for Directory tokens.
in: header
name: X-On-Behalf-Of
required: false
schema:
type: string
responses:
'200':
description: Success - Returns list of clients matching the search criteria
content:
application/json:
example:
data:
clients:
- address: My Hourse, bellvue, seattle, wasinton
business_uid: b1ed52cb3c5a6f87
campaign: Source Campaign
channel: Source Channel
created_at: '2025-08-05T06:56:27Z'
custom_field1: value1
custom_field2: value2
custom_field3: value3
customer_status: lead
email: clientemail@mail.com
first_name: First Name
id: czpvt3f246p4cw9i
last_name: Last Name
mobile_phone: '+16378383489'
normalized_phone: null
opt_in: '1'
source: Client Portal
source_url: Source URL
tags: []
updated_at: '2025-08-05T06:56:27Z'
status: OK
'422':
description: Unprocessable Entity - Invalid request parameters
'429':
description: Too Many Requests - Rate limit exceeded for this business
summary: Get Clients
tags:
- Clients
x-amazon-apigateway-auth:
type: NONE
x-amazon-apigateway-integration:
httpMethod: GET
responses:
default:
statusCode: '200'
type: http_proxy
uri: https:///platform/v1/clients
x-auth-type: Application & Application User
security:
- Bearer: []
operationId: getPlatformV1Clients
x-operation-id-source: derived
post:
description: '## Overview
Creates a new client record for the business. If a client with the same email already exists, returns a 409 Conflict error.
## Authentication
**Available for Staff, App, and Directory Tokens.**'
parameters: []
responses:
'201':
description: Success
content:
application/json:
example:
data:
client:
address: Some big house in Hollywood 9
created_at: '2025-08-05T06:56:28Z'
customer_status: customer
email: michael.douglass@spartacus.info.fake
first_name: Michael
id: fgrayekkrmqfzt7d
last_name: Douglas
mobile_phone: '+19083073848'
opt_in: null
source_data:
campaign: campaign
channel: channel
name: website
website_url: www.somesite.com
spam: false
tags:
- tag1
- tag2
updated_at: '2025-08-05T06:56:28Z'
token: eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdHlfdWlkIjoiZmdyYXlla2tybXFmenQ3ZCIsImV4dHJhIjp7ImJ1c2luZXNzX3VpZCI6ImIxZWQ1MmNiM2M1YTZmODcifSwiZXhwIjoxNzU2Nzk2MTg4LCJyZWZyZXNoIjoxNzU2Nzc2OTg4LCJjcmVhdGVkIjoxNzU0Mzc2OTg4LCJ0eXBlIjoiY2xpZW50IiwianRpIjoiZWQxNGY0MWViY2RlZGU1ODEyYjFkY2ZiZDBkMDE3MmI5ZThjODlhNGRlM2UzYmU1OTIyNGE4OWFmMmQ2OWU2NyJ9.D0OMzkIJ4sPAYuAduQxPRnu9_ScVCK-9Td1eROv8eSM
status: OK
summary: Create a Client
tags:
- Clients
x-amazon-apigateway-auth:
type: NONE
x-amazon-apigateway-integration:
httpMethod: POST
responses:
default:
statusCode: '201'
type: http_proxy
uri: https:///platform/v1/clients
x-auth-type: Application & Application User
requestBody:
content:
application/json:
schema:
properties:
address:
description: Address
type: string
custom_field1:
description: Custom Field 1
type: string
custom_field2:
description: Custom Field 2
type: string
custom_field3:
description: Custom Field 3
type: string
email:
description: Email Address. Must be a valid email format (e.g., user@example.com)
type: string
format: email
first_name:
description: First Name
type: string
last_name:
description: Last Name
type: string
opt_in:
description: Marketing email opt-in status. Accepts boolean values (`true` / `false`) or string values (`"1"` / `"0"`). When set to `true` (or `"1"`), the client is opted in to receive marketing emails; when set to `false` (or `"0"`), the client is opted out. This is distinct from `opt_in_transactional_sms`, which controls transactional SMS consent.
type: boolean
example: true
opt_in_transactional_sms:
description: Whether the client opts in to receive transactional SMS messages.
type: boolean
phone:
description: Phone Number
type: string
source_campaign:
description: Source campaign
type: string
source_channel:
description: Source channel
type: string
source_name:
description: Source name
type: string
source_url:
description: Source URL
type: string
staff_id:
description: Staff ID. Reference to the staff member (see staff entity).
type: string
x-reference-to: staff
status:
description: 'Use a client status to categorize clients according to their relationship with your business. Valid values: lead, customer, loyal, inactive'
type: string
enum:
- lead
- customer
- loyal
- inactive
tags:
description: The tag system is based on customized labels that you create, so you can sort your data using personalized words, phrases or themes that are meaningful to you and your business
type: string
required:
- first_name
type: object
security:
- Bearer: []
operationId: postPlatformV1Clients
x-operation-id-source: derived
/platform/v1/clients/bulk:
put:
description: '## Overview
Bulk update client marketing opt-in status for multiple clients in a single operation.
## Currently Supported Field
This endpoint currently supports updating **only** the `opt_in` field. Any request containing other fields will be rejected with a validation error.
## Field Format
- `opt_in` - Marketing opt-in status. Accepts:
- String values: `"1"` (opted-in) or `"0"` (opted-out)
- Boolean values: `true` or `false` (automatically converted to `"1"` or `"0"`)
## Limits
- Maximum 5000 clients per request
- All clients must belong to the authenticated business
- Duplicate client IDs are not allowed
- Additional rate limits apply per business
## Authentication
**Available for Staff, App, and Directory tokens.**
## Behavior
- Atomic operation - either all clients update successfully or the request fails
- If any client is not found or validation fails, no clients are updated
- If the business doesn''t have an opt-in field configured, returns success with `updated: false`'
operationId: bulkUpdateClients
parameters: []
responses:
'200':
description: Success - All clients updated, operation skipped (no opt-in field), or empty request
content:
application/json:
schema:
type: object
properties:
status:
type: string
example: OK
data:
type: object
properties:
updated:
type: boolean
description: True if clients were updated. False when opt-in field not configured or empty request.
count:
type: integer
description: Number of client records updated
message:
type: string
description: Human-readable status message
required:
- updated
- count
- message
example:
status: OK
data:
updated: true
count: 2
message: Clients updated successfully
'401':
description: Unauthorized - Invalid or missing authentication token
'422':
description: Validation error (invalid field, duplicates, exceeds max size, or clients not found)
content:
application/json:
schema:
type: object
properties:
status:
type: string
example: Error
error:
type: string
example: Only 'opt_in' field is allowed in bulk updates
summary: Bulk Update Clients
tags:
- Clients
x-amazon-apigateway-auth:
type: NONE
x-amazon-apigateway-integration:
httpMethod: PUT
responses:
default:
statusCode: '200'
type: http_proxy
uri: https:///platform/v1/clients/bulk
x-auth-type: Application & Application User
requestBody:
content:
application/json:
schema:
type: object
required:
- clients
properties:
clients:
type: array
description: Array of client updates. Maximum 5000 clients.
minItems: 1
maxItems: 5000
items:
type: object
required:
- id
- opt_in
properties:
id:
type: string
description: Client UID
example: czpvt3f246p4cw9i
opt_in:
description: Marketing opt-in status. Accepts "1", "0", true, or false.
example: true
security:
- Bearer: []
/platform/v1/clients/{client_id}:
delete:
description: '## Overview
Deletes a Client Available for **Staff, App, and Directory tokens**.'
parameters:
- description: Client UID
in: path
name: client_id
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
example:
data:
client:
address: My Hourse, bellvue, seattle, wasinton
campaign: Source Campaign
channel: Source Channel
created_at: '2025-08-05T06:56:27Z'
custom_field1: value1
custom_field2: value2
custom_field3: value3
customer_status: inactive
email: clientemail@mail.com.dczpvt3f246p4cw9i
first_name: First Name
id: czpvt3f246p4cw9i
last_name: Last Name
matter_term: clients
matters: []
mobile_phone: '+16378383489'
normalized_phone: null
opt_in: '1'
source: Client Portal
source_url: Source URL
tags: []
updated_at: '2025-08-05T06:56:28Z'
status: OK
summary: Deletes a Client by Id
tags:
- Clients
x-amazon-apigateway-auth:
type: NONE
x-amazon-apigateway-integration:
httpMethod: DELETE
responses:
default:
statusCode: '200'
type: http_proxy
uri: https:///platform/v1/clients/{client_id}
x-auth-type: Application & Application User
security:
- Bearer: []
operationId: deletePlatformV1ClientsByClientId
x-operation-id-source: derived
get:
description: '## Overview
Retrieves a Client.
## Authentication
**Available for Staff, App, and Directory Tokens.**'
parameters:
- description: Client UID
in: path
name: client_id
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
example:
data:
client:
address: My Hourse, bellvue, seattle, wasinton
campaign: Source Campaign
channel: Source Channel
created_at: '2025-08-05T06:56:27Z'
custom_field1: value1
custom_field2: value2
custom_field3: value3
customer_status: lead
email: clientemail@mail.com
first_name: First Name
id: czpvt3f246p4cw9i
last_name: Last Name
matter_term: clients
matters:
- display_name: First Name Last Name
fields: []
uid: eb28o6g7ad6q2ya8
mobile_phone: '+16378383489'
normalized_phone: null
opt_in: '1'
source: Client Portal
source_url: Source URL
tags: []
updated_at: '2025-08-05T06:56:27Z'
status: OK
summary: Retrieves a Client by Id
tags:
- Clients
x-amazon-apigateway-auth:
type: NONE
x-amazon-apigateway-integration:
httpMethod: GET
responses:
default:
statusCode: '200'
type: http_proxy
uri: https:///platform/v1/clients/{client_id}
x-auth-type: Application & Application User
security:
- Bearer: []
operationId: getPlatformV1ClientsByClientId
x-operation-id-source: derived
put:
description: '## Overview
Update a Client Available for **Staff, App, and Directory tokens**.'
parameters:
- description: Client UID
in: path
name: client_id
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
example:
data:
client:
address: My Hourse, bellvue, seattle, wasinton
created_at: '2025-08-05T06:56:27Z'
customer_status: lead
email: clientemail@mail.com
first_name: NEWFIRSTNAME
id: czpvt3f246p4cw9i
last_name: Last Name
mobile_phone: '+16378383489'
opt_in: '1'
spam: false
tags: []
updated_at: '2025-08-05T06:56:28Z'
status: OK
summary: Updates a Client
tags:
- Clients
x-amazon-apigateway-auth:
type: NONE
x-amazon-apigateway-integration:
httpMethod: PUT
responses:
default:
statusCode: '200'
type: http_proxy
uri: https:///platform/v1/clients/{client_id}
x-auth-type: Application & Application User
requestBody:
content:
application/json:
schema:
properties:
address:
description: Address. Send `null` or `""` to clear this field if force_nullifying is true.
type: string
created_at:
description: Client creation date. Read-only - automatically managed by the system and ignored in updates.
type: string
readOnly: true
custom_field1:
description: Custom Field 1
type: string
custom_field2:
description: Custom Field 2
type: string
custom_field3:
description: Custom Field 3
type: string
email:
description: Email Address. Must be a valid email format (e.g., user@example.com)
type: string
format: email
first_name:
description: First Name
type: string
force_nullifying:
description: If true, allows nullable fields (address, mobile_phone) to be cleared by sending `null` or empty string. Must be boolean true or string "true".
type: boolean
last_name:
description: Last Name
type: string
mobile_phone:
description: Phone Number. Send `null` or `""` to clear this field if force_nullifying is true.
type: string
opt_in:
description: Marketing email opt-in status. Accepts boolean values (`true` / `false`) or string values (`"1"` / `"0"`). When set to `true` (or `"1"`), the client is opted in to receive marketing emails; when set to `false` (or `"0"`), the client is opted out. This is distinct from `opt_in_transactional_sms`, which controls transactional SMS consent.
type: boolean
example: true
phone:
description: Phone Number
type: string
source_name:
description: 'Source name. Updates the client''s source label (e.g., "website", "client_portal", "contact_form"). The new value is reflected in the `source` field on subsequent GET responses. Note: unlike `POST /platform/v1/clients`, this does NOT create or update the underlying source record, so existing `source_url`, `channel`, and `campaign` values remain unchanged.'
type: string
source_url:
description: Source URL. Persists the URL on the client record but, unlike `POST /platform/v1/clients`, does NOT update the underlying source record. As a result, the value will not be reflected in the `source_url` field returned by subsequent GET responses (which is read from the source record). To change the visible `source_url`, `channel`, or `campaign` of an existing client, the source record itself must be updated through other means.
type: string
spam:
description: Client marked as spam
type: boolean
staff_id:
description: Staff ID
type: string
status:
description: 'Use a client status to categorize clients according to their relationship with your business. Valid values: lead, customer, loyal, inactive'
type: string
enum:
- lead
- customer
- loyal
- inactive
tags:
description: The tag system is based on customized labels that you create, so you can sort your data using personalized words, phrases or themes that are meaningful to you and your business
type: string
updated_at:
description: Client last update date. Read-only - automatically managed by the system and ignored in updates.
type: string
readOnly: true
type: object
security:
- Bearer: []
operationId: putPlatformV1ClientsByClientId
x-operation-id-source: derived
components:
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
# --- truncated at 32 KB (45 KB total) ---
# Full source: https://artifacts.apis.io/vcita/openapi/vcita-clients-api-openapi.yml