Jump to Content
Home
Guides
API Reference
Changelog
v1.0
v3.1
API Reference
v3.1
Home
Guides
API Reference
Changelog
Subscription Updated
All
Pages
Start typing to search…
JUMP TO
Welcome
Welcome to the inTandem API 🚀
Ai
The BizAI Platform
AI Generation Feedback
The AIGenerationFeedback Object
Create new AI generation feedback
post
AI Recommendations
The AIRecommendation Object
Get all AIRecommendations
get
Create an AIRecommendation
post
Update an AIRecommendation
put
AI Recommended Actions
The AIRecommendedAction Object
AI SmartReply
The AISmartReply Object
Create a new AISmartReply
post
List all AISmartReplies
get
BizAI Chats
The BizAIChat Object
Get all BizAIChats
get
Create a BizAIChat
post
Retrieve a BizAIChat
get
BizAI Chat Messages
The BizAIChatMessage Object
The BizAIChatStreamMessage Object
Get all BizAIChatMessages
get
Create a BizAIChatMessage
post
Staff AI Settings
Retrieve a StaffAiSettings
get
Update a StaffAiSettings
put
The StaffAISettings Object
AI Chat Completions
Create a ChatCompletion
post
AI Audio Transcriptions
Create an AudioTranscription
post
AI Chat Completion Runs
Retrieve a ChatCompletionRun
get
List ChatCompletionRuns
get
AI Transcription Runs
Retrieve a TranscriptionRun
get
List TranscriptionRuns
get
Apps
Applications
Creates an app
post
List of apps
get
Read an app
get
Updates an app
put
Unassign an app on directory or a business [Internal]
post
Update app translations
put
Assign an app on directory or a business [Internal] - Deprecated, /v3/apps/app_assignments instead
post
Install an app [Internal]
post
Uninstall an app [Internal]
post
App Assignments
The AppAssignment Object
Create an App Assignment
post
Delete an App Assignment
del
List App Assignments
get
JWKS
The Compact JWS token entity
Create a compact JWS token
post
Bulk create compact JWS tokens
post
Staff Widgets Board
The StaffWidgetsBoard Object
Create a Staff Widgets Board
post
Get all Widgets Boards Of The Staff
get
Update a Staff Widgets Board
put
Staff Widgets Boards Template
The StaffWidgetsBoardsTemplate Object
Create a Staff Widgets Boards Template
post
Delete a Staff Widgets Boards Template
del
Get all Staff Widgets Boards Templates
get
Update a Staff Widgets Boards Template
put
Widget
The Widget Object
Create a Widget
post
Get all Widgets
get
Update Widget
put
Navigation Items
Navigation Item
List Navigation Items
get
Create a Navigation Item
post
Update a Navigation Item
put
Delete a Navigation Item
del
Service OAuth
Generate an app access token
post
Clients
Client Portal
Apps
Get External Connected Payment Application
get
Cards
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
Client Settings
The ClientSettings Object
Retrieve Client Settings
get
Update Client Settings
put
Deposits
Show Deposits List
get
Forms
Get Leave Details Form
get
Get Share Documents Form
get
Submits Leave Details Form
post
Submits Share Documents Form
post
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
Managing Clients
Matters
Import clients app
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
Gets Matters of a contact
get
Create a new Matter
post
Bulk add tags to matters
put
Bulk remove tags from matters
del
List of clients that can be used as primary for merge.
get
Merge duplicate clients into a primary client.
put
Client Packages
Validate Client Package has redemption [Alpha]
get
Use Client Package Credit [Alpha]
post
Clients
Deletes a Client by Id
del
Retrieves a Client by Id
get
Get Clients
get
Create a Client
post
Updates a Client
put
Conversations
Documents
Get Documents For A Client
get
Estimates
Get Estimates Of Client
get
Invoices
Get Invoices Of Client
get
Payments
Get Payments of Client
get
Views
Delete a view
del
Get a specific view
get
Get all views
get
Bulk update views
post
Create a new view
post
Update a view
put
Views Columns
Get available columns
get
View Filters
Get available filters
get
Deposits
Show Deposit
get
Search
Search business data
get
Search docuforms activities
get
Communication
Manage Communication
oauth
channels
Create a Business Communication Channel
post
Delete a Business Communication Channel
del
Update a Business Communication Channel
put
sessions
Create a Business Communication Session
post
Retrieve a Business Communication Session
get
Delete a Business Communication Session
del
Update a Business Communication Session
put
Create a Business Communication Session Typing indicator
post
Messaging
Activity Message
The ActivityMessage Object
Create an ActivityMessage
post
Messages
Get Conversation Messages
get
Create a Business Communication Message
post
Update Business Communication Message
put
Create a Message
post
Conversations
Get Conversations For A Client
get
Get Conversations
get
Messaging Channels
Create a mesaging channel
post
Notifications
Notification Templates
The NotificationTemplate Object
Delete a NotificationTemplate
del
Get all NotificationTemplates
get
Retrieve a NotificationTemplate
get
Create a NotificationTemplate
post
Update a NotificationTemplate
put
Staff Notification
The StaffNotification Object
Retrieve a StaffNotification
get
Create a StaffNotification
post
Telephony
Available Phone Numbers
The AvailablePhoneNumber Object
Retrieve All AvailablePhoneNumbers
get
Business Phone Numbers
The BusinessPhoneNumber Object
Update a BusinessPhoneNumber
put
Create a BusinessPhoneNumber
post
Retrieve all BusinessPhoneNumbers
get
Retrieve a BusinessPhoneNumber
get
Manage Numbers
Remove Twilio Number
del
Assign Dedicated Number
post
translation missing: en.messaging-api.twilio.index.post.titlee
post
Set Two Way Texting Status
put
Typing Indicator
Notify Typing Indicator
post
Voice Calls
Voice Call
The VoiceCall Object
Create a VoiceCall
post
Retrieve a VoiceCall
get
Get all VoiceCalls
get
Update a VoiceCall
put
Voice Call Settings
The VoiceCallSetting Object
Create a VoiceCallSetting
post
Get all VoiceCallSettings
get
Update VoiceCallSetting
put
Voice Call Recordings
The VoiceCallRecording Object
Update a VoiceCallRecording
put
Delete a VoiceCallRecording
del
Voice Call Quota
The VoiceCallQuota Object
Retrieve a VoiceCallQuota
get
Voice Call Reports
Get voice call stats
get
Integrations
Import
Import Job
Import Job Item
Create a new ImportJob
post
Retrieve an ImportJob
get
Get all ImportJobItems
get
Retrieve an ImportJobItem
get
IDP Actor Mapping
The IDPActorMapping Object
List all IDP Actor Mappings
get
Create an IDP Actor Mapping
post
Delete an IDP Actor Mapping
del
Platform_administration
Access Control
Business Role
The BusinessRole Object
Get all BusinessRoles
get
Create a BusinessRole
post
Retrieve a BusinessRole
get
Update a BusinessRole
put
Delete a BusinessRole
del
Staff Permission
The StaffPermission Object
Get All StaffPermissions
get
Staff Permission Override List
The StaffPermissionOverrideList Object
Retrieve a Staff Permissions Overrides List
get
Update a Staff Permissions Overrides List
put
Remove all permission overrides
del
Get all Staff Permission Overrides Lists
get
Staff Business Role
The Staff Business Role Object
Get all StaffBusinessRoles
get
Create a StaffBusinessRole
post
Retrieve a StaffBusinessRole
get
Update a StaffBusinessRole
put
Permission
The Permission Object
Get all Permissions
get
Business Administration
Business Attributes
Gets business attributes
get
Business Branding
Gets the branding of the business
get
Business account usage
Business account usage in the last 3 months
get
Business Reports
Business Info
get
Engagements Report
get
Widget Impressions Report
get
Staff Member
Retrieve a StaffMember
get
Update a StaffMember
put
Staff
Get Staff List [Alpha]
get
Updates a staff's properties
put
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 By ID [Alpha]
get
Staff activity
Daily Staff Sign-ins
get
Staff Quick Action Lists
Get relevant quick action lists per staff
get
Update quick action lists for a specific staff member
put
Account [Deprecated]
Account Creation
post
Add/Remove staff
get
Account Manipulation
get
Close an Account
post
Reopen an Account
post
Business
Search Businesses
get
Create a Business
post
Validate Login
get
Verify Audience Claim
post
Remove business identities
del
Get business identities
get
Update business identities
put
Get Business
get
Update Business
post
Get Business Features
get
Update Purchased Items
put
Get Recurly parameters
get
Directory
Gets Directory's branding
get
Get a list of Directories
get
Retrieve a Directory
get
Wizard
Gets a list of wizards
get
Gets a wizard by name
get
Update a wizard
put
License
Offering
The Offering Object
List all Offerings
get
Create an Offering
post
Retrieve an Offering
get
Update an Offering
put
Delete an Offering (Not implemented yet
del
Bundled Offering
The BundledOffering Object
List all BundledOfferings
get
Create a BundledOffering
post
Bulk create BundledOfferings
post
Delete a BundledOffering
del
Business Cart
The BusinessCart Object
Create a BusinessCart
post
Retrieve a BusinessCart
get
Directory Offering
The DirectoryOffering Object
List all DirectoryOfferings
get
Create a DirectoryOffering
post
Retrieve a DirectoryOffering
get
Delete a DirectoryOffering
del
Subscription
The Subscription Object
List all Subscriptions
get
Create a Subscription
post
Retrieve a Subscription
get
Update a Subscription
put
SKU
The SKU entity
List all SKUs
get
Operators
OP Role
The OPRole Object
Operator Capability
The OperatorCapability Object
Operator Business Tokens
The OperatorBusinessToken Object
Operator OPRole
The OperatorOPRole Object
Session Management
Token Management
Creates a token
post
Exchanges an OAuth Code for an Access Token
post
Tokens
Get Tokens List
get
Revoke Token
post
SSO API
get
OpenID
Get authenticated user info
get
Webhook Responses
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')
Account Rejected
Bulk Client Import
Conversation Read
Conversation item Created
Customized Notification
Notification Updated
Deposit Created
Subscription
Subscription Created
Subscription Updated
Document Sent
Estimate
Estimate Requested
Estimate Rejected
Estimate Approved
Event Registration
Event registration Created
Event registration 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
Client
Client updated
Client Created
Lead Injection
post
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
Tag
Tag Add
Tag Delete
Invoice
Invoice issued
Invoice Updated
Online Profiles
Get Online Profile
get
Get My Online Profile
get
Create Online Profile
post
Update Online Profile
put
Webhooks
Subscribe to Webhook
post
Unsubscribe from Webhook
post
Get Webhooks List
get
Partners API
Set Setup Completed
post
Automation
Get Automation Flows
get
Get Next Execution Time
get
Scheduling
Appointments
Get Appointments List
get
Get Appointment
get
Availability Slots
Get all AvailabilitySlots
get
Bookings [Directory]
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
Bookings [Business]
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
Event Attendances
Get Event Attendance
get
Event Instance
Get Event Instance
get
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
Resource Type
Get all ResourceTypes
get
Create a ResourceType
post
Retrieve a ResourceType
get
Update a ResourceType
put
Delete a ResourceType
del
Resource
Get all Resources
get
Create a Resource
post
Retrieve a Resource
get
Update a Resource
put
Delete a Resource
del
Weekly availability
General availability - Create new time slot
post
General availability - Remove time slot
del
General availability - Update time slot
put
Sales
Catalog
Client Packages
Cancel Client Package Credit Redemption [Alpha]
put
Use Client Package Credit [Alpha]
post
Show Client Package Info [Alpha]
get
Update client package [Alpha]
put
Services
Get Services List
get
Get Services Availability
get
Get Service Details
get
Get Service Specific Availability
get
Products
Get Products List
get
Create Product
post
Remove Product [Alpha]
del
Get Product [Alpha]
get
Update Product
put
Financial Operations
Product Orders
Create Product Order
post
Get Product Order
get
Update Product Order
put
Sales Reports
Retrieve Payments Forecast Data
get
Retrieve Payments Widget Data
get
Estimates
Create Estimate
post
Get Estimate
get
update
put
Get Estimates List
get
Invoices
Create Invoice
post
Get Invoice
get
update
put
Cancel Invoice
put
Get Invoices List
get
Create New Invoice
post
Get Invoice By ID
get
Sales
Create Sale
post
Get Sale
get
Cancel an open sale
put
Complete an open sale
put
LeadGen
Creates a lead
post
Payment Processing
Payment Cards
List stored Payment Cards
get
Scheduled Payment Rule
Get list of Scheduled Payment Rules
get
Create Scheduled Payment Rule
post
Get Scheduled Payment Rule
get
Update Scheduled Payment Rule
put
Cancel Recurring Payments Rule
put
Bulk Taxes
Delete Multiple Taxes
del
Create Multiple Taxes
post
Update Multiple Taxes
put
Apply Default Taxes
put
Card Requests
Create Card Request
post
Get Card Request
get
Client Payment Cards
Get Client Payment Cards
get
Get Client Payment Cards (Staff Access)
get
Payments
List Payments
get
Get Payment
get
Update Payment
put
Get Payments List
get
Create New Payment
post
Match Payment
post
Get Payment by ID
get
Payment Checkout
Send checkout update by webhook
put
Get Open Checkout For Specific url_key
get
Payment Gateways
Delete a PaymentGateway
del
Retrieve a PaymentGateway
get
Get all PaymentGateways
get
Create a PaymentGatewayAssignment
post
Create a PaymentGateway
post
Update a PaymentGateway
put
Payment Requests
GET Payment Requests List
get
GET Payment Request
get
update
put
Send payment request link
post
Payment Settings
Get Current Payment Settings
get
Update Payment Settings
post
Update Default Currency
put
Packages
Reorder packages [Alpha]
put
Get all package of business
get
Create Package
post
Show package info
get
Update package [Alpha]
put
Payment Statuses
Apply Coupon
put
Validate Coupon
get
card
Update Card
put
Create sync card
post
Delete saved card
del
Payouts
Create Payout
post
Get Payout
get
Update Payout
put
Refunds
Create Refund
post
Taxes
Get Taxes List [Alpha]
get
Create Tax [Alpha]
post
Remove Tax [Alpha]
del
Get Tax [Alpha]
get
Update Tax [Alpha]
put
Deposits
Show Deposits List
get
Create Deposit
post
Delete Deposit
del
Show Deposit
get
Update Deposit
put
Transactions
Create Transaction
post
Get Transaction
get
Update Transaction
put
Invoice
Create an Invoice
post
Update an Invoice
put
Credit Note
Get all Credit Notes
get
Create a Credit Note
post
Retrieve a Credit Note
get
Coupons
The Coupon Object
List Coupons
get
Create Coupon
post
Get Valid Coupons for Entity
get
Remove Coupon from Entity
post
Get Coupon
get
Update Coupon
put
Delete Coupon
del
Expire Coupon
post
Enable Coupon
post
Disable Coupon
post
Apply Coupon to Entity
post
Get all Coupons
get
/business/payments/platform/v1/payment/client_packages
Reviews
Business Reviews Settings
The BusinessReviewsSettings Object
Retrieve Business Reviews Settings
get
Create Business Reviews Settings
post
Update Business Reviews Settings
put
Powered by
Subscription Updated
Ask AI
Notifying when a subscription (app, main…) is updated.
