Jump to Content
Home
Guides
API Reference
Changelog
v1.0
v3.1
API Reference
v1.0
Home
Guides
API Reference
Changelog
Injection Leads From Any Form
All
Pages
Start typing to search…
JUMP TO
Platform API
Applications
List of apps
get
Creates an app
post
Read an app
get
Updates an app
put
Assign an app on directory or a business [Internal]
post
Install an app [Internal]
post
Unassign an app on directory or a business [Internal]
post
Uninstall an app [Internal]
post
Business
Search Businesses
get
Create a Business
post
Validate Login
get
Verify Audience Claim
post
Get Business
get
Update Business
post
Get Business Features
get
Update Purchased Items
put
Get Recurly parameters
get
Staff
Get Staff Members
get
Create Staff Member
post
Delete Staff Member
del
Get Staff Member Details
get
End Staff Member active sessions
del
Get Staff List [Alpha]
get
Get Staff By ID [Alpha]
get
Wizard
Gets a list of wizards
get
Gets a wizard by name
get
Update a wizard
put
Categories
Get Categories [Alpha]
get
Services
Get Services List by category [Alpha]
get
Get Services List [Alpha]
get
Get Service By ID [Alpha]
get
Clients
Get Clients
get
Create a Client
post
Deletes a Client by Id
del
Retrieves a Client by Id
get
Updates a Client
put
Matters
Merge duplicate clients into a primary client.
put
List of clients that can be used as primary for merge.
get
Client Packages
Use Client Package Credit [Alpha]
post
Validate Client Package has redemption [Alpha]
get
Get Client Packages List Of Client [Alpha]
get
Add package to client [Alpha]
post
Cancel Client Package Credit Redemption [Alpha]
put
Use Client Package Credit [Alpha]
post
Conversations
Get Conversations For A Client
get
Get Conversations
get
Documents
Get Documents For A Client
get
Estimates
Get Estimates Of Client
get
Get Estimates List
get
Create New Estimate
post
Invoices
Get Invoices Of Client
get
Get Invoices List
get
Create New Invoice
post
Get Invoice By ID
get
Payments
Get Payments of Client
get
Get Payments List
get
Create New Payment
post
Get Payments of Client
get
Match Payment
post
Directory
Gets Directory's branding
get
Fields
Get all Fields
get
Create a New Field
post
Deletes a Field
del
Get Field
get
Updates a Field
put
Forms
Get Forms
get
Updates a Form
put
Appointments
Get Appointments List
get
Get Appointment
get
LeadGen
Creates a lead
post
Messages
Create a Message
post
Manage Numbers
Assign Dedicated Number
post
Set Two Way Texting Status
put
translation missing: en.messaging-api.twilio.index.post.titlee
post
Remove Twilio Number
del
Card
Create sync card
post
Delete saved card
del
Payment Checkout
Send checkout update by webhook
put
Get Open Checkout For Specific url_key
get
Packages
Get all package of business
get
Create Package
post
Show package info
get
Update package [Alpha]
put
Payment Settings
Get Current Payment Settings
get
Update Payment Settings
post
Update Default Currency
put
Payment Statuses
Apply Coupon
put
Validate Coupon
get
Bookings
Get Bookings [Alpha]
get
Create New Booking [Alpha]
post
Cancel a Booking [Alpha]
post
Update RSVP state
put
Create event Waitlist
post
Cancel a Waitlist registration
put
Event Attendances
Get Event Attendance
get
Event Instance
Get Event Instance
get
Availability
Get Multi Services availability [Alpha]
get
Get Service availability By ID [Alpha]
get
Token Management
Get tokens
get
Creates a token
post
Revokes a token
post
Webhooks
Subscribe To Webhook
post
Unsubscribe from Webhook
post
Get Webhooks List
get
Scheduling related API
Bookings
Create New Booking [Business]
post
Accept a Booking [Business]
post
Cancel a Booking [Business]
put
Mark booking as no show
post
Update Booking Details [Business]
put
ExternalCalendarItems
External app bulk create external items
put
External app bulk deactivate external items
put
External app connect
put
External app deactivate external calendar
put
External app disable
put
External app disconnect
put
External app report_sync_status
put
External app start_export
put
External app stop import
put
Weekly availability
General availability - Create new time slot
post
General availability - Remove time slot
del
General availability - Update time slot
put
client_api API
Forms
Get Leave Details Form
get
Submits Leave Details Form
post
Get Share Documents Form
get
Submits Share Documents Form
post
Payment related API (Business)
Client Payment Cards
Get Client Payment Cards (Staff Access)
get
Card Requests
Create Card Request
post
Get Card Request
get
card
Update Card
put
Sales
Create Sale
post
Get Sale
get
Cancel an open sale
put
Complete an open sale
put
Client Packages
Show Client Package Info [Alpha]
get
Update client package [Alpha]
put
Deposits
Show Deposits List
get
Create Deposit
post
Delete Deposit
del
Show Deposit
get
Update Deposit
put
Estimates
Create Estimate
post
Get Estimate
get
update
put
Invoices
Create Invoice
post
Get Invoice
get
update
put
Cancel Invoice
put
Packages
Reorder packages [Alpha]
put
Payment Requests
GET Payment Requests List
get
Send payment request link
post
GET Payment Request
get
update
put
Payments
List Payments
get
Get Payment
get
Update Payment
put
Payouts
Create Payout
post
Get Payout
get
Update Payout
put
Product Orders
Create Product Order
post
Get Product Order
get
Update Product Order
put
Products
Get Products List
get
Create Product
post
Remove Product [Alpha]
del
Get Product [Alpha]
get
Update Product
put
Refunds
Create Refund
post
Scheduled Payment Rule
Get list of Scheduled Payment Rules
get
Create Scheduled Payment Rule
post
Cancel Recurring Payments Rule
put
Get Scheduled Payment Rule
get
Update Scheduled Payment Rule
put
Bulk Taxes
Delete Multiple Taxes
del
Create Multiple Taxes
post
Update Multiple Taxes
put
Apply Default Taxes
put
Taxes
Get Taxes List [Alpha]
get
Create Tax [Alpha]
post
Remove Tax [Alpha]
del
Get Tax [Alpha]
get
Update Tax [Alpha]
put
Transactions
Create Transaction
post
Get Transaction
get
Update Transaction
put
Coupons
Get all coupons
get
Payments Widgets
Payments widget
get
Payment related API (Clients)
Apps
Get External Connected Payment Application
get
Cards
Get Client Payment Cards
get
Create New Card On File
post
Get most recent pending card added to client [Alpha]
get
Create New Save Card Session
post
Carts
Create Cart
post
Show Cart
get
Client Packages
List of Client Packages
get
Deposits
Show Deposits List
get
Show Deposit
get
Invoices
Show Invoices List
get
Packages
List Packages Info [Alpha]
get
Show Package Info [Alpha]
get
Payment Requests
Get Payment Requests List
get
Get Checkout Session
get
Payments
Show Payments List
get
Product Orders
Show Product Orders List
get
Client related API
Matters
Import clients app
post
Gets Matters of a contact
get
Create a new Matter
post
Gets Matters by filter
get
Gets the collaborators of a Matter
get
Adds a collaborator to a Matter
post
Removes a collaborator from a Matter
del
Nest a matter under another contact person
put
Gets a list of notes
get
Adds a note
post
Remove a note
del
Get a note
get
Update a note
put
Reassign staff to Matter
put
Remove a tag from a Matter
del
Gets a list of tags of a Matter
get
Adds a tag to a Matter
post
Gets a Matter
get
Updates a Matter
put
Show business client settings
get
Update business client settings
put
Client Settings
Retrieve Client Settings
get
Update Client Settings
put
Business Messaging API
Messaging Channels
Create a mesaging channel
post
Typing Indicator
Notify Typing Indicator
post
Activity Message
Send activity message api
post
Send activity message api
post
communicationgw
channels
/channels
post
/channels/{uid}
del
/channels/{uid}
put
messages
/messages
post
/messages/{messageUid}
put
oauth
/oauth
get
sessions
* Required query params
get
/sessions
post
/sessions/typing
post
/sessions/{uid}
del
/sessions/{uid}
put
Accounts related API
Business Attributes
Gets business attributes
get
Business Branding
Gets the branding of the business
get
Business
Remove business identities
del
Get business identities
get
Update business identities
put
Business account usage
Business account usage in the last 3 months
get
Staff related API
Staff activity
Daily Staff Sign-ins
get
Staff
Updates a staff's properties
put
Oauth API
Token Management
Exchanges a OAuth Code for an Access Token
post
OpenID
Get authenticated user info
get
Webhooks responses
Getting Started
App
App Installed
App Uninstalled
Appointment
Appointment Scheduled
Appointment Requested
Appointment Rescheduled
Appointment Cancelled
Appointment Completed
Appointment Reminder sent
Business Account
Account Created
Account Updated
Business Info ('update')
Account Closed
Account ('promotional_blocked')
Client
Client updated
Client Created
Conversation Read
Conversation item Created
Deposit Created
Document Sent
Estimate
Estimate Requested
Estimate Rejected
Estimate Approved
Event Registration
Event registration Created
Event registration Updated
Invoice
Invoice issued
Invoice Updated
Payment
Payment Recorded
Payment Refunded
Payment Updated
Payment matched
Message
Message Business sent message
Message Client sent message
Messaging Channel Status
Matter
Matter Delete
Matter Recover
Payment Gateway Settings
Payment Gateway Settings Connected
Payment Gateway Settings Disconnected
Review Submitted
Service Updated
Staff
Staff Created
Staff Updated
Staff Deleted
Staff Deactivated
Staff Reactivated
Subscription
Purchasable Subscription Created (deprecated)
Purchasable Subscription Updated (deprecated)
Tag
Tag Add
Tag Delete
Bulk Client Import
Partners API
Account Management
Account Creation
post
Account Manipulation
get
Set Setup Completed
post
Add/Remove staff
get
Close an Account
post
Reopen an Account
post
Injection Leads From Any Form
Lead Injection
post
Reporting
Business Info
get
Engagements Report
get
Widget Impressions Report
get
Single Sign On
SSO API
get
Emails & SMS
CRM Views
Views
Get all views
get
Create a new view
post
Get a specific view
get
Update a view
put
Delete a view
del
Bulk update views
post
Views Columns
Get available columns
get
View Filters
Get available filters
get
Powered by
Injection Leads From Any Form
Ask AI
