vcita Developers Hub

Home
Guides
API Reference

vcita Developer Hub

Welcome to the vcita Developer Hub.
Find comprehensive guides and documentation to help you
start working with our APIs as quickly as possible.
Let's jump right in!

Get Started

HomeGuidesRecipesAPI ReferenceReferenceChangelogDiscussionsPage Not FoundSearch{{ state.current().meta.title }}API Logs

Documentation

Getting Started

Open Platform APIs

Open Platform Overview
Who can access vcita Open Platform?
OAuth 2.0 Authentication Flow

Webhooks API

Webhooks Overview
Webhook subscriptions

Partners API

Partners API Overview
Single Sign On

SDK for Widgets And Website Integration

SDK Overview
LiveSite.js - Quickstart
Widget CSS Customization
Widget Configuration
Widget Custom Actions
Actions Reference
Website Embedded Actions

Sample Applications

Sample Application Overview
Sample Applications

Documentation

Getting Started

Open Platform APIs

Open Platform Overview
Who can access vcita Open Platform?
OAuth 2.0 Authentication Flow

Webhooks API

Webhooks Overview
Webhook subscriptions

Partners API

Partners API Overview
Single Sign On

SDK for Widgets And Website Integration

SDK Overview
LiveSite.js - Quickstart
Widget CSS Customization
Widget Configuration
Widget Custom Actions
Actions Reference
Website Embedded Actions

Sample Applications

Sample Application Overview
Sample Applications

Platform API

Token Management
Business
Staff
Categories
- get
  Get Categories [Alpha]
Services
Clients
Matters
- put
  Merge duplicate clients into a primary client.
- get
  List of clients that can be used as primary for merge.
Client Packages
Conversations
- get
  Get Conversations For A Client
- get
  Get Conversations
Documents
- get
  Get Documents For A Client
Estimates
Invoices
Payments
Identities
- get
  Get Identities
Fields
Forms
- get
  Get Forms
- put
  Updates a Form
Appointments
Marketing
Event Attendance
- get
  Gets a list of event attendances
Event Instance
- get
  Gets a list of event instances
- get
  Get Event Instance
LeadGen
- post
  Creates a lead
Messages
- post
  Create a Message
Card
- post
  Create sync card
Payment Checkout
- put
  Send checkout update by webhook
- get
  Get Open Checkout For Specific url_key
Packages
Payment Settings
- get
  Get Current Payment Settings
- post
  Update Payment Settings
Payment Statuses
- put
  Apply Coupon
- get
  Validate Coupon
Bookings
Availability
- get
  Get Service availability By ID [Alpha]
Webhooks

Scheduling related API

Bookings

client_api API

Forms

Payment related API

Carts
- get
  Show Cart
Client Packages
- get
  Show Client Package Info [Alpha]
- put
  Update client package [Alpha]
Invoices
- post
  Create Invoice
- put
  update
Packages
- put
  Reorder packages [Alpha]
Payment request
- post
  Send payment request link [Alpha]
Product Orders
Products
Taxes

Payment related API

Cards
- get
  Get most recent pending card added to client [Alpha]
Carts
- post
  Create Cart
- get
  Show Cart
Packages
- get
  List Packages Info [Alpha]
- get
  Show Package Info [Alpha]

Client related API

Matters

Oauth API

Token Management
- post
  Exchanges a OAuth Code for an Access Token
OpenID
- get
  Get authenticated user info

Webhooks responses

Getting Started
Client ('created', 'updated')
Message ('business_sent_message' , 'client_sent_message')
Payments ('recorded' / 'refunded')
Invoice ('issued', 'updated')
Estimate ('requested', 'rejected', 'approved')
Appointment ('requested', 'scheduled', 'rescheduled', 'cancelled' , 'reminder_sent')
Event registration ('created', 'updated')
Review ('submitted')
Document ('created')
App Subscription ('installed', 'uninstalled')
Staff ('created', 'updated', 'deactivated', 'deleted'
Account ('closed')

Partners API

Account Management
Injection Leads From Any Form
- post
  Lead Injection
Reporting
Single Sign On

Powered by