# inTandem Developers Hub Documentation

> inTandem Developers Hub

## Guides: Introduction
- [Welcome to the inTandem Developer Hub](https://developers.intandem.tech/docs/welcome-to-the-intandem-developer-hub.md)
- [Platform Overview](https://developers.intandem.tech/docs/platform-overview.md): Boost your business with vcita's All-In-One platform solution

## Guides: The InTandem API
- [API Overview](https://developers.intandem.tech/docs/api-overview.md): Manage and control client information with ease.
- [Get Access](https://developers.intandem.tech/docs/get-access.md)
  - [Directory Owners (Partners)](https://developers.intandem.tech/docs/directory-owners-partners.md)
  - [App Developers](https://developers.intandem.tech/docs/app-developers.md)
  - [Business owners](https://developers.intandem.tech/docs/business-owners.md)
- [Quickstart - Platform API Management](https://developers.intandem.tech/docs/quickstart-platform-api-management.md): Create a business, add a subscription, add a staff

## Guides: The InTandem JS SDK
- [Introduction](https://developers.intandem.tech/docs/introduction.md)
- [Installation](https://developers.intandem.tech/docs/installation.md)
- [InTandemMessageHandler](https://developers.intandem.tech/docs/intandemmessagehandler.md)
  - [addEventListener (callback)](https://developers.intandem.tech/docs/addeventlistener.md): Registers a listener to handle incoming messages. The listener receives two arguments: the message and an acknowledgment (`ack`) function.
  - [removeEventListener (type)](https://developers.intandem.tech/docs/addeventlistener-callback-copy.md): Registers a listener to handle incoming messages. The listener receives two arguments: the message and an acknowledgment (`ack`) function.
  - [init](https://developers.intandem.tech/docs/init.md): Initializing your app or widget
  - [getState](https://developers.intandem.tech/docs/getstate.md): Used to get the state of the hosting entity (a page where an app is embedded or the widget containing an iframe)
  - [setState](https://developers.intandem.tech/docs/setstate.md): Used to get the state of the hosting entity (a page where an app is embedded or the widget containing an iframe)
  - [navigate](https://developers.intandem.tech/docs/navigate.md): This function places a request to navigate the current hosting page to a path, relative or absolute
  - [openModal](https://developers.intandem.tech/docs/openmodal.md): This function places a request to open a modal over the current hosting page
  - [getJWKSToken](https://developers.intandem.tech/docs/getauth.md): Get an authorization token to use with JWKS
  - [getUser](https://developers.intandem.tech/docs/getuser.md): Get the basic details about the user (impersonation, locale, current domain...)
  - [destroy](https://developers.intandem.tech/docs/destroy.md): Releases any resources that are being used.
- [JWKS (JSON Web Key Set) Overview](https://developers.intandem.tech/docs/jwks-json-web-key-set-overview.md)

## Guides: Platform administration
- [The Operator Portal](https://developers.intandem.tech/docs/operator-portal.md)
  - [Creating a New Account](https://developers.intandem.tech/docs/account-create-op.md): Creating a new account in the Operator Portal
  - [Managing Client Accounts](https://developers.intandem.tech/docs/account-manage-op.md): Managing your Operator Portal account
  - [Locking Accounts](https://developers.intandem.tech/docs/account-close-op.md): Locking an account in the Operator Portal
  - [Operator Roles & Capabilities](https://developers.intandem.tech/docs/operator-roles-and-capabilities.md): What each Operator Portal role can do, and what every capability unlocks
- Account Creation
  - [Account Creation Flow](https://developers.intandem.tech/docs/account-creation-flow.md)
  - [Using Templates](https://developers.intandem.tech/docs/using-templates.md)
  - [Signup Page](https://developers.intandem.tech/docs/signup-page.md)
- Access Control (Permissions)
  - [Main Concepts](https://developers.intandem.tech/docs/main-concepts.md): inTandem access control main concepts
  - [Permissions List & Defaults](https://developers.intandem.tech/docs/permissions-list-defaults.md)
  - [App Permissions](https://developers.intandem.tech/docs/app-permissions.md): As part of inTandem's evolved access control architecture, apps—especially pre-installed ones—can now define, enforce, and manage permissions through a dedicated integration process.
  - [App Permissions Request Form](https://developers.intandem.tech/docs/app-permissions-request-form.md)
- [Custom login options](https://developers.intandem.tech/docs/custom-login-options.md)
- [SSO (Single Sign On)](https://developers.intandem.tech/docs/sso-single-sign-on.md): Log in users to their account using a Single Sign On method.
- [Webhooks](https://developers.intandem.tech/docs/webhooks.md)
- [Manage Billing & Subscriptions](https://developers.intandem.tech/docs/custom-billing-pages.md)
  - [Overview](https://developers.intandem.tech/docs/overview.md)
  - [License Management - Creation Quick Guide](https://developers.intandem.tech/docs/offerings-quick-start.md): This overview is constructed as a full overview of the inTandem Offering system capabilities. Some of the API's access is restricted by design. Supported token types are clearly mentioned in the API…
  - [Purchase Flow](https://developers.intandem.tech/docs/purchase-flow.md)
  - [Cancel Flow](https://developers.intandem.tech/docs/cancel-flow.md)
  - [Dunning Flow](https://developers.intandem.tech/docs/dunning-flow.md)
  - [Partner's Pricing Page](https://developers.intandem.tech/docs/partners-pricing-page.md)
  - [Subscription Coupons](https://developers.intandem.tech/docs/coupons-for-plans-apps-and-add-ons.md): How to set up and use coupons to discount the price of Plans, Apps, and Add-ons
  - [Discounted Subscriptions](https://developers.intandem.tech/docs/discounted-subscriptions.md): This guide demonstrates how to create discounted and free subscriptions using coupons.

## Guides: The Apps Framework
- [Apps Overview](https://developers.intandem.tech/docs/apps-overview.md)
- [Apps - Basic Terminology](https://developers.intandem.tech/docs/apps-basic-terminology.md)
- [Create your first app](https://developers.intandem.tech/docs/create-your-first-app.md): A step-by-step process to setup your first app
- [OAuth 2.0](https://developers.intandem.tech/docs/oauth-20-authorization-flow.md): Authenticate and generate an API access token for your apps
  - [OAuth Enhancements](https://developers.intandem.tech/docs/oauth-enhancements-in-the-intandem-platform.md): Developer Implementation Guide
  - [OAuth Code Examples](https://developers.intandem.tech/docs/application-oauth-sample.md)
- [JWKS Authentication](https://developers.intandem.tech/docs/jwks-json-web-key-set-overview-1.md)
- [Application Types (Integration Points)](https://developers.intandem.tech/docs/application-types-integration-points.md)
  - [OpenID](https://developers.intandem.tech/docs/openid.md): "app_type": ["openid"]
  - [Menu Items](https://developers.intandem.tech/docs/menu-items.md): "app_type": ["menu_items"]
  - [Communication](https://developers.intandem.tech/docs/communication.md): "app_type": ["communication"]
  - [Payments](https://developers.intandem.tech/docs/payments.md): "app_type": ["payments"]
    - [Connect / Disconnect](https://developers.intandem.tech/docs/connect-disconnect.md)
    - [Checkout](https://developers.intandem.tech/docs/checkout.md)
    - [Charge](https://developers.intandem.tech/docs/charge.md)
    - [Refund](https://developers.intandem.tech/docs/refund.md)
    - [Card on file](https://developers.intandem.tech/docs/card-on-file.md)
    - [Tips](https://developers.intandem.tech/docs/tips.md)
  - [Client Import](https://developers.intandem.tech/docs/client-import.md): "app type": ["import_clients"]
  - [Notification](https://developers.intandem.tech/docs/notification.md): "app type": ["notifications"]
- [Paid Apps](https://developers.intandem.tech/docs/paid-apps.md): Implemnting paid apps
- [In-App Purchase](https://developers.intandem.tech/docs/in-app-purchase.md)
- [Dashboard Widgets](https://developers.intandem.tech/docs/widgets.md)
  - [Glossary](https://developers.intandem.tech/docs/glossery.md)
  - [Iframe Widget Life Cycle](https://developers.intandem.tech/docs/widget-life-cycle.md)
  - [Iframe Widgets](https://developers.intandem.tech/docs/iframe-widgets-1.md)
  - [Optimizing Widget Loading Speed: A Comprehensive Guide](https://developers.intandem.tech/docs/optimizing-widget-loading-speed-a-comprehensive-guide.md)

## Guides: Client Portal
- [SDK Overview](https://developers.intandem.tech/docs/skd-overview.md)
- [Quickstart - Create your first widget](https://developers.intandem.tech/docs/quickstart-create-your-first-widget.md)
- Widgets
  - [Widget CSS Customization](https://developers.intandem.tech/docs/widget-css-customization.md): Adjust the Client Portal Widget UI look & feel to your website
  - [Widget Configuration](https://developers.intandem.tech/docs/widget-configuration.md): Methods to control the behavior of the LiveSite widget
  - [Widget Custom Actions](https://developers.intandem.tech/docs/widget-custom-actions.md): Change, add or remove built-in and custom actions on a per-page / per-website basis
- [Website Embedded Actions](https://developers.intandem.tech/docs/website-embedded-actions.md): Add built-in actions with dynamic or static parameters to your natural website flow
- [Actions Reference](https://developers.intandem.tech/docs/actions-reference.md): Complete options list per action

## Guides: Communication
- [Activity Message Types Reference](https://developers.intandem.tech/docs/activity-message-types-reference.md): This document lists all message types returned by the GET /v3/communication/activity_messages endpoint, organized by activity type (messageable type).

## Guides: BizAI
- [The BizAI platform](https://developers.intandem.tech/docs/the-bizai-platform.md)
- [Quickstart - Working with the BizAI Chat](https://developers.intandem.tech/docs/working-with-the-bizai-chat.md): Step by step Guide
- [BizAI sample chat application](https://developers.intandem.tech/docs/bizai-sample-chat-application.md): a simple chat application using the basic BizAI API

## Guides: MCP Server
- [MCP](https://developers.intandem.tech/docs/mcp.md)

## API Reference: Welcome
- [Welcome to the inTandem API 🚀](https://developers.intandem.tech/reference/welcome-to-intandem-api.md)

## API Reference: Ai
- [The BizAI Platform](https://developers.intandem.tech/reference/the-bizai-platform.md)
- AI SmartReply
  - [The AISmartReply Object](https://developers.intandem.tech/reference/aismartreply.md)
  - [Create a new  AISmartReply](https://developers.intandem.tech/reference/post_v3-ai-ai-smart-replies.md): ## Overview Generate a new, on-demand, smart reply between a business and a client. For example, when a user wants to edit their own reply text, provide custom instructions, or modify a…
  - [List all AISmartReplies](https://developers.intandem.tech/reference/get_v3-ai-ai-smart-replies.md): ## Overview Retrieve a list of smart replies with optional filtering.  Available for **Staff, Directory, and Client tokens**
- AI Chat Completions
  - [Create a ChatCompletion](https://developers.intandem.tech/reference/post_v3-ai-chat-completions.md): ## Overview Create chat completions using multiple LLM providers (OpenAI, Anthropic, Google). Supports text and multimodal input (images, audio, video, files), streaming responses via SSE, async mode…
- AI Audio Transcriptions
  - [Create an AudioTranscription](https://developers.intandem.tech/reference/post_v3-ai-audio-transcriptions.md): ## Overview Transcribe audio files using multiple providers (OpenAI Whisper, OpenAI GPT-4o Transcribe, Google Chirp). Supports file upload via multipart form data.  ### Supported Models | Provider |…
- AI Chat Completion Runs
  - [Retrieve a ChatCompletionRun](https://developers.intandem.tech/reference/get_v3-ai-chat-completion-runs-uid.md): ## Overview Get the status and result of an async chat completion job. Poll this endpoint until status is COMPLETED or FAILED.  **Available for Staff tokens**
  - [List ChatCompletionRuns](https://developers.intandem.tech/reference/get_v3-ai-chat-completion-runs.md): ## Overview Retrieve a paginated list of chat completion runs for the authenticated client. Supports sorting by field and direction.  **Available for Staff tokens**
- AI Transcription Runs
  - [Retrieve a TranscriptionRun](https://developers.intandem.tech/reference/get_v3-ai-transcription-runs-uid.md): ## Overview Get the status and result of an async transcription job. Poll this endpoint until status is COMPLETED or FAILED.  **Available for Staff tokens**
  - [List TranscriptionRuns](https://developers.intandem.tech/reference/get_v3-ai-transcription-runs.md): ## Overview Retrieve a paginated list of transcription runs for the authenticated client. Supports sorting by field and direction.  **Available for Staff tokens**
- AI Generation Feedback
  - [The AIGenerationFeedback Object](https://developers.intandem.tech/reference/aigenerationfeedback.md)
  - [Create new AI generation feedback](https://developers.intandem.tech/reference/createaigenerationfeedback.md): ## Overview Submit feedback for AI-generated content.  **Available for Staff tokens**
- AI Recommendations
  - [The AIRecommendation Object](https://developers.intandem.tech/reference/airecommendation.md)
  - [Get all AIRecommendations](https://developers.intandem.tech/reference/get_v3-ai-ai-recommendations.md): ## Overview Retrieve a list of AIRecommendations with optional filtering by status, target, context, producer, and action UID.  Available for **Staff, Directory, and Client tokens**
  - [Create an AIRecommendation](https://developers.intandem.tech/reference/post_v3-ai-ai-recommendations.md): ## Overview Create a new AIRecommendation.  **Available for Staff tokens**
  - [Update an AIRecommendation](https://developers.intandem.tech/reference/put_v3-ai-ai-recommendations-uid.md): ## Overview Update an existing AIRecommendation by UID.  **Available for Staff tokens**
  - [Get an AIRecommendation by uid](https://developers.intandem.tech/reference/getairecommendation.md): ## Overview Retrieve a single AIRecommendation by uid, scoped to the requesting staff member.  Unlike the list endpoint, this endpoint applies no defaults: the recommendation is returned in any…
- AI Recommended Actions
  - [The AIRecommendedAction Object](https://developers.intandem.tech/reference/airecommendedaction.md)
- AI Business Rules
  - [Get all BusinessRules](https://developers.intandem.tech/reference/businessrulescontroller_getbusinessrules.md): ## Overview Get a list of all business rules for the authenticated business. Optionally filter by category.  Available for **Staff** tokens.
  - [Create a BusinessRule](https://developers.intandem.tech/reference/businessrulescontroller_createbusinessrule.md): ## Overview Create a new business rule for the authenticated business.  Available for **Staff** tokens.
  - [Retrieve a BusinessRule](https://developers.intandem.tech/reference/businessrulescontroller_getbusinessrule.md): ## Overview Retrieve a specific business rule based on its unique identifier (UID).  Available for **Staff** tokens.
  - [Update a BusinessRule](https://developers.intandem.tech/reference/businessrulescontroller_updatebusinessrule.md): ## Overview Update an existing business rule by UID. All fields are optional - only provided fields will be updated.  Available for **Staff** tokens.
  - [Delete a BusinessRule](https://developers.intandem.tech/reference/businessrulescontroller_deletebusinessrule.md): ## Overview Delete a business rule by UID.  Available for **Staff** tokens.
  - [Get all BusinessRule History Records](https://developers.intandem.tech/reference/businessrulescontroller_gethistory.md): ## Overview Get the change history for business rules. Supports optional filtering by rule UID and action type, with pagination.  Available for **Staff** tokens.
  - [Retrieve a BusinessRule History Record](https://developers.intandem.tech/reference/businessrulescontroller_gethistoryrecord.md): ## Overview Retrieve a specific history record by its unique identifier (UID).  Available for **Staff** tokens.
  - [Bulk import business rules](https://developers.intandem.tech/reference/businessrulescontroller_createbulkimportjob.md): ## Overview Create an async job to extract business rules from raw text using LLM. The system analyzes content, extracts rules, classifies by category, and deduplicates against existing rules.  ##…
- Business AI Settings
  - [Retrieve a BusinessAiSettings](https://developers.intandem.tech/reference/getbusinessaisettings.md): ## Overview Retrieve the AI settings of a business. Every known key is returned, with its default filled in for keys the business has never changed, so the response is the same whether or not the…
  - [Update a BusinessAiSettings](https://developers.intandem.tech/reference/updatebusinessaisettings.md): ## Overview Create or update the AI settings of a business. Keys left out of the request keep their stored value, and unknown keys are rejected.  The business is resolved from the token - a staff…
- BizAI Chats
  - [The BizAIChat Object](https://developers.intandem.tech/reference/the-aichat-object.md)
  - [Get all BizAIChats](https://developers.intandem.tech/reference/chatscontroller_getchats.md): ## Overview Get a list of all chat sessions.  Available for **Staff, Directory, and Client tokens**
  - [Create a BizAIChat](https://developers.intandem.tech/reference/chatscontroller_createchat.md): ## Overview Create a new chat session between a user and an agent Available for **Staff Tokens**.
  - [Retrieve a BizAIChat](https://developers.intandem.tech/reference/chatscontroller_getchat.md): ## Overview Retrieve a specific BizAIChat session based on its unique identifier (UID).  Available for **Staff, Directory, and Client tokens**
- BizAI Chat Messages
  - [The BizAIChatMessage Object](https://developers.intandem.tech/reference/the-aichatmessage-object.md)
  - [The BizAIChatStreamMessage Object](https://developers.intandem.tech/reference/the-aichatstreammessage-object.md)
  - [Get all BizAIChatMessages](https://developers.intandem.tech/reference/chatmessagescontroller_getmessages.md): ## Overview Get all BizAIChatMessages exchanged within a specific chat.  Available for **Staff, Directory, and Client tokens**
  - [Create a BizAIChatMessage](https://developers.intandem.tech/reference/chatmessagescontroller_createmessage.md): ## Overview Create a new BizAIChatMessage in a BizAIChat thread and get an AI response Available for **Staff Tokens**.
- Staff AI Settings
  - [Retrieve a StaffAiSettings](https://developers.intandem.tech/reference/get_v3-ai-staff-ai-settings-staff-uid.md): ## Overview Retrieve a specific StaffAiSettings based on staff unique identifier.  **Available for Staff tokens**
  - [Update a StaffAiSettings](https://developers.intandem.tech/reference/put_v3-ai-staff-ai-settings-staff-uid.md): ## Overview Update AI settings for a specific staff member based on their unique identifier. Users can only update their own settings.  **Available for Staff tokens**
  - [The StaffAISettings Object](https://developers.intandem.tech/reference/the-staffaisettings-object.md)

## API Reference: Apps
- Navigation Items
  - [Navigation Item](https://developers.intandem.tech/reference/navigation-item.md): Represents a navigation menu item that defines how partners configure their platform navigation structure. Navigation items support hierarchical menus, localized titles, permission-based visibility,…
  - [List Navigation Items](https://developers.intandem.tech/reference/listnavigationitems.md): Retrieve a paginated list of navigation items for the authenticated directory. Supports filtering by parent and mobile availability. Available for **Staff & Directory tokens**.
  - [Create a Navigation Item](https://developers.intandem.tech/reference/createnavigationitem.md): Create a new navigation item for the authenticated directory. The directory_uid is automatically set from the authenticated token context. Available for **Directory tokens**.
  - [Update a Navigation Item](https://developers.intandem.tech/reference/updatenavigationitem.md): Update an existing navigation item. Only provided fields will be updated. Available for **Directory tokens**.
  - [Delete a Navigation Item](https://developers.intandem.tech/reference/deletenavigationitem.md): Delete a navigation item. Items with children cannot be deleted until all children are removed first. Available for **Directory tokens**.
- App Business Mappings
  - [The AppBusinessMapping Object](https://developers.intandem.tech/reference/the-appbusinessmapping-object.md)
  - [List App Business Mappings](https://developers.intandem.tech/reference/listappbusinessmappings.md): Returns a paginated list of app business mappings for the caller. For **Directory tokens**, returns mappings belonging to the authenticated directory, with optional filtering by business_uid and…
  - [Create an App Business Mapping](https://developers.intandem.tech/reference/createappbusinessmapping.md): Create a new mapping between a vcita business and third-party app identifiers for a specific integrated app. Available for **Directory tokens**.
  - [Get an App Business Mapping](https://developers.intandem.tech/reference/getappbusinessmapping.md): Retrieve a single app business mapping by uid. For **Directory tokens**, returns any mapping owned by the authenticated directory. For **Staff tokens**, returns the mapping only if it belongs to the…
  - [Update an App Business Mapping](https://developers.intandem.tech/reference/updateappbusinessmapping.md): Update an existing app business mapping. Only provided fields will be updated. business_uid cannot be changed. directory_uid can only be modified when using an **Internal token**; if directory_uid is…
  - [Delete an App Business Mapping](https://developers.intandem.tech/reference/deleteappbusinessmapping.md): Delete an app business mapping by uid. Available for **Directory tokens**.
- Applications
  - [The App Object](https://developers.intandem.tech/reference/the-app-object.md)
  - [Get an App](https://developers.intandem.tech/reference/apps_get.md): Retrieve a single app by uid.  **Available for Staff, Directory, and Internal Tokens.**
  - [List all Apps](https://developers.intandem.tech/reference/apps_list.md): Returns apps available to the caller. Apps can be available because they are installed, offered by the directory, or assigned as internal.  **Available for Staff, Directory, and Internal Tokens.**
  - [Creates an app](https://developers.intandem.tech/reference/post_platform-v1-apps.md): ## Overview Create a new app.  **Available for Directory and internal Tokens.**
  - [List of apps](https://developers.intandem.tech/reference/get_platform-v1-apps.md): Retrieve a list of available apps. Response format varies by token type - Staff tokens receive detailed app data including full configuration, while Directory tokens receive simplified app data for…
  - [Read an app](https://developers.intandem.tech/reference/get_platform-v1-apps-id.md): ## Overview Retrieve an app by code name. Available for **Staff and Directory Tokens**.
  - [Updates an app](https://developers.intandem.tech/reference/put_platform-v1-apps-id.md): ## Overview Update an app by code name.  ## Authentication **Available for Internal Tokens and Directory Tokens.**  ### Token Type Behavior - **Internal Tokens**: Can update any app, including the…
  - [Unassign an app on directory or a business [Internal]](https://developers.intandem.tech/reference/post_platform-v1-apps-id-unassign.md): ## Overview Unassign an application from a business or directory.  **⚠️ DEPRECATED**: Use `DELETE /v3/apps/app_assignments/{uid}` instead.  ## Authentication **Available for Internal Tokens and…
  - [Update app translations](https://developers.intandem.tech/reference/put_platform-v1-apps-translations-app-code-name.md): ## Overview Updates the translations for an app. The translations must be provided as a CSV file with a specific format. The CSV should have columns for: Key, Context, Character Limit, en, es, fr,…
  - [[DEPRECATED] Assign an app](https://developers.intandem.tech/reference/post_platform-v1-apps-id-assign.md): ## Overview Assign an application to a business or directory so it appears in the App Market.  **⚠️ DEPRECATED**: Use `POST /v3/apps/app_assignments` instead.  ## Authentication **Available for…
  - [Install an app [DEPRECATED]](https://developers.intandem.tech/reference/post_platform-v1-apps-id-install-app.md): ## Overview Install an app for the authorized business - **⚠️ DEPRECATED**: Use `POST /v3/apps/business_app_installs` instead.  **Available for Staff Tokens**
  - [Uninstall an app [Deprecated]](https://developers.intandem.tech/reference/post_platform-v1-apps-id-uninstall-app.md): ## Overview Uninstall an app for the authorized business. **⚠️ DEPRECATED**: Use `DELETE /v3/apps/business_app_installs/{uid}` instead.  **Available for Staff Tokens**
- Business App Installs
  - [The BusinessAppInstall object](https://developers.intandem.tech/reference/the-businessappinstall-object.md)
  - [List Business App Installs](https://developers.intandem.tech/reference/businessappinstalls_list.md): Get a list of installed apps per business. Each item includes a uid; use it in the show and delete paths. Optional query filters: business_uid, app_code_name, page, per_page. **Available for Staff &…
  - [Create a Business App Install](https://developers.intandem.tech/reference/businessappinstalls_create.md): Install an app for a business. **Available for Staff & Directory Tokens**
  - [Get a Business App Install](https://developers.intandem.tech/reference/businessappinstalls_show.md): Get a single business app install by uid. **Available for Staff & Directory Tokens**
  - [Delete a Business App Install](https://developers.intandem.tech/reference/businessappinstalls_destroy.md): Uninstall an app for a business. **Available for Staff & Directory Tokens**
- App Assignments
  - [The AppAssignment Object](https://developers.intandem.tech/reference/appassignment-entity.md)
  - [Create an App Assignment](https://developers.intandem.tech/reference/appassignments_create.md): ## Overview Create a new app assignment to a business, package or directory.  **Available for Directory Tokens and Internal Tokens only.** Staff and Business tokens are not supported and will return…
  - [Delete an App Assignment](https://developers.intandem.tech/reference/appassignments_delete.md): ## Overview Delete an app assignment.  **Available for Directory and internal Tokens**
  - [List App Assignments](https://developers.intandem.tech/reference/appassignments_list.md): Returns app assignments across multiple businesses within a directory, with optional filtering. Note: assignee_uid can only be used when assignee_type is also provided.  **Available for Directory and…
- Service OAuth
  - [Generate an app access token](https://developers.intandem.tech/reference/post_oauth-service-token.md): ## Overview Generate an app access token using OAuth client credentials flow. **No bearer token required** - authentication is via service_id and service_secret in the request body.  ## Prerequisites…
- Widget
  - [The Widget Object](https://developers.intandem.tech/reference/the-widget-object.md)
  - [Create a Widget](https://developers.intandem.tech/reference/widgets_create.md): ## Overview Create a new widget.  ## Authentication **Available for App Tokens only.** The app must have `app_type='widgets'` to create widgets. Apps with other types will receive 403: 'This app's…
  - [Get all Widgets](https://developers.intandem.tech/reference/widgets_getall.md): ## Overview Get all widgets for the authenticated app.  ## Authentication **Available for App Tokens only.** The app must have `app_type='widgets'` to access widgets. Apps with other types will…
  - [Update Widget](https://developers.intandem.tech/reference/widgets_update.md): ## Overview Update an existing widget.  ## Authentication **Available for App Tokens only.** The app must have `app_type='widgets'`. Apps with other types will receive 403: 'This app's type does not…
- Staff Widgets Board
  - [The StaffWidgetsBoard Object](https://developers.intandem.tech/reference/the-staffwidgetsboard-object.md)
  - [Create a Staff Widgets Board](https://developers.intandem.tech/reference/staffwidgetsboard_create.md): ## Overview Creates a widgets board for staff member.  **Uniqueness Constraint**: Each staff member can only have ONE board per `type` value. For example, a staff member cannot have two boards with…
  - [Get all Widgets Boards Of The Staff](https://developers.intandem.tech/reference/staffwidgetsboard_getall.md): ## Overview Returns the widgets boards for staff member.  **Available for Staff Tokens**
  - [Update a Staff Widgets Board](https://developers.intandem.tech/reference/staffwidgetsboard_update.md): ## Overview Update a staff widget board.  **Available for Staff Tokens**
- Staff Widgets Boards Template
  - [The StaffWidgetsBoardsTemplate Object](https://developers.intandem.tech/reference/the-staffwidgetsboardstemplate-object.md)
  - [Create a Staff Widgets Boards Template](https://developers.intandem.tech/reference/staffwidgetsboardstemplate_create.md): ## Overview Create a staff widget board template.  **Available for Directory Tokens only.**  **Uniqueness Constraint**: Each staff member can only have ONE active widgets boards template. Creating a…
  - [Delete a Staff Widgets Boards Template](https://developers.intandem.tech/reference/staffwidgetsboardstemplate_delete.md): ## Overview Delete a staff widget board template. **Only.  **available for Directory Tokens**
  - [Get all Staff Widgets Boards Templates](https://developers.intandem.tech/reference/staffwidgetsboardstemplate_getall.md): ## Overview Get all staff widget board templates. **Only.  **available for Directory Tokens**
  - [Update a Staff Widgets Boards Template](https://developers.intandem.tech/reference/staffwidgetsboardstemplate_update.md): ## Overview Update an existing staff widget board template.  **Available for Directory Tokens only.**  ## Prerequisites - The `uid` path parameter must be a valid UID from an existing staff widgets…
- JWKS
  - [The Compact JWS token entity](https://developers.intandem.tech/reference/the-compact-jws-token-entity.md)
  - [Create a compact JWS token](https://developers.intandem.tech/reference/post_v3-apps-compact-jws-tokens.md): ## Overview Create a new compact JWS token that can be used to authenticate a staff member to an app in inTandem using a JWKS process. The token is signed by the app's private key and can be verified…
  - [Bulk create compact JWS tokens](https://developers.intandem.tech/reference/post_v3-apps-compact-jws-tokens-bulk.md): ## Overview Create multiple compact JWS tokens for a list of app code names. The response will include the success, generated token (if successful), or error details for each app code name.…

## API Reference: Assets
- Files
  - [Create a new file](https://developers.intandem.tech/reference/filescontroller_upload.md): Create a new file for the specified business. The API returns immediately with status='pending'. File processing (virus scan, S3 upload, thumbnail generation) happens asynchronously in the…
  - [Get all files](https://developers.intandem.tech/reference/filescontroller_findall.md): Retrieves the files you uploaded, optionally filtered by status or a list of file UIDs. Each token only sees files it created itself; files uploaded by other users are not returned. Results include…
  - [Get a file](https://developers.intandem.tech/reference/filescontroller_findone.md): Retrieves a specific file by its unique identifier. Only the file you uploaded is returned; requesting a file created by another user returns 404.  Used for status polling after upload to check if…
  - [Delete a file](https://developers.intandem.tech/reference/filescontroller_delete.md): Soft deletes a specific file. The file's S3 objects (original and thumbnails) are removed immediately; the record is retained as soft-deleted and excluded from all reads.  Available for **Staff…
- File Relations
  - [Create a file relation](https://developers.intandem.tech/reference/filerelationscontroller_create.md): Links an existing file to a business entity (e.g., an invoice, message, or meeting). The referenced file must already exist and must not be infected, failed, or deleted; linking is allowed while the…
  - [Get file relations by entity](https://developers.intandem.tech/reference/filerelationscontroller_findbyentity.md): Retrieves the file relations for a given entity, each including the linked file's details. Results are paginated.  Staff access is scoped to the linked entity: a staff sees relations for any entity…
  - [Delete a file relation](https://developers.intandem.tech/reference/filerelationscontroller_deleterelation.md): Soft deletes a single file relation by its unique identifier. If it was the file's last active relation, the file may become eligible for cleanup.  A Staff token must have access to the related…
- Forms
  - [Get Leave Details Form](https://developers.intandem.tech/reference/get_client-api-v1-portals-business-uid-contact-get-form-1.md): ## Overview Gets the leave details form of the business.  ## Authentication **Available for Client Tokens only.**
  - [Submits Leave Details Form](https://developers.intandem.tech/reference/post_client-api-v1-portals-business-uid-contact-submit-1.md): ## Overview Submits Leave Details Form to the business.  ## Authentication **Available for Client Tokens only.**  ## Required Fields Before submitting, call `GET…
  - [Get Share Documents Form](https://developers.intandem.tech/reference/get_client-api-v1-portals-business-uid-share-documents-form-get-form-1.md): ## Overview Gets the share documents form of the business.  ## Authentication **Available for Client Tokens only.**
  - [Submits Share Documents Form](https://developers.intandem.tech/reference/post_client-api-v1-portals-business-uid-share-documents-form-submit-1.md): ## Overview Submits Share Documents Form to the business.  ## Authentication **Available for Client Tokens only.**  ## Critical Requirement The `matter_uid` query parameter must reference a matter…
  - [Get Forms List](https://developers.intandem.tech/reference/get_platform-v1-forms.md): ## Overview Get forms list.  ## Authentication **Available for Staff, App, and Directory tokens.**
  - [Updates a Form](https://developers.intandem.tech/reference/put_platform-v1-forms.md): ## Overview Update a Form.  ## Authentication **Available for Staff, App, and Directory tokens.**
- Documents
  - [Get Documents For A Client](https://developers.intandem.tech/reference/get_platform-v1-clients-client-id-documents-1.md): ## Overview Gets a list of documents for a client.  ## Authentication **Available for Staff, App, and Directory Tokens.**
- Search
  - [Search docuforms activities](https://developers.intandem.tech/reference/get_v2-search-search-docuforms-1.md): ## Overview Searches for docuforms (documents and forms) activities within the business. Results are scoped based on the requesting staff member's permissions.  ### Staff Scoping - **Admin staff**…

## API Reference: Clients
- Fields
  - [Get Fields List](https://developers.intandem.tech/reference/get_platform-v1-fields.md): ## Overview Get custom fields list.  Every business starts with the built-in `contact` fields Email, First Name, Last Name, Phone, Address, and Birthday; fields created with `POST…
  - [Create a New Field](https://developers.intandem.tech/reference/post_platform-v1-fields.md): ## Overview Create a custom field for contacts or matters.  ## Built-in contact fields Every business already has these `contact` fields: Email, First Name, Last Name, Phone, Address, and Birthday (a…
  - [Get Field Details](https://developers.intandem.tech/reference/get_platform-v1-fields-field-id.md): ## Overview Get specific field details.
  - [Updates a Field](https://developers.intandem.tech/reference/put_platform-v1-fields-field-id.md): ## Overview Updates a Field Available for **Staff, App, and Directory tokens**.
  - [Deletes a Field](https://developers.intandem.tech/reference/delete_platform-v1-fields-field-id.md): ## Overview Deletes a Field Available for **Staff, App, and Directory tokens**.
- Search
  - [Search business data](https://developers.intandem.tech/reference/get_v2-search.md): ## Overview Searches across business data entities including clients, conversations, bookings, appointments, estimates, payments, and documents. The search is powered by an Elasticsearch-based Seeker…
- Deposits
  - [Show Deposit](https://developers.intandem.tech/reference/get_client-payments-v1-deposits-deposit-uid.md): ## Overview Show specific deposit details.  ## Authentication **Available for Client Tokens only.**  ## Parameters - `deposit_uid`: The unique identifier of the deposit - `matter_uid`: (Optional)…
- Managing Clients
  - Matters
    - [Import clients app](https://developers.intandem.tech/reference/post_business-clients-v1-apps-app-code-name-import.md): ## Overview Import clients to an app. Creates client records based on the provided field mappings.  ## Authentication **Available for Staff, App, and Directory tokens.**  ## Prerequisites 1. The app…
    - [Gets Matters by filter](https://developers.intandem.tech/reference/get_business-clients-v1-matters.md): ## Overview Gets Matters by filter. Searchable fields are: Email, First name, Last name, Matter name and Phone.  ## Required Parameters You must provide a `filter` parameter to search. Without it,…
    - [Gets the collaborators of a Matter](https://developers.intandem.tech/reference/get_business-clients-v1-matters-matter-uid-collaborators.md): ## Overview Gets the collaborators of a Matter.  ## Authentication **Available for Staff, App, and Directory Tokens.**
    - [Adds a collaborator to a Matter](https://developers.intandem.tech/reference/post_business-clients-v1-matters-matter-uid-collaborators.md): ## Overview Adds a collaborator to a Matter Available for **Staff, App, and Directory tokens**.
    - [Removes a collaborator from a Matter](https://developers.intandem.tech/reference/delete_business-clients-v1-matters-matter-uid-collaborators-staff-uid.md): ## Overview Removes a collaborator from a Matter Available for **Staff, App, and Directory tokens**.
    - [Nest a matter under another contact person](https://developers.intandem.tech/reference/put_business-clients-v1-matters-matter-uid-nest.md): ## Overview Moves a matter from its current contact to a different destination contact (nesting). The source contact is automatically deleted if it has no remaining matters after the nesting…
    - [Gets a list of notes](https://developers.intandem.tech/reference/get_business-clients-v1-matters-matter-uid-notes.md): ## Overview Gets a list of notes.  ## Authentication **Available for Staff, App, and Directory Tokens.**
    - [Adds a note](https://developers.intandem.tech/reference/post_business-clients-v1-matters-matter-uid-notes.md): ## Overview Adds a note Available for **Staff, App, and Directory tokens**.
    - [Remove a note](https://developers.intandem.tech/reference/delete_business-clients-v1-matters-matter-uid-notes-note-uid.md): ## Overview Remove a note Available for **Staff, App, and Directory tokens**.
    - [Get a note](https://developers.intandem.tech/reference/get_business-clients-v1-matters-matter-uid-notes-note-uid.md): ## Overview Get a note.  ## Authentication **Available for Staff, App, and Directory Tokens.**
    - [Update a note](https://developers.intandem.tech/reference/put_business-clients-v1-matters-matter-uid-notes-note-uid.md): ## Overview Update a note Available for **Staff, App, and Directory tokens**.
    - [Reassign staff to Matter](https://developers.intandem.tech/reference/put_business-clients-v1-matters-matter-uid-reassign.md): ## Overview Reassign staff to Matter Available for **Staff, App, and Directory tokens**.
    - [Remove a tag from a Matter](https://developers.intandem.tech/reference/delete_business-clients-v1-matters-matter-uid-tags.md): ## Overview Remove a tag from a single Matter (one matter_uid in path, one tag in body). For bulk remove use DELETE /v1/tags. Available for **Staff, App, and Directory tokens**.
    - [Gets a list of tags of a Matter](https://developers.intandem.tech/reference/get_business-clients-v1-matters-matter-uid-tags.md): ## Overview Gets a list of tags of a Matter.  ## Authentication **Available for Staff, App, and Directory Tokens.**
    - [[Deprecated] Adds a tag to a Matter](https://developers.intandem.tech/reference/post_business-clients-v1-matters-matter-uid-tags.md): ## Overview **Deprecated.** Use **PUT /v1/tags** instead (bulk add with body `new_api`, `matters.uids`, `tags`). This endpoint adds a single tag to one matter. Available for **Staff, App, and…
    - [Gets a Matter](https://developers.intandem.tech/reference/get_business-clients-v1-matters-uid.md): ## Overview Gets a Matter.  ## Authentication **Available for Staff, App, and Directory Tokens.**
    - [Updates a Matter](https://developers.intandem.tech/reference/put_business-clients-v1-matters-uid.md): ## Overview Updates a Matter.  ## Authentication **Available for Staff, App, and Directory tokens.**  ## Validation - `uid` (path parameter): Must be a valid matter UID that exists and is accessible…
    - [Show business client settings](https://developers.intandem.tech/reference/get_business-clients-v1-settings.md): ## Overview Get settings.  ## Authentication **Available for Staff, App, and Directory Tokens.**
    - [Update business client settings](https://developers.intandem.tech/reference/put_business-clients-v1-settings.md): ## Overview Update settings Available for **Staff, App, and Directory tokens**.
    - [Gets Matters of a contact](https://developers.intandem.tech/reference/get_business-clients-v1-contacts-client-uid-matters.md): ## Overview Gets Matters of a client.  ## Authentication **Available for Staff, App, and Directory Tokens.**
    - [Create a new Matter](https://developers.intandem.tech/reference/post_business-clients-v1-contacts-client-uid-matters.md): ## Overview Create a new Matter for a contact.  ## Important Context Creating a client via POST /platform/v1/clients automatically creates a first matter. This endpoint is used to create **additional…
    - [Bulk add tags to matters](https://developers.intandem.tech/reference/put_business-clients-v1-tags.md): ## Overview Bulk add tags to one or more matters. This is the endpoint used by the product (e.g. with Staff token). Send `new_api: true`, `matters.uids` (array of matter UIDs), and `tags` (array of…
    - [Bulk remove tags from matters](https://developers.intandem.tech/reference/delete_business-clients-v1-tags.md): ## Overview Bulk remove tags from one or more matters. Same contract as PUT: send `matters.uids` (array of matter UIDs) and `tags` (array of tag strings to remove). Optional query param `new_api:…
    - [List of clients that can be used as primary for merge.](https://developers.intandem.tech/reference/get_platform-v1-clients-merges-possible-merge-master.md): ## Overview Returns a list of client UIDs that can be used as a primary client for the merge.  ## Authentication **Available for Staff, App, and Directory Tokens.**  ## Required Parameters -…
    - [Merge duplicate clients into a primary client.](https://developers.intandem.tech/reference/put_platform-v1-clients-merges-merge-clients.md): ## Overview Merge two or more duplicate clients into one primary client.  ## Authentication **Available for Staff, App, and Directory tokens.**  ## Query Parameters - `to_client_uid` (required): UID…
  - Client Packages
    - [Validate Credit Availability [Alpha]](https://developers.intandem.tech/reference/get_platform-v1-clients-payment-client-packages-validate.md): ## Overview Check whether the authenticated client has an active package with available credits for the service associated with a given payment status. Use this to determine if the "pay with package"…
    - [Use Client Package Credit [Alpha]](https://developers.intandem.tech/reference/post_platform-v1-clients-payment-client-packages-update-usage.md): ## Overview Redeem a credit from the authenticated client's active package to pay for an appointment or service session. This marks the associated payment status as paid (price set to $0) and…
  - Clients
    - [Bulk Update Clients](https://developers.intandem.tech/reference/bulkupdateclients.md): ## 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.…
    - [Deletes a Client by Id](https://developers.intandem.tech/reference/delete_platform-v1-clients-client-id.md): ## Overview Deletes a Client Available for **Staff, App, and Directory tokens**.
    - [Get Clients](https://developers.intandem.tech/reference/get_platform-v1-clients.md): ## 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…
    - [Retrieves a Client by Id](https://developers.intandem.tech/reference/get_platform-v1-clients-client-id.md): ## Overview Retrieves a Client.  ## Authentication **Available for Staff, App, and Directory Tokens.**
    - [Create a Client](https://developers.intandem.tech/reference/post_platform-v1-clients.md): ## 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…
    - [Updates a Client](https://developers.intandem.tech/reference/put_platform-v1-clients-client-id.md): ## Overview Update a Client Available for **Staff, App, and Directory tokens**.
  - Estimates
    - [Get Estimates Of Client](https://developers.intandem.tech/reference/get_platform-v1-clients-client-id-estimates.md): ## Overview Gets a list of estimates for a client.  ## Authentication **Available for Directory tokens only.** Requires `X-On-Behalf-Of` header with the business UID.  **Note**: Staff OAuth tokens…
  - Invoices
    - [Get Invoices Of Client](https://developers.intandem.tech/reference/get_platform-v1-clients-client-id-invoices.md): ## Overview Gets a list of invoices for a client.  ## Authentication **Available for Staff, App, and Directory Tokens.**  ## Prerequisites **Requires business feature `invoicing_features`** (payments…
  - Payments
    - [Get Payments of Client](https://developers.intandem.tech/reference/get_platform-v1-clients-client-id-payments.md): ## Overview Gets a list of payments for a client.  ## Authentication **Available for Staff, App, and Directory Tokens.**
  - Views
    - [Delete a view](https://developers.intandem.tech/reference/delete_business-search-v1-views-uid.md): ## Overview Delete a custom view - Delete a custom view - Available for **Staff, App, and Directory Tokens**.
    - [Get a specific view](https://developers.intandem.tech/reference/get_business-search-v1-views-uid.md): ## Overview Retrieve a specific view by UID.  ## Authentication **Available for Staff, App, and Directory Tokens.**
    - [Get all views](https://developers.intandem.tech/reference/get_business-search-v1-views.md): ## Overview Retrieve all views for the authenticated business.  ## Authentication **Available for Staff, App, and Directory Tokens.**
    - [Bulk update views](https://developers.intandem.tech/reference/post_business-search-v1-views-bulk.md): ## Overview Update multiple views in bulk - Update multiple views in bulk - Available for **Staff, App, and Directory Tokens**.
    - [Create a new view](https://developers.intandem.tech/reference/post_business-search-v1-views.md): ## Overview Create a new custom view - Create a new custom view - Available for **Staff, App, and Directory Tokens**.
    - [Update a view](https://developers.intandem.tech/reference/put_business-search-v1-views-uid.md): ## 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`,…
  - Views Columns
    - [Get available columns](https://developers.intandem.tech/reference/get_business-search-v1-views-columns.md): ## Overview Retrieve all available columns for creating views.  ## Authentication **Available for Staff, App, and Directory Tokens.**
  - View Filters
    - [Get available filters](https://developers.intandem.tech/reference/get_business-search-v1-view-filters.md): ## Overview Retrieve all available filters for creating views.  ## Authentication **Available for Staff, App, and Directory Tokens.**
- [Client Portal](https://developers.intandem.tech/reference/client-portal.md): Dedicated end point for clients
  - Apps
    - [Get External Connected Payment Application](https://developers.intandem.tech/reference/get_client-payments-v1-apps-primary-provider-connected-application.md): ## Overview Get External Connected Payment Application.  ## Authentication **Available for Client Tokens only.**  ## Prerequisites Requires a payment application (app_type=payments) to be installed…
  - Cards
    - [Create New Card On File](https://developers.intandem.tech/reference/post_client-payments-v1-cards.md): ## Overview Create New Card On File.  ## Authentication **Available for Client Tokens only.**  ## Prerequisites Requires an active payment processor connection (Stripe, vcitaPayments, etc.) to be…
    - [Get most recent pending card added to client [Alpha]](https://developers.intandem.tech/reference/get_client-payments-v1-cards-get-new-card.md): ## Overview Get most recent pending card added to client [Alpha].  ## Authentication **Available for Client Tokens only.**
    - [Create New Save Card Session](https://developers.intandem.tech/reference/post_client-payments-v1-cards-save-card-session.md): ## Overview Create New Save Card Session. Creates a Stripe Checkout session for securely saving a card.  ## Authentication **Available for Client Tokens only.**  ## Prerequisites 1. Business must…
  - Carts
    - [Create Cart](https://developers.intandem.tech/reference/post_client-payments-v1-carts.md): ## Overview Creates a Cart.  ## Authentication **Available for Client Tokens only.**  ## Request Format The request body must be wrapped in a 'cart' object with required fields: matter_uid, currency,…
    - [Show Cart](https://developers.intandem.tech/reference/get_client-payments-v1-carts-cart-uid.md): ## Overview Show specific cart data.  ## Authentication **Available for Client Tokens only.**
  - Client Packages
    - [List Client Packages](https://developers.intandem.tech/reference/get_client-payments-v1-client-packages.md): ## Overview Retrieve a paginated list of client packages (package subscriptions) for the authenticated client, scoped to a specific matter/conversation. Returns each package's validity dates, credit…
  - Client Settings
    - [The ClientSettings Object](https://developers.intandem.tech/reference/the-clientsettings-object.md)
    - [Bulk Update Client Settings](https://developers.intandem.tech/reference/put_v3-clients-client-settings-bulk.md): ## Overview Bulk update client settings for multiple clients in a single operation. Supports partial success - individual clients can fail while others succeed.  ## Currently Supported Field This…
    - [Retrieve Client Settings](https://developers.intandem.tech/reference/get_v3-clients-client-settings-client-uid.md): ## Overview Get the client settings for a specific client.  ## Authentication **Available for Staff and Client Tokens.**
    - [Update Client Settings](https://developers.intandem.tech/reference/put_v3-clients-client-settings-client-uid.md): ## Overview Update the client settings for a specific client - Update the client settings for a specific client - Available for **Staff and Client Tokens**.
  - Deposits
    - [Show Deposits List](https://developers.intandem.tech/reference/get_client-payments-v1-deposits.md): ## Overview Show list of deposits.  ## Authentication **Available for Client Tokens only.**  ## Required Parameters - `matter_uid` (query, **required**): The matter UID to fetch deposits for. Returns…
  - Invoices
    - [Show Invoices List](https://developers.intandem.tech/reference/get_client-payments-v1-invoices.md): ## Overview Show list of invoices.  ## Authentication **Available for Client Tokens only.**
  - Packages
    - [List Catalog Packages (Public) [Alpha]](https://developers.intandem.tech/reference/get_client-payments-v1-packages.md): ## Overview Retrieve the list of available package catalog templates for a business, as seen from the client perspective. Returns packages that clients can browse and potentially purchase through the…
    - [Show Catalog Package (Public) [Alpha]](https://developers.intandem.tech/reference/get_client-payments-v1-packages-package-id.md): ## Overview Retrieve detailed information for a single package catalog template, as seen from the client perspective. Returns the package's pricing, included services, expiration settings, and…
  - Payment Requests
    - [Get Payment Requests List](https://developers.intandem.tech/reference/get_client-payments-v1-payment-requests.md): ## Overview Show list of payment requests.  ## Authentication **Available for Client Tokens only.**  ## Required Parameters - `matter_uid` (required): The matter UID to fetch payment requests for.
    - [Get Checkout Session](https://developers.intandem.tech/reference/get_client-payments-v1-payment-requests-payment-request-uid-checkout.md): ## Overview Get the checkout session of a given payment request. Available for **Client tokens**.  ## Authentication This endpoint is designed for client checkout flows and may also work without…
  - Payments
    - [Show Payments List](https://developers.intandem.tech/reference/get_client-payments-v1-payments.md): ## Overview Show list of payments.  ## Authentication **Available for Client Tokens only.**
  - Product Orders
    - [Show Product Orders List](https://developers.intandem.tech/reference/get_client-payments-v1-product-orders.md): ## Overview Show list of product orders.  ## Authentication **Available for Client Tokens only.**
- Client Notes
  - [Get all ClientNotes](https://developers.intandem.tech/reference/get_v3-clients-client-notes.md): Get a list of ClientNotes for a specific matter  Available for **Staff tokens**
  - [Create a ClientNote](https://developers.intandem.tech/reference/post_v3-clients-client-notes.md): Create a new note for a client matter  Available for **Staff tokens**
  - [Retrieve a ClientNote](https://developers.intandem.tech/reference/get_v3-clients-client-notes-uid.md): Retrieve a specific ClientNote based on it's unique identifier (UID)  Available for **Staff tokens**
  - [Update a ClientNote](https://developers.intandem.tech/reference/put_v3-clients-client-notes-uid.md): Update an existing note for a client matter. At least one of title or content must be provided in the request. Additionally, the resulting note must have at least one of title or content non-empty…
  - [Delete a ClientNote](https://developers.intandem.tech/reference/delete_v3-clients-client-notes-uid.md): Delete a specific ClientNote based on it's unique identifier (UID)  Available for **Staff tokens**
- Client Messages
  - [Send a Client Message](https://developers.intandem.tech/reference/post_client-messaging-v1-messages.md): ## Overview Sends a message from the authenticated client to the business. The message direction is always `client_to_business` — it is set automatically by the server based on the client token.  The…

## API Reference: Communication
- Telephony
  - Available Phone Numbers
    - [The AvailablePhoneNumber Object](https://developers.intandem.tech/reference/availablephonenumber.md)
    - [Retrieve All AvailablePhoneNumbers](https://developers.intandem.tech/reference/availablephonenumberscontroller_findall.md): ## Overview Retrieves a list of phone numbers.  Available for **Staff, Directory, and Client tokens**
  - Business Phone Numbers
    - [The BusinessPhoneNumber Object](https://developers.intandem.tech/reference/businessphonenumber.md)
    - [Update a BusinessPhoneNumber](https://developers.intandem.tech/reference/businessphonenumberscontroller_update.md): ## Overview Update the verification request data for a business phone number.  Available for **Business and Staff tokens** only. Requires business context.
    - [Create a BusinessPhoneNumber](https://developers.intandem.tech/reference/businessphonenumberscontroller_create.md): ## Overview Purchase a phone number from a telecom provider and assign it to a business account. For US and Canadian phone numbers with text messaging, verification_request_data is required to…
    - [Retrieve all BusinessPhoneNumbers](https://developers.intandem.tech/reference/businessphonenumberscontroller_findall.md): ## Overview Retrieves a list of all business phone numbers associated with a business account.  Available for **Staff, Directory, and Client tokens**
    - [Retrieve a BusinessPhoneNumber](https://developers.intandem.tech/reference/businessphonenumberscontroller_findone.md): ## Overview Fetches detailed information about a single business phone number using its unique identifier.  Available for **Business and Directory tokens** only. Staff tokens without business context…
  - Manage Numbers
    - [Remove Twilio Number](https://developers.intandem.tech/reference/delete_platform-v1-numbers-twilio-sub-account-id.md): ## Overview Remove Twilio Number Available for **Staff, App, and Directory tokens**.
    - [Assign Dedicated Number](https://developers.intandem.tech/reference/post_platform-v1-numbers-dedicated-numbers-assign.md): ## Overview Assign Dedicated Number For Account, This API requires the 'enable_dedicated_nexmo_number' feature flag to be enabled on your account/directory. For additional information please reach…
    - [Add Twilio Number](https://developers.intandem.tech/reference/post_platform-v1-numbers-twilio.md): ## Overview Add a Twilio Number Available for **Staff, App, and Directory tokens**.
    - [Set Two Way Texting Status](https://developers.intandem.tech/reference/put_platform-v1-numbers-dedicated-numbers-set-two-way-texting-status.md): ## Overview Set Two Way Texting Status.  **Prerequisites:** - Business must have a dedicated number assigned via `POST /platform/v1/numbers/dedicated_numbers/assign` before using this endpoint.…
- Contact Channels
  - [Get All ContactChannels](https://developers.intandem.tech/reference/contactchannelscontroller_index.md): ## Overview Returns the contact-level availability of every communication channel the business has (email, SMS, and installed third-party apps) for a single contact. Each entry reports whether the…
- Manage Communication
  - channels
    - [Create a Business Communication Channel](https://developers.intandem.tech/reference/channelscontroller_create.md): ## Overview Create a new business' communication channel. Available for **Staff, App, and Directory tokens**.  **Note:** Channels start with a `pending` status upon creation. They are activated…
    - [Delete a Business Communication Channel](https://developers.intandem.tech/reference/channelscontroller_deletechannel.md): ## Overview Deletes an existing channel. Available for **Staff, App, and Directory tokens**.  **Note:** Channels follow an async webhook-based lifecycle. Channels start as `pending` and are activated…
    - [Update a Business Communication Channel](https://developers.intandem.tech/reference/channelscontroller_updatechannel.md): ## Overview Update an existing communication channel. Available for **Staff, App, and Directory tokens**.  **Note:** Channels follow an async webhook-based lifecycle. Channels start as `pending` and…
  - sessions
    - [Create a Business Communication Session](https://developers.intandem.tech/reference/sessionscontroller_createsession.md): ## Overview Create a new inactive session over a channel between the app's contact and vCita's contact. Available for **Staff, App, and Directory tokens**.  **Note:** Sessions require an active…
    - [Retrieve a Business Communication Session](https://developers.intandem.tech/reference/sessionscontroller_getsession.md): ## Overview Retrieve sessions. Deep object style. Example: filter[channel_uid]=channeluuid. Available for **Staff, App, and Directory tokens**.  **Note:** Sessions require an active channel…
    - [Delete a Business Communication Session](https://developers.intandem.tech/reference/sessionscontroller_logicdelete.md): ## Overview Deletes an existing session. Available for **Staff, App, and Directory tokens**.  **Note:** Sessions follow an async webhook-based lifecycle. Sessions require an active channel (activated…
    - [Update a Business Communication Session](https://developers.intandem.tech/reference/sessionscontroller_updatestatus.md): ## Overview Activating/deactivating an existing session. Available for **Staff, App, and Directory tokens**.  **Note:** Sessions follow an async webhook-based lifecycle. Sessions require an active…
    - [Create a Business Communication Session Typing indicator](https://developers.intandem.tech/reference/sessionstypingcontroller_typingstatus.md): ## Overview Populate typing indicator status. Available for **Staff, App, and Directory tokens**.  **Note:** Requires an active session, which in turn requires an active channel. Both channels and…
- Messaging
  - Activity Message
    - [The ActivityMessage Object](https://developers.intandem.tech/reference/the-activitymessage-object.md)
    - [List Activity Messages](https://developers.intandem.tech/reference/listactivitymessages.md): ## Overview Retrieves a paginated list of activity messages for a business. Activity messages represent communications tied to business activities such as meetings, invoices, payments, and more. Use…
    - [Create an ActivityMessage](https://developers.intandem.tech/reference/sendactivitymessage.md): ## Overview Create an ActivityMessage Available for **Staff, App, and Directory tokens**.
  - Messages
    - [Get Conversation Messages](https://developers.intandem.tech/reference/get_v2-conversations-conversation-id-messages.md): ## Overview Retrieves a paginated list of messages within a specific conversation. Messages are returned in chronological order and include staff details, document attachments, and delivery status.…
    - [Create a Business Communication Message](https://developers.intandem.tech/reference/messagescontroller_createmessage.md): ## Overview Send a message to a business. Available for **Staff, App, and Directory tokens**.  **Note:** Sending messages requires a channel with `active` status. Channels are activated…
    - [Update Business Communication Message](https://developers.intandem.tech/reference/messagescontroller_updatestatus.md): ## Overview Update message status. Available for **Staff, App, and Directory tokens**.  **Note:** Messages are part of the async webhook-based communication lifecycle. Sending messages requires a…
    - [Create a Message](https://developers.intandem.tech/reference/post_platform-v1-messages.md): ## Overview Creates a Message.  Available for **Staff and Directory tokens**. Directory tokens require the `X-On-Behalf-Of` header with the target business UID.
  - Conversations
    - [Get Conversations For A Client](https://developers.intandem.tech/reference/get_platform-v1-clients-client-id-conversations-1.md): ## Overview Gets a list of conversations for a client.  ## Authentication **Available for Staff, App, and Directory Tokens.**
    - [Update a conversation (archive, spam, business_unread, follow-up, soft delete)](https://developers.intandem.tech/reference/put_v2-conversations-id.md): ## Overview Updates a single conversation. This endpoint is used for several distinct operations against the same conversation resource:  - Archive / unarchive - Mark as spam / not spam - Mark as…
    - [Get Conversations](https://developers.intandem.tech/reference/get_platform-v1-conversations.md): ## Overview Gets a list of conversations.  Available for **Staff and Directory tokens**. Directory tokens require the `X-On-Behalf-Of` header with the target business UID.
  - Messaging Channels
    - [Create a mesaging channel](https://developers.intandem.tech/reference/post_business-messaging-v1-channels.md): ## Overview Connecting a business to a primitive messaging channel through known providers.  **Prerequisites:** - Business must have a valid `callsandtexting` subscription to use this endpoint. - For…
- Voice Calls
  - Voice Call
    - [The VoiceCall Object](https://developers.intandem.tech/reference/the-voicecall-object.md)
    - [Create a VoiceCall](https://developers.intandem.tech/reference/voicecallscontroller_create.md): ## Overview Create a VoiceCall Available for **Staff, App, and Directory tokens**.
    - [Retrieve a VoiceCall](https://developers.intandem.tech/reference/voicecallscontroller_get.md): ## Overview Retrieve a VoiceCall.  Available for **Staff, Directory, and Client tokens**
    - [Get all VoiceCalls](https://developers.intandem.tech/reference/voicecallscontroller_getall.md): ## Overview Get all VoiceCalls.  Available for **Staff, Directory, and Client tokens**
    - [Update a VoiceCall](https://developers.intandem.tech/reference/voicecallscontroller_update.md): ## Overview Update a VoiceCall Available for **Staff, App, and Directory tokens**.
  - Voice Call Settings
    - [The VoiceCallSetting Object](https://developers.intandem.tech/reference/the-voicecallsetting-object.md)
    - [Delete VoiceCallSetting](https://developers.intandem.tech/reference/settingscontroller_delete.md): ## Overview Delete a VoiceCallSetting.  Available for **Admin tokens**
    - [Create a VoiceCallSetting](https://developers.intandem.tech/reference/settingscontroller_create.md): ## Overview Create a VoiceCallSetting Available for **Staff, App, and Directory tokens**.
    - [Get all VoiceCallSettings](https://developers.intandem.tech/reference/settingscontroller_get.md): ## Overview Get all VoiceCallSettings. Available for **Staff Tokens**.
    - [Update VoiceCallSetting](https://developers.intandem.tech/reference/settingscontroller_update.md): ## Overview Update VoiceCallSetting Available for **Staff, App, and Directory tokens**.
  - Voice Call Recordings
    - [The VoiceCallRecording Object](https://developers.intandem.tech/reference/the-voicecallrecording-object.md)
    - [Update a VoiceCallRecording](https://developers.intandem.tech/reference/recordingscontroller_updatevoicecallrecording.md): ## Overview Update a VoiceCallRecording Available for **Staff, App, and Directory tokens**.
    - [Delete a VoiceCallRecording](https://developers.intandem.tech/reference/recordingscontroller_deletevoicecallrecording.md): ## Overview Deletes a voice call recording and returns a voiceCall entity Available for **Staff, App, and Directory tokens**.
  - Voice Call Quota
    - [The VoiceCallQuota Object](https://developers.intandem.tech/reference/the-voicecallquota-object.md)
    - [Retrieve a VoiceCallQuota](https://developers.intandem.tech/reference/quotascontroller_getquota.md): ## Overview Retrieve a VoiceCallQuota.  Available for **Admin tokens**
  - Voice Call Reports
    - [Get voice call stats](https://developers.intandem.tech/reference/reportscontroller_getvoicecallstats.md): ## Overview Returns aggregated voice call status counts for the requested period and status filter.  Available for **Staff, Directory, and Client tokens**
- Voice Call Transcripts
  - [Get transcript for a voice call](https://developers.intandem.tech/reference/transcriptcontroller_gettranscript.md): ## Overview Retrieves the transcript for a specific voice call. Returns the processing status and, when status is DONE, the full transcript entries.  Available for **Staff, Directory, and Client…
- Notifications
  - Notification Templates
    - [The NotificationTemplate Object](https://developers.intandem.tech/reference/the-notificationtemplate-object.md)
    - [Delete a NotificationTemplate](https://developers.intandem.tech/reference/delete_v3-communication-notification-templates-uid.md): ## Overview Delete a specific NotificationTemplate based on its unique identifier (UID). .**.  **Available for Directory and App tokens**
    - [Get all NotificationTemplates](https://developers.intandem.tech/reference/get_v3-communication-notification-templates.md): ## Overview Get a list of NotificationTemplates.  Available for **Staff tokens**.
    - [Retrieve a NotificationTemplate](https://developers.intandem.tech/reference/get_v3-communication-notification-templates-uid.md): ## Overview Retrieve a specific NotificationTemplate based on its unique identifier (UID).  Available for **App, Directory, Admin, Staff, and Operator tokens**
    - [Create a NotificationTemplate](https://developers.intandem.tech/reference/post_v3-communication-notification-templates.md): ## Overview Create a new notification template. .**.  **Available for Directory and App tokens**
    - [Update a NotificationTemplate](https://developers.intandem.tech/reference/put_v3-communication-notification-templates-uid.md): ## Overview Update an existing notification template. .**.  **Available for Directory and App tokens**
  - Staff Notification
    - [The StaffNotification Object](https://developers.intandem.tech/reference/the-staffnotification-object.md)
    - [Retrieve a StaffNotification](https://developers.intandem.tech/reference/get_v3-communication-staff-notifications-uid.md): ## Overview Retrieve a StaffNotification by its unique identifier.  Available for **Directory tokens**.
    - [Create a StaffNotification](https://developers.intandem.tech/reference/post_v3-communication-staff-notifications.md): ## Overview Create a new StaffNotification for a staff member. .**.  **Available for Directory or App Token**
- Typing Indicator
  - [Notify Typing Indicator](https://developers.intandem.tech/reference/post_business-messaging-v1-channels-typing.md): ## Overview Notify contacts about account typing indicator. The `source` field determines the processing flow - when set to `business`, it uses the external typing status flow.  Available for…

## API Reference: Integrations
- Import
  - [Import Job](https://developers.intandem.tech/reference/import-job.md)
  - [Import Job Item](https://developers.intandem.tech/reference/importjobitem.md)
  - [Create a new ImportJob](https://developers.intandem.tech/reference/importjobscontroller_create.md): ## Overview Import products into a business account Available for **Staff Tokens**.
  - [Retrieve an ImportJob](https://developers.intandem.tech/reference/importjobscontroller_findone.md): ## Overview Retrieve an import job by its UID.  Available for **Staff, Directory, and Client tokens**
  - [Get all ImportJobItems](https://developers.intandem.tech/reference/importjobitemscontroller_findall.md): ## Overview Get all import job items for a specific import job.  Available for **Staff, Directory, and Client tokens**
  - [Retrieve an ImportJobItem](https://developers.intandem.tech/reference/importjobitemscontroller_findone.md): ## Overview Retrieve an import job item by its UID.  Available for **Staff, Directory, and Client tokens**
- IDP Actor Mapping
  - [ The IDPActorMapping Object](https://developers.intandem.tech/reference/the-idp-actor-mapping-object.md)
  - [List all IDP Actor Mappings](https://developers.intandem.tech/reference/get_v3-integrations-idp-actor-mappings.md): ## Overview List all IDP Actor Mappings in the directory scope.
  - [Create an IDP Actor Mapping](https://developers.intandem.tech/reference/post_v3-integrations-idp-actor-mappings.md): ## Overview Create a new IDP Actor Mapping for SSO integration Available for **Directory Tokens only**.
  - [Delete an IDP Actor Mapping](https://developers.intandem.tech/reference/delete_v3-integrations-idp-actor-mappings-uid.md): ## Overview Delete an IDP Actor Mapping by UID. Available for **Directory Tokens only**.

## API Reference: Online_presence
- AI Chat Configuration
  - [Retrieve an AIChatConfiguration](https://developers.intandem.tech/reference/getaichatconfiguration.md): Returns the AI chat configuration for the authenticated business. Available for **Staff tokens**.
  - [Update an AIChatConfiguration](https://developers.intandem.tech/reference/upsertaichatconfiguration.md): Creates or updates the AI chat configuration for the authenticated business. Provided fields are merged with existing values; omitted fields are unchanged. Available for **Staff tokens**.
- AI Receptionist Conversations
  - [Get all AIReceptionistConversations](https://developers.intandem.tech/reference/listaireceptionistconversations.md): Returns paginated conversations for the authenticated business. Available for **Staff tokens**
  - [Create an AIReceptionistConversation](https://developers.intandem.tech/reference/createaireceptionistconversation.md): Creates an AIReceptionistConversations. Available for **Staff tokens**
  - [Retrieve an AIReceptionistConversations](https://developers.intandem.tech/reference/getaireceptionistconversation.md): Returns a single AI Receptionist Conversations. Available for **Staff tokens**.
  - [Update an AIReceptionistConversations](https://developers.intandem.tech/reference/updateaireceptionistconversation.md): Updates an AIReceptionistConversation. Available for **Staff tokens**
  - [Delete an AIReceptionistConversations](https://developers.intandem.tech/reference/deleteaireceptionistconversation.md): Soft-deletes an AI Receptionist Conversation. Available fo **Staff tokens**
- Web AI Widget
  - [Get all WidgetConfigurations](https://developers.intandem.tech/reference/listwidgetconfigurations.md): Lists widget configurations. Available for **Staff tokens**
  - [Create a WidgetConfigurations](https://developers.intandem.tech/reference/createwidgetconfiguration.md): Creates a widget configuration for a business. Available for **Staff token**;
  - [Retrieve a WidgetConfigurations](https://developers.intandem.tech/reference/getwidgetconfigurationbyuid.md): Returns one widget configuration. Available for **Staff token**
  - [Update WidgetConfigurations](https://developers.intandem.tech/reference/updatewidgetconfiguration.md): Updates an existing widget configuration. Available fo **Staff token**
  - [Delete a WidgetConfigurations](https://developers.intandem.tech/reference/deletewidgetconfiguration.md): Deletes a widget configuration. Available for **Staff token**

## API Reference: Platform_administration
- License
  - Offering
    - [The Offering Object](https://developers.intandem.tech/reference/the-offering-entity.md)
    - [List all Offerings](https://developers.intandem.tech/reference/get_v3-license-offerings.md): ## Overview List all Offerings in scope.  Available for **Staff and Directory and Internal tokens**.
    - [Create an Offering](https://developers.intandem.tech/reference/post_v3-license-offerings.md): ## Overview Create a new Offering. Available for **Internal tokens only**.  ## Prerequisites Before creating an offering, obtain a valid SKU by calling `GET /v3/license/skus`. Use the `code_name`…
    - [Retrieve an Offering](https://developers.intandem.tech/reference/get_v3-license-offerings-uid.md): ## Overview Retrieve an Offering by its unique identifier.  Available for **Staff, Directory, and Internal tokens**.
    - [Update an Offering](https://developers.intandem.tech/reference/put_v3-license-offerings-uid.md): ## Overview Update an Offering. Available for **Admin tokens only**.  ### Replace-all `prices` semantics The `prices` array represents the **complete desired set of currencies** for the offering. Any…
    - [Delete an Offering (Not implemented yet](https://developers.intandem.tech/reference/delete_v3-license-offerings-uid.md): ## Overview Delete an Offering Available for **internal Token only**.
  - Bundled Offering
    - [The BundledOffering Object](https://developers.intandem.tech/reference/the-bundledoffering-entity.md)
    - [List all BundledOfferings](https://developers.intandem.tech/reference/get_v3-license-bundled-offerings.md): ## Overview List all BundledOfferings in scope.  Available for **Staff, Directory, and Internal tokens**.
    - [Create a BundledOffering](https://developers.intandem.tech/reference/post_v3-license-bundled-offerings.md): ## Overview Create a new BundledOffering that links a parent offering with a child offering. When a customer purchases the parent offering, the bundled (child) offering is automatically included.…
    - [Bulk create BundledOfferings](https://developers.intandem.tech/reference/post_v3-license-bundled-offerings-bulk.md): ## Overview Create multiple BundledOfferings for an Offering Available for **internal Tokens**.
    - [Delete a BundledOffering](https://developers.intandem.tech/reference/delete_v3-license-bundled-offerings-uid.md): ## Overview Delete a BundledOffering Available for **Client, Operator, and Admin tokens**.
  - Business Cart
    - [The BusinessCart Object](https://developers.intandem.tech/reference/the-businesscart-object.md)
    - [Create a BusinessCart](https://developers.intandem.tech/reference/post_v3-license-business-carts.md): ## Overview Create a new BusinessCart for the business.  ## Prerequisites Before creating a cart, obtain a valid `offering_uid` by calling `GET /v3/license/offerings`.  Available for **Staff Tokens**.
    - [Retrieve a BusinessCart](https://developers.intandem.tech/reference/get_v3-license-business-carts-uid.md): ## Overview Retrieve a BusinessCart.  Available for **Staff Tokens**.
  - Directory Offering
    - [The DirectoryOffering Object](https://developers.intandem.tech/reference/the-directoryoffering-entity.md)
    - [List all DirectoryOfferings](https://developers.intandem.tech/reference/get_v3-license-directory-offerings.md): ## Overview List all DirectoryOfferings in scope.  Available for **Internal Tokens only**.
    - [Create a DirectoryOffering](https://developers.intandem.tech/reference/post_v3-license-directory-offerings.md): ## Overview Create a new DirectoryOffering for a specific partner and Offering.  Available for **Internal Tokens only**.  **Important**: Each directory can only have one DirectoryOffering per…
    - [Retrieve a DirectoryOffering](https://developers.intandem.tech/reference/get_v3-license-directory-offerings-uid.md): ## Overview Retrieve a DirectoryOffering.  Available for **Internal Tokens only**.
    - [Delete a DirectoryOffering](https://developers.intandem.tech/reference/delete_v3-license-directory-offerings-uid.md): ## Overview Delete a DirectoryOffering.  Available for **Internal Tokens only**.
  - Features Packages
    - [Get all Features Packages](https://developers.intandem.tech/reference/get_v3-license-features-packages.md): ## Overview Retrieve a list of Features Packages.  **Available for Staff tokens**
    - [Create a license package](https://developers.intandem.tech/reference/createfeaturespackage.md): ## Overview Create a package. The name must be unique. Unlike the list and show operations, the created package is returned as a full record rather than a reduced field set.  Available for **admin…
    - [Get a license package](https://developers.intandem.tech/reference/getfeaturespackage.md): ## Overview Retrieve one package including its quotas, settings and attached packageable features.  Available for **admin actors only** — an Okta admin token (introspected by the API gateway) or,…
    - [Update a license package](https://developers.intandem.tech/reference/updatefeaturespackage.md): ## Overview Update a package's attributes and optionally attach or detach packageable features. Quotas cannot be changed through this operation and sending `quotas` fails the request.  Available for…
    - [Delete a license package](https://developers.intandem.tech/reference/deletefeaturespackage.md): ## Overview Delete a package.  Available for **admin actors only** — an Okta admin token (introspected by the API gateway) or, outside production, the static admin token. Any other actor type…
    - [Add a feature to several license packages](https://developers.intandem.tech/reference/addfeaturetofeaturespackages.md): ## Overview Attach one packageable feature to a list of packages in a single call. The feature must exist and have `packageable: true`, otherwise the request fails.  > A package that already has the…
  - Subscription
    - [The Subscription Object](https://developers.intandem.tech/reference/the-subscription-object.md)
    - [List all Subscriptions](https://developers.intandem.tech/reference/get_v3-license-subscriptions.md): ## Overview List all Subscriptions in scope.  Available for **Staff and App tokens**.  **Note:** App tokens can only view subscriptions for their own app.
    - [Create a Subscription](https://developers.intandem.tech/reference/post_v3-license-subscriptions.md): ## Overview Create a new Subscription for a business. Supports discounted and free plans using coupons.  Available for **Staff tokens**.  ### Token Permissions  | Token Type | Allowed | Restrictions…
    - [Bulk Create Subscriptions](https://developers.intandem.tech/reference/post_v3-license-subscriptions-bulk.md): ## Overview Create multiple identical Subscriptions for a business in a single request. Supported for **add-on** offerings only (`type = addon`); each created subscription is a separate line (e.g.,…
    - [Retrieve a Subscription](https://developers.intandem.tech/reference/get_v3-license-subscriptions-uid.md): ## Overview Retrieve a Subscription by its unique identifier.  Available for **Staff and App tokens**.  **Note:** App tokens can only view subscriptions for their own app.
    - [Update a Subscription](https://developers.intandem.tech/reference/put_v3-license-subscriptions-uid.md): ## Overview Update a Subscription (cancel/expire) Available for **Directory, Staff, and internal Tokens**.
  - SKU
    - [The SKU entity](https://developers.intandem.tech/reference/the-sku-entity.md)
    - [List all SKUs](https://developers.intandem.tech/reference/get_v3-license-skus.md): ## Overview List all SKUs in scope.  Available for **Internal Tokens only**.
  - Quota Consumption
    - [Create a QuotaConsumption](https://developers.intandem.tech/reference/createquotaconsumption.md): Report one usage of a metered addon SKU. The report is accepted as sent and published for the quota ingest, which validates it, charges the business's allowances in order (the monthly first, then…
    - [List all QuotaConsumptions](https://developers.intandem.tech/reference/get_v3-license-quota-consumptions.md): List the recorded usage of metered SKUs, the quota ledger. Usage is reported through `POST /v3/license/quota_consumptions` or by internal services over a queue, is recorded asynchronously and is…
  - Quota Balance
    - [List all QuotaBalances](https://developers.intandem.tech/reference/get_v3-license-quota-balances.md): List the balance of each live allowance a business has for its metered SKUs: one row per allowance, in the order usage is charged (monthly by soonest reset, then packs oldest first). A monthly…
  - License Features
    - [List license features](https://developers.intandem.tech/reference/listlicensefeatures.md): ## Overview List feature flags in the license catalog, ordered by name.  Available for **admin actors only** — an Okta admin token (introspected by the API gateway) or, outside production, the static…
    - [Create a license feature](https://developers.intandem.tech/reference/createlicensefeature.md): ## Overview Create a feature flag. The name must be present and unique, case-insensitively.  Available for **admin actors only** — an Okta admin token (introspected by the API gateway) or, outside…
    - [Get a license feature](https://developers.intandem.tech/reference/getlicensefeature.md): ## Overview Retrieve one feature flag.  Available for **admin actors only** — an Okta admin token (introspected by the API gateway) or, outside production, the static admin token. Any other actor…
    - [Update a license feature](https://developers.intandem.tech/reference/updatelicensefeature.md): ## Overview Update a feature flag's name, description or packageable flag.  Available for **admin actors only** — an Okta admin token (introspected by the API gateway) or, outside production, the…
    - [Delete a license feature](https://developers.intandem.tech/reference/deletelicensefeature.md): ## Overview Delete a feature flag. A feature attached to any package cannot be deleted; the request returns **409** and the feature is kept. Check `removable` on the feature before calling.…
- Packages
  - [List packages](https://developers.intandem.tech/reference/get_api-operator-api-v1-packages.md): Returns all packages in a **slim** representation — quotas, settings and features are **not** included (use `GET /packages/{id}` for those).  Requires the operator `read` ability on `package`.
  - [Create a package](https://developers.intandem.tech/reference/post_api-operator-api-v1-packages.md): Creates a package. Requires the operator `manage` ability on `package`.  `name` must be unique (case-insensitive) and may not contain special characters. Quotas can only be set on create — `PUT…
  - [Get a package](https://developers.intandem.tech/reference/get_api-operator-api-v1-packages-id.md): Returns the **full** representation of a single package, including `quotas`, `settings` and the attached packageable features.  Note: the payload is an **array** with a single element (the endpoint…
  - [Update a package](https://developers.intandem.tech/reference/put_api-operator-api-v1-packages-id.md): Updates package attributes, settings and feature attachments. Requires the operator `manage` ability on `package`.  Sending `quotas` is rejected with `400` (`"Can't update package quotas"`). Every…
  - [Delete a package](https://developers.intandem.tech/reference/delete_api-operator-api-v1-packages-id.md): Permanently deletes a package. Requires the operator `manage` ability on `package`.
  - [Add one feature flag to several packages](https://developers.intandem.tech/reference/post_api-operator-api-v1-packages-add-feature.md): Attaches a single packageable feature flag to a list of packages, in one transaction. Packages that already have the feature are skipped. Fails if the feature is not `packageable`.
- Setup
  - [Set Setup Completed](https://developers.intandem.tech/reference/set-setup-completed.md): ## Overview Mark an account's setup/onboarding as completed. This suspends the account's "to do" list (onboarding wizard).  Available for **Directory tokens only**.  ## Authentication Uses HTTP Token…
- Feature Flags
  - [List feature flags](https://developers.intandem.tech/reference/get_api-operator-api-v1-features.md): Returns the feature-flag catalog, ordered by name. `removable` indicates whether the flag can be deleted (it cannot while it is attached to a package).
  - [Create a feature flag](https://developers.intandem.tech/reference/post_api-operator-api-v1-features.md)
  - [Get a feature flag](https://developers.intandem.tech/reference/get_api-operator-api-v1-features-id.md)
  - [Update a feature flag](https://developers.intandem.tech/reference/put_api-operator-api-v1-features-id.md)
  - [Delete a feature flag](https://developers.intandem.tech/reference/delete_api-operator-api-v1-features-id.md): Deletes a feature flag. A flag attached to at least one package cannot be deleted — the response is `status: "Warning"`.
- Business Administration
  - Account [Deprecated]
    - [Account Creation](https://developers.intandem.tech/reference/account-creation-1.md): ## Overview Create a new account under your directory. Most account details are cloned from an existing template to allow quick setup.  Available for **Directory tokens only**.  ## Authentication…
    - [Add/Remove staff](https://developers.intandem.tech/reference/addremove-staff.md): ## Deprecated  > **This endpoint is deprecated.** Addon management is now handled by the **Subscription API**. Please migrate all integrations to use the Subscription API endpoints for adding or…
    - [Account Manipulation](https://developers.intandem.tech/reference/account-manipulation.md): ## Deprecated  > **This endpoint is deprecated.** Package and billing management is now handled by the **Subscription API**. Please migrate all integrations to use the Subscription API endpoints for…
    - [Close an Account](https://developers.intandem.tech/reference/close-an-account.md): ## Overview Close an existing account under your directory.  Available for **Directory tokens only**.  ## Authentication Uses HTTP Token authentication. Format: `Authorization: Token…
    - [Reopen an Account](https://developers.intandem.tech/reference/reopen-an-account.md): ## Overview Reopen a closed account under your directory.  Available for **Directory tokens only**.  ## Authentication Uses HTTP Token authentication. Format: `Authorization: Token…
  - Business
    - [Search Businesses](https://developers.intandem.tech/reference/get_businesses.md): ## Overview Search for a business by external_reference_id or email.  Available for **Directory Tokens only**.  > **Note**: At least one filter parameter (email, external_id, or…
    - [Create a Business](https://developers.intandem.tech/reference/post_businesses.md): ## Overview Creates a Business. By default, business creation is synchronous. To create a business asynchronously, set the 'synchronized' parameter to false in the 'meta' object. When set to false,…
    - [Validate Login](https://developers.intandem.tech/reference/get_businesses-validate-login.md): ## Overview Validates username/password credentials for login. The API will be blocked for the username after 5 failed attempts.  Available for **Directory tokens**.
    - [Verify Audience Claim](https://developers.intandem.tech/reference/post_businesses-verify-audience-claim.md): ## Overview This API performs entitlement verification for businesses seeking to register with a specific partner. It checks if a business exists in the partner's pre-loaded audience list and is…
    - [Remove business identities](https://developers.intandem.tech/reference/delete_business-accounts-v1-identities.md): ## Overview Remove business identities to modify the business's occupational verticals.  Available for **Directory OAuth tokens** with on-behalf-of authorization.  > **Important**: This endpoint uses…
    - [Get business identities](https://developers.intandem.tech/reference/get_business-accounts-v1-identities.md): ## Overview Retrieve business identities.  Available for **Directory OAuth tokens** with on-behalf-of authorization.  > **Important**: This endpoint uses on-behalf-of authorization. Directory users…
    - [Update business identities](https://developers.intandem.tech/reference/put_business-accounts-v1-identities.md): ## Overview Add business identities to optimize the business terminology, settings, and content.  Available for **Directory OAuth tokens** with on-behalf-of authorization.  > **Important**: This…
    - [Get Business](https://developers.intandem.tech/reference/get_platform-v1-businesses-business-uid.md): ## Overview Retrieves detailed information about a specific business by its ID, including admin account details and business information.  Available for **Staff and Directory tokens**.
    - [Update Business](https://developers.intandem.tech/reference/post_platform-v1-businesses-business-uid.md): ## Overview Updates an existing business. This endpoint allows updating business information, admin account details, integrations, and subscription plan. Only provided fields will be updated.…
    - [Get Business Features](https://developers.intandem.tech/reference/get_platform-v1-businesses-business-uid-features.md): ## Overview Retrieves a list of features enabled for a specific business. Features represent capabilities and modules available to the business.  Available for **Staff, Application, and Directory…
    - [Update Purchased Items](https://developers.intandem.tech/reference/put_platform-v1-businesses-business-uid-purchased-items.md): ## Overview Updates purchased items for a business.  Available for **Staff, Application, and Directory tokens**.
    - [Get Recurly parameters](https://developers.intandem.tech/reference/get_platform-v1-businesses-business-uid-recurly-data.md): ## Overview Retrieves Recurly subscription data for a business, including account codes and subscription parameters used for billing integration.  Available for **Staff, Directory, and Client…
    - [Get a list of Businesses](https://developers.intandem.tech/reference/get_v3-business-administration-businesses.md): Returns a filtered, paginated list of businesses belonging to the authenticated directory.  Available for **Directory**,**Staff** and **Internal tokens**.
  - Business Settings
    - [Show Business Settings](https://developers.intandem.tech/reference/get_v2-settings-businesses-business-uid.md): ## Overview Returns the full settings object for the business, including profile fields, client-facing visibility flags, branding, and the server-geocoded `structured_address`.  Available for **Staff…
    - [Update Business Settings](https://developers.intandem.tech/reference/put_v2-settings-businesses-business-uid.md): ## Overview Updates the business's own profile settings. Only the fields provided in the body are changed.  The **`address`** is a plain free-text string; it is geocoded server-side into…
  - Business Attributes
    - [Gets business attributes](https://developers.intandem.tech/reference/get_business-accounts-v1-attributes.md): ## Overview Retrieve business attributes including business name, locale, time format, directory settings, and feature flags. This endpoint is primarily used by the frontend to configure the business…
  - Business Branding
    - [Gets the branding of the business](https://developers.intandem.tech/reference/get_business-accounts-v1-branding.md): ## Overview Retrieve business branding, or directory branding when business branding is unavailable. Returns colors (primary, secondary, text), logo URL, and powered_by logos for…
  - Business account usage
    - [Business account usage in the last 3 months](https://developers.intandem.tech/reference/get_business-accounts-v1-usage-last-3-months-activity.md): ## Overview Get an account's activity report for the <b>last 3 months</b>, including the following information: <ol> <li>Number of payments received</li> <li>Number of conversations started</li>…
  - Business Reports
    - [Business Info](https://developers.intandem.tech/reference/business-info.md): ## Overview Query a business's basic information. If the email address already exists in our server you'll receive "status:existing".  Available for **Directory tokens only**.  ## Authentication Uses…
    - [Engagements Report](https://developers.intandem.tech/reference/engagements-report.md): ## Overview Query for a list of all the conversations (a.k.a engagements) for a given date range. Conversations will be sorted by date of creation. The GET request will be answered by a JSON…
    - [Widget Impressions Report](https://developers.intandem.tech/reference/widget-impressions-report.md): ## Overview Query for the number of impressions per day for a given date range. The GET request will be answered by a JSON of an array of impressions_daily objects. Each impressions_daily object…
  - Directory
    - [Gets Directory's branding](https://developers.intandem.tech/reference/get_platform-v1-directory-branding.md): ## Overview Get Directory's branding including logo url and colors, available for **Staff & Directory Tokens**.
    - [Get a list of Directories](https://developers.intandem.tech/reference/get_v3-business-administration-directories.md): Returns a filtered, paginated list of directories.  Available for **Internal tokens**, **Directory Tokens** and **Staff Tokens**
    - [Retrieve a Directory](https://developers.intandem.tech/reference/get_v3-business-administration-directories-uid.md): Returns a specific directory based on its unique identifier.  Available for **Internal tokens**, **Directory Tokens** and **Staff Tokens**
    - [Create a Directory](https://developers.intandem.tech/reference/post_v3-business-administration-directories.md): Creates a new directory with the provided configuration.  Available for **Internal tokens**
    - [Update a Directory](https://developers.intandem.tech/reference/put_v3-business-administration-directories-uid.md): Updates an existing directory. Only provided fields will be modified; omitted fields remain unchanged.  Available for **Internal tokens**
  - Staff Member
    - [Retrieve a StaffMember](https://developers.intandem.tech/reference/get_v3-business-administration-staff-members-uid.md): ## Overview Retrieve a StaffMember.  Available for **Staff, Directory, and Client tokens**
    - [Update a StaffMember](https://developers.intandem.tech/reference/put_v3-business-administration-staff-members-uid.md): ## Overview Update a StaffMember.  **Available for Staff Token**
  - Staff
    - [Get Staff List [Alpha]](https://developers.intandem.tech/reference/get_platform-v1-scheduling-staff.md): ## Overview Get Staff List [Alpha].  Available for **Staff Tokens**.
    - [Updates a staff's properties](https://developers.intandem.tech/reference/put_business-staffs-v1-staffs-uid.md): ## Overview Updates a staff's properties. Available for **Directory tokens only**.  > **Note**: The `X-On-Behalf-Of` header is required to specify which business's staff member to update.  > **For…
    - [Get Staff Members](https://developers.intandem.tech/reference/get_platform-v1-businesses-business-uid-staffs.md): ## Overview Get Staff List and Details (ordered by position field).  Available for **Staff, Application, and Directory tokens**.
    - [Create Staff Member](https://developers.intandem.tech/reference/post_platform-v1-businesses-business-uid-staffs.md): ## Overview Creates a Staff Member.  Available for **Staff, Application, and Directory tokens**.  **Content-Type**: Requires `application/json` content type header.
    - [Delete Staff Member](https://developers.intandem.tech/reference/delete_platform-v1-businesses-business-uid-staffs-staff-uid.md): ## Overview Delete Staff Member Available for **Staff, Application, and Directory tokens**.
    - [Get Staff Member Details](https://developers.intandem.tech/reference/get_platform-v1-businesses-business-uid-staffs-staff-uid.md): ## Overview Get Staff Details.  Available for **Staff, Application, and Directory tokens**.
    - [End Staff Member active sessions](https://developers.intandem.tech/reference/delete_platform-v1-businesses-business-uid-staffs-staff-uid-sessions.md): ## Overview End Staff Member active sessions and log out from browser Available for **Staff, Application, and Directory tokens**.
    - [Get Staff By ID [Alpha]](https://developers.intandem.tech/reference/get_platform-v1-scheduling-staff-staff-uid.md): ## Overview Get Staff By ID [Alpha].  Available for **Staff Tokens**.
  - Staff activity
    - [Daily Staff Sign-ins](https://developers.intandem.tech/reference/get_business-staffs-v1-daily-staff-sign-ins.md): ## Overview Get daily sign-in records for the business's staff members within a specified date range.  Available for **Staff and Directory Tokens**.
  - Staff Quick Action Lists
    - [Get relevant quick action lists per staff](https://developers.intandem.tech/reference/get_v3-business-administration-staff-quick-action-lists.md): ## Overview A quick action entity represents a configurable shortcut displayed in the staff's dashboard, allowing personalized access to key system functions.  Available for **Staff Tokens**.
    - [Update quick action lists for a specific staff member](https://developers.intandem.tech/reference/put_v3-business-administration-staff-quick-action-lists-staff-uid.md): ## Overview Update the order and visibility of quick actions for a specific staff member.  Available for **Staff Tokens**.
  - Wizard
    - [Gets a list of wizards](https://developers.intandem.tech/reference/get_platform-v1-businesses-business-uid-wizards.md): ## Overview Gets a list of available wizards.  Available for **Staff, Application, and Directory tokens**.
    - [Gets a wizard by name](https://developers.intandem.tech/reference/get_platform-v1-businesses-business-uid-wizards-wizard-name.md): ## Overview Gets a wizard by given name.  Available for **Directory Tokens only**.
    - [Update a wizard](https://developers.intandem.tech/reference/put_platform-v1-businesses-business-uid-wizards-wizard-name.md): ## Overview Update a wizard with given name Available for **Staff, Application, and Directory tokens**.
- Session Management
  - Token Management
    - [Creates a token](https://developers.intandem.tech/reference/post_platform-v1-tokens.md): ## Overview Creates a token for authentication. Tokens can be created for applications (app_id), businesses (business_id), or directories (directory_id). At least one identifier must be provided.…
    - [Exchange Authorization Code for Access Token](https://developers.intandem.tech/reference/post_oauth-token.md): ## Overview Exchanges an OAuth Authorization Code for an Access Token. This endpoint is the final step in the OAuth 2.0 Authorization Code flow.  **This endpoint does not require authentication…
  - Tokens
    - [Get Tokens List](https://developers.intandem.tech/reference/get_platform-v1-tokens.md): ## Overview Get tokens list. Tokens can be filtered by app_id, user_id, or directory_id. Available for **Staff, Application, and Directory tokens**.
    - [Revoke Token](https://developers.intandem.tech/reference/post_platform-v1-tokens-revoke.md): ## Overview Revoke a specific access token by providing the token value. The token must be accessible by the authenticated caller (e.g., a Directory token can only revoke tokens it issued).…
    - [Create SSO Token](https://developers.intandem.tech/reference/sso-api.md): ## Overview Create a one-time token for Single Sign On (SSO) login.  Available for **Directory tokens only**.  ## Authentication Uses HTTP Token authentication. Format: `Authorization: Token…
  - OpenID
    - [Get authenticated user info](https://developers.intandem.tech/reference/get_oauth-userinfo.md): ## Overview Get authenticated user info.  Available for **Staff tokens**.
- [Webhook Responses](https://developers.intandem.tech/reference/webhooks-responses.md)
  - App
    - [App Installed](https://developers.intandem.tech/reference/app-installed.md): Notifying when a business  installs an app (either for the first time or after uninstalling it)
    - [App Uninstalled](https://developers.intandem.tech/reference/app-uninstalled.md): Notifying when a business uninstalls an app (paid or free)
  - Appointment
    - [Appointment Scheduled](https://developers.intandem.tech/reference/message-business_sent_message-client_sent_message.md)
    - [Appointment Requested](https://developers.intandem.tech/reference/appointment-requested-scheduled-rescheduled-cancelled-completed-reminder_sent-copy.md)
    - [Appointment Rescheduled](https://developers.intandem.tech/reference/appointment-requested-scheduled-rescheduled-cancelled-completed-reminder_sent-copy-1.md)
    - [Appointment Cancelled](https://developers.intandem.tech/reference/appointment-requested-scheduled-rescheduled-cancelled-completed-reminder_sent-copy-2.md)
    - [Appointment Completed](https://developers.intandem.tech/reference/appointment-requested-scheduled-rescheduled-cancelled-completed-reminder_sent-copy-3.md)
    - [Appointment Reminder sent](https://developers.intandem.tech/reference/appointment-requested-scheduled-rescheduled-cancelled-completed-reminder_sent-copy-4.md)
    - [Appointment No Show](https://developers.intandem.tech/reference/appointment-requested-scheduled-rescheduled-cancelled-completed-reminder_sent-copy-5.md)
  - [Bulk Client Import](https://developers.intandem.tech/reference/client_import.md)
  - Business Account
    - [Account Created](https://developers.intandem.tech/reference/account-created.md): Notifying when a new business account is created
    - [Account Updated](https://developers.intandem.tech/reference/account-updated.md): Notifying when a business account is updated
    - [Account Closed](https://developers.intandem.tech/reference/account-closed-1.md): Notifying when a business account is locked out from the system
    - [Account ('account_promotional_muted')](https://developers.intandem.tech/reference/account-promotional_muted.md): Triggered when a business account is blocked from sending campaigns
    - [Account ('account_muted')](https://developers.intandem.tech/reference/account-muted.md): Triggered when a business account is muted after being flagged as a spammer
    - [Account ('campaigns_recipients_quota_reached')](https://developers.intandem.tech/reference/campaigns_recipients_quota_reached.md): Triggered when a business exceeds its monthly campaign recipients quota
    - [Account Rejected](https://developers.intandem.tech/reference/account-rejected.md): Notifying when business creation fails
  - [Business Rules bulk import](https://developers.intandem.tech/reference/business-rules-bulk-import.md)
  - [Conversation Read](https://developers.intandem.tech/reference/conversation-entry-page.md): Event triggered each time a staff member navigates into the conversation page
  - [Conversation item Created](https://developers.intandem.tech/reference/conversation_itemcreated.md)
  - Customized Notification
    - [Notification Updated](https://developers.intandem.tech/reference/notification-updated.md)
  - [Deposit Created](https://developers.intandem.tech/reference/deposit-created.md)
  - Subscription
    - [Subscription Created](https://developers.intandem.tech/reference/subscription-created.md): Notifying when a new subscription (app, main…) is created
    - [Subscription Updated](https://developers.intandem.tech/reference/subscription-updated.md): Notifying when a subscription (app, main…) is updated.
  - [Document Sent](https://developers.intandem.tech/reference/document-sent.md)
  - Estimate
    - [Estimate Requested](https://developers.intandem.tech/reference/estimate-requested-rejected-approved.md)
    - [Estimate Rejected](https://developers.intandem.tech/reference/estimate-requested-rejected-approved-copy.md)
    - [Estimate Approved](https://developers.intandem.tech/reference/estimate-requested-rejected-approved-copy-1.md)
  - Event Registration
    - [Event registration Created](https://developers.intandem.tech/reference/event-registration-created-updated.md)
    - [Event registration Updated](https://developers.intandem.tech/reference/event-registration-created-updated-copy.md)
  - Payment
    - [Payment Recorded](https://developers.intandem.tech/reference/payments-recorded-refunded.md)
    - [Payment Refunded](https://developers.intandem.tech/reference/payment-recorded-refunded-updated-matched-copy.md)
    - [Payment Updated](https://developers.intandem.tech/reference/payment-recorded-refunded-updated-matched-copy-1.md)
    - [Payment matched](https://developers.intandem.tech/reference/payment-recorded-refunded-updated-matched-copy-2.md)
  - Message
    - [Message Business sent message](https://developers.intandem.tech/reference/message-business_sent_message-client_sent_message-1.md)
    - [Message Client sent message](https://developers.intandem.tech/reference/message-business_sent_message-client_sent_message-copy.md)
  - [Messaging Channel Status](https://developers.intandem.tech/reference/messaging-channel-status.md): Triggered when messaging channel status is changed. Only applicable for SMS channels (Nexmo / Zipwhip).
  - Matter
    - [Matter Delete](https://developers.intandem.tech/reference/matter-delete.md)
    - [Matter Recover](https://developers.intandem.tech/reference/matter-delete-recover-copy.md)
  - Client
    - [Client updated](https://developers.intandem.tech/reference/client-created-updated.md): Notifying when a client is updated
    - [Client Created](https://developers.intandem.tech/reference/lead-created.md): Notifying when a new client is created
    - [Lead Injection](https://developers.intandem.tech/reference/lead-injection-1.md): ## Overview Inject a lead into a business account under your directory.  Available for **Directory tokens only**.  ## Authentication Uses HTTP Token authentication. Format: `Authorization: Token…
  - Payment Gateway Settings
    - [Payment Gateway Settings Connected](https://developers.intandem.tech/reference/payment-gateway-settings-connected-disconnected-changed_primary_payment_gateway.md)
    - [Payment Gateway Settings Disconnected](https://developers.intandem.tech/reference/payment-gateway-settings-connected-disconnected-changed_primary_payment_gateway-copy.md)
  - [Review Submitted](https://developers.intandem.tech/reference/review-submitted.md)
  - [Service Updated](https://developers.intandem.tech/reference/service-updated.md)
  - [Staff](https://developers.intandem.tech/reference/staff-2.md): Staff related webhooks
    - [Staff Created](https://developers.intandem.tech/reference/staff-created.md): Notifying when a new staff member is created
    - [Staff Updated](https://developers.intandem.tech/reference/staff-updated.md): Notifying when a staff member details are updated
    - [Staff Deleted](https://developers.intandem.tech/reference/staff-deleted.md): Notifying when a staff member is deleted
    - [Staff Deactivated](https://developers.intandem.tech/reference/staff-deleted-copy.md): Notifying when a staff member is deactivated
    - [Staff Reactivated](https://developers.intandem.tech/reference/staff-deactivated-copy.md): Notifying when a staff member is reactivated
  - Tag
    - [Tag Add](https://developers.intandem.tech/reference/tag-add-delete.md)
    - [Tag Delete](https://developers.intandem.tech/reference/tag-add-delete-copy.md)
  - Invoice
    - [Invoice issued](https://developers.intandem.tech/reference/invoice-issued.md)
    - [Invoice Updated](https://developers.intandem.tech/reference/invoice-issued-updated-copy.md)
- [Webhooks](https://developers.intandem.tech/reference/webhooks.md): Webhooks are a useful tool for apps that want to stay in sync with our system or execute code after a specific event occurs on the system, for example, when a message is recieved or when a new…
  - [Subscribe to Webhook](https://developers.intandem.tech/reference/post_platform-v1-webhook-subscribe.md): ## Overview Subscribe to webhook notifications. Webhooks allow you to receive real-time notifications when specific events occur in the system. You must specify the event (a combined string of entity…
  - [Unsubscribe from Webhook](https://developers.intandem.tech/reference/post_platform-v1-webhook-unsubscribe.md): ## Overview Unsubscribe from webhook. Note: This endpoint uses legacy parameter names ('event' and 'target_url'). The 'target_url' must match exactly the URL used when subscribing. The 'event'…
  - [Get Webhooks List](https://developers.intandem.tech/reference/get_platform-v1-webhooks.md): ## Overview Get webhooks list.  Available for **Staff and Directory tokens**.
- Automation
  - [Get Automation Flows](https://developers.intandem.tech/reference/get_platform-v1-business-jobber-flows.md): ## Overview Retrieves automation flows for a business. This endpoint redirects to the correct automation flows API.  Available for **Staff and Directory tokens**.
  - [Get Next Execution Time](https://developers.intandem.tech/reference/get_platform-v1-business-jobber-executions.md): ## Overview Retrieves the next scheduled execution time for a specific automation flow rule. This endpoint is useful for displaying when an automation will next run, allowing users to see upcoming…
- Online Profiles
  - [Get Online Profile](https://developers.intandem.tech/reference/getonlineprofilepublic.md): ## Overview Retrieve the online profile for a specific business. This is a **public endpoint** that does not require authentication. Note: Returns 200 with null data even if business doesn't exist.…
  - [Get My Online Profile](https://developers.intandem.tech/reference/getmyonlineprofile.md): ## Overview Retrieve the online profile for the business associated with the authenticated token.  Available for **Staff Tokens**.
  - [Create Online Profile](https://developers.intandem.tech/reference/createonlineprofile.md): ## Overview Create a new online profile for the business. Requires `can_access_admin_account?` permission. Available for **Staff tokens**.  **Important**: Online profiles are singleton resources -…
  - [Update Online Profile](https://developers.intandem.tech/reference/updateonlineprofile.md): ## Overview with `can_access_admin_account?` permission Update an existing online profile. Available for **Staff tokens**.
- Access Control
  - Business Role
    - [The BusinessRole Object](https://developers.intandem.tech/reference/business-role-1.md)
    - [Get all BusinessRoles](https://developers.intandem.tech/reference/get_v3-access-control-business-roles.md): Get a list of BusinessRoles  Available for **Staff Tokens**
    - [Create a BusinessRole](https://developers.intandem.tech/reference/post_v3-access-control-business-roles.md): Create a new role for a business.  **Permission Hierarchy Validation:** Permissions follow a hierarchy structure where category permissions (e.g., `payments.manage`) must be enabled before their…
    - [Retrieve a BusinessRole](https://developers.intandem.tech/reference/get_v3-access-control-business-roles-uid.md): Retrieve a specific BusinessRole  based on it’s unique identifier (UID)  Available for **Staff Tokens**
    - [Update a BusinessRole](https://developers.intandem.tech/reference/put_v3-access-control-business-roles-uid.md): Create a new role for a business  Available for **Staff Tokens**
    - [Delete a BusinessRole](https://developers.intandem.tech/reference/delete_v3-access-control-business-roles-uid.md): Delete a specific BusinessRole  based on it’s unique identifier (UID)  Available for **Staff Tokens**
  - Staff Permission
    - [The StaffPermission Object](https://developers.intandem.tech/reference/the-staffpermission-object.md)
    - [Get All StaffPermissions](https://developers.intandem.tech/reference/get_v3-access-control-staff-permissions.md): Get a list of staff Permissions. You must filter the list using a list of permissions keys Used to validate if a user can or can not access features  Available for **Staff Tokens**
  - Staff Permission Override List
    - [The StaffPermissionOverrideList Object](https://developers.intandem.tech/reference/staff-permission-override-list-1.md)
    - [Retrieve a Staff Permissions Overrides List](https://developers.intandem.tech/reference/get_v3-access-control-staff-permission-overrides-lists-staff-uid.md): Retrieve a StaffPermissionOverrideList based on a staff member's unique identifier (staff_uid)  Available for **Staff Tokens**
    - [Update a Staff Permissions Overrides List](https://developers.intandem.tech/reference/put_v3-access-control-staff-permission-overrides-lists-staff-uid.md): Update a Staff Permission Overrides List based on staff UID and a list of permissions. The list supplied will append new permissions and override exsiting permissions assigned to this staff.…
    - [Remove all permission overrides](https://developers.intandem.tech/reference/delete_v3-access-control-staff-permission-overrides-lists-staff-uid.md): Removes all assigned overrides based on a staff member's unique identifier (staff_uid).  This will return user to its original Business Role defaults  Available for **Staff Tokens**
    - [Get all Staff Permission Overrides Lists](https://developers.intandem.tech/reference/get_v3-access-control-staff-permission-overrides-lists.md): Get a list of all StaffPermissionOverrideList in the business (if used by a user that has permissions to view and manage permissions to staff in the business)  Available for **Staff Tokens**
  - Staff Business Role
    - [The Staff Business Role Object](https://developers.intandem.tech/reference/staffbusinessrole.md)
    - [Get all StaffBusinessRoles](https://developers.intandem.tech/reference/get_v3-access-control-staff-business-roles.md): Get a list of StaffBusinessRoles  Available for **Staff Tokens**
    - [Create a StaffBusinessRole](https://developers.intandem.tech/reference/post_v3-access-control-staff-business-roles.md): Create a new StaffBusinessRole for a staff  Available for **Staff Tokens**
    - [Retrieve a StaffBusinessRole](https://developers.intandem.tech/reference/get_v3-access-control-staff-business-roles-staff-uid.md): Retrieve a StaffBusinessRole based on the unique identifier of staff_uid (staff_uid)  Available for **Staff Tokens**
    - [Update a StaffBusinessRole](https://developers.intandem.tech/reference/put_v3-access-control-staff-business-roles-staff-uid.md): Update the business role for a staff member. **All overrides will be removed** and user will need to reapply them if the old role is reassigned. You can not change the role of the business owner.…
  - Permission
    - [The Permission Object](https://developers.intandem.tech/reference/permission-1.md)
    - [Get all Permissions](https://developers.intandem.tech/reference/get_v3-access-control-permissions.md): Get a list of Permissions.  **Note:** This endpoint returns an empty list if the `roles_and_permissions` feature is not enabled for the business. The presence of permissions in the response indicates…

## API Reference: Scheduling
- Appointments
  - [Get Appointments List](https://developers.intandem.tech/reference/get_platform-v1-scheduling-appointments.md): ## Overview Retrieves a paginated list of appointments for the business. Supports filtering by client, appointment state, and sorting.  ## Booking note Appointments are the scheduled items on the…
  - [Get Appointment](https://developers.intandem.tech/reference/get_platform-v1-scheduling-appointments-appointment-id.md): ## Overview Get appointment details by ID.  ## Booking note If your goal is to **create** appointments or manage client lifecycle actions (reschedule/cancel), look for the Bookings endpoints (for…
  - [Create Appointments [Business]](https://developers.intandem.tech/reference/post_business-scheduling-v1-appointments.md): ## Overview Create one or more appointments on the business calendar. Available for **Staff tokens**.  Each element of `appointments` is a complete appointment definition, so several appointments —…
- Bookings [Directory/Client]
  - [Get Bookings [Alpha] ](https://developers.intandem.tech/reference/get_platform-v1-scheduling-bookings.md): ## Overview Get bookings of the authenticated client. Returns a paginated list of the client's appointments and event registrations.  Available for **Client tokens** only.
  - [Create New Booking [Alpha]](https://developers.intandem.tech/reference/post_platform-v1-scheduling-bookings.md): ## Overview Creates a booking for either an appointment with a staff member or registration for a group event.  ## Relationship to appointments and events A **booking** is the lifecycle/action…
  - [Cancel a Booking [Alpha]](https://developers.intandem.tech/reference/post_platform-v1-scheduling-bookings-cancel.md): ## Overview Cancel booking Available for **Staff, App, Directory, and Client tokens**.
  - [Update RSVP state](https://developers.intandem.tech/reference/put_platform-v1-scheduling-bookings-booking-uid-update-rsvp-state.md): ## Overview Update RSVP state for a booking. Available for **Client tokens** only.  ## Required Parameters - `booking_uid` (path): The booking UID - `new_rsvp_state` (query): Valid values:…
  - [Create event Waitlist](https://developers.intandem.tech/reference/post_platform-v1-scheduling-waitlist.md): ## Overview Join an event waitlist.  ## Booking note To **register a client** directly to an event instance (instead of joining the waitlist), create a booking using `POST…
  - [Cancel a Waitlist registration](https://developers.intandem.tech/reference/put_platform-v1-scheduling-waitlist-cancel.md): ## Overview Cancel a waitlist registration.  ## Booking note To **register a client** to an event instance (instead of joining a waitlist), create a booking using `POST…
  - [Get Scheduling Form](https://developers.intandem.tech/reference/get_platform-v1-scheduling-scheduling-forms-get-form.md): ## Overview Returns the definition of the business's **scheduling form** - the fields a client must fill in when booking.  ## Why you need it The field uids returned here are the keys of…
- Event Attendances
  - [Get Event Attendance](https://developers.intandem.tech/reference/get_platform-v1-scheduling-event-attendances-event-attendance-uid.md): ## Overview Get Event attendance details for a specific event attendance record.  ## Booking note To **register a client** to an event instance, create a booking using `POST…
- Bookings [Business]
  - [Create New Booking [Business]](https://developers.intandem.tech/reference/post_business-scheduling-v1-bookings.md): ## Overview Create a new booking (appointment or event attendance). Available for **Staff, Directory, and Application tokens**.  **Important**: Always provide `client_id` parameter. Without it, the…
  - [Accept a Booking [Business]](https://developers.intandem.tech/reference/post_business-scheduling-v1-bookings-accept.md): ## Overview Accept a pending booking. Available for **Staff and App tokens**.  ## Batch Operations Supports batch operations by providing an array of booking IDs (max 50).  ## Response Returns the…
  - [Cancel a Booking [Business]](https://developers.intandem.tech/reference/put_business-scheduling-v1-bookings-cancel.md): ## Overview Cancel an existing booking. Available for **Staff and App tokens**.  ## Batch Operations Supports batch operations by providing an array of booking IDs (max 50).  ## Parameters -…
  - [Mark booking as no show](https://developers.intandem.tech/reference/post_business-scheduling-v1-bookings-complete.md): ## Overview Mark a booking as completed or no-show. Available for **Staff and App tokens**.  ## Batch Operations Supports batch operations by providing an array of booking IDs (max 50).  ##…
  - [Update Booking Details [Business]](https://developers.intandem.tech/reference/put_business-scheduling-v1-bookings-booking-id.md): ## Overview Update booking details including start time, staff, and notes. Available for **Staff and App tokens**.  **Note**: The path parameter is `booking_id` (not `booking_uid`).
- Event Instance
  - [Get Event Instance](https://developers.intandem.tech/reference/get_platform-v1-scheduling-event-instance-event-instance-id.md): ## Overview Get Event Instance Details.  ## Booking note To **register a client** to this event instance, create a booking using `POST /platform/v1/scheduling/bookings` and provide…
- Services
  - [List Services](https://developers.intandem.tech/reference/get_platform-v1-services-1.md): ## Overview Lists the bookable services of a business - both `AppointmentService` (one-on-one appointments) and `EventService` (group events).  ## Why you need it `id` is the `service_id` for `POST…
- Staff Availability
  - [Get Staff Availability](https://developers.intandem.tech/reference/get_platform-v1-staff-availability.md): ## Overview Returns available time slots for one or more staff members. The endpoint considers staff weekly availability schedules, calendar sync conflicts, blocked times, and existing bookings to…
- ExternalCalendarItems
  - [External app bulk create external items](https://developers.intandem.tech/reference/put_business-scheduling-v1-external-calendar-items-bulk-create.md): ## Overview Bulk create or update external calendar items. Available for **Staff and App tokens**.  ## Prerequisite **Staff member must have a CalendarSync record** (typically created via the vcita…
  - [External app bulk deactivate external items](https://developers.intandem.tech/reference/put_business-scheduling-v1-external-calendar-items-bulk-deactivate.md): ## Overview Bulk deactivate external calendar items. Available for **Staff and App tokens**.  ## Prerequisite **Staff member must have a CalendarSync record** (typically created via the vcita web UI…
  - [External app connect](https://developers.intandem.tech/reference/put_business-scheduling-v1-external-calendar-items-connect.md): ## Overview Connect a staff member's calendar to an external calendar provider. Available for **Staff and App tokens**.  ## Prerequisite **Staff member must have a CalendarSync record** (typically…
  - [External app deactivate external calendar](https://developers.intandem.tech/reference/put_business-scheduling-v1-external-calendar-items-deactivate-external-calendar.md): ## Overview Deactivate a specific external calendar. Available for **Staff and App tokens**.  ## Prerequisites The `external_calendar_uid` is returned in the response when calling the…
  - [External app disable](https://developers.intandem.tech/reference/put_business-scheduling-v1-external-calendar-items-disable.md): ## Overview Disable calendar sync for a staff member. Available for **Staff and App tokens**.  ## Prerequisite **Staff member must have a CalendarSync record** (typically created via the vcita web UI…
  - [External app disconnect](https://developers.intandem.tech/reference/put_business-scheduling-v1-external-calendar-items-disconnect.md): ## Overview Disconnect a staff member's calendar from an external calendar provider. Available for **Staff and App tokens**.  ## Prerequisite **Staff member must have a CalendarSync record**…
  - [External app report_sync_status](https://developers.intandem.tech/reference/put_business-scheduling-v1-external-calendar-items-report-sync-status.md): ## Overview Report the sync status after completing a calendar sync operation. Available for **Staff and App tokens**.  ## Prerequisite **Note:** This endpoint requires a synchronized calendar to be…
  - [External app start_export](https://developers.intandem.tech/reference/put_business-scheduling-v1-external-calendar-items-start-export.md): ## Overview Start exporting vcita calendar events to an external calendar. Available for **Staff and App tokens**.  ## Prerequisite **Staff member must have a CalendarSync record** (typically created…
  - [External app stop import](https://developers.intandem.tech/reference/put_business-scheduling-v1-external-calendar-items-stop-import.md): ## Overview Stop importing events from an external calendar. Available for **Staff and App tokens**.  ## Prerequisite **Staff member must have a CalendarSync record** (typically created via the vcita…
- Weekly availability
  - [General availability - Create new time slot](https://developers.intandem.tech/reference/post_business-scheduling-v1-time-slots.md): ## Overview General availability - Create new time slot. Available for **Staff and App tokens**.  ## Prerequisites You need a `weekly_availability_uid` which can be obtained from the staff or service…
  - [General availability - Remove time slot](https://developers.intandem.tech/reference/delete_business-scheduling-v1-time-slots-time-slot-uid.md): ## Overview General availability - Remove time slot Available for **Staff and App tokens**.
  - [General availability - Update time slot](https://developers.intandem.tech/reference/put_business-scheduling-v1-time-slots-time-slot-uid.md): ## Overview General availability - Update time slot. Available for **Staff and App tokens**.  ## Prerequisites You need a valid `time_slot_uid` from an existing time slot, and the `start_time` and…
- Availability Slots
  - [Get all AvailabilitySlots](https://developers.intandem.tech/reference/get_v3-scheduling-availability-slots.md): ## Overview This endpoint returns available time slots for booking appointments. It considers staff schedules, resource availability, existing bookings, and business hours to compute open slots.…
- Resource Type
  - [Get all ResourceTypes](https://developers.intandem.tech/reference/get_v3-scheduling-resource-types.md): ## Overview Get a list of resource types for a business, with pagination.  Available for **Staff, Directory, and Client tokens**
  - [Create a ResourceType](https://developers.intandem.tech/reference/post_v3-scheduling-resource-types.md): ## Overview Create a new resource type Available for **Staff Tokens**.
  - [Retrieve a ResourceType](https://developers.intandem.tech/reference/get_v3-scheduling-resource-types-uid.md): ## Overview Get a specific resource type by UID.  Available for **Staff, Directory, and Client tokens**
  - [Update a ResourceType](https://developers.intandem.tech/reference/put_v3-scheduling-resource-types-uid.md): ## Overview Update a resource type's properties Available for **Staff Tokens**.
  - [Delete a ResourceType](https://developers.intandem.tech/reference/delete_v3-scheduling-resource-types-uid.md): ## Overview Delete a resource type. Deletes all associated resources Available for **Staff Tokens**.
- Resource
  - [Get all Resources](https://developers.intandem.tech/reference/get_v3-scheduling-resources.md): ## Overview Get all resources, with pagination and filtering by resource type or service.  Available for **Staff Tokens**.
  - [Create a Resource](https://developers.intandem.tech/reference/post_v3-scheduling-resources.md): ## Overview Create a new resource Available for **Staff Tokens**.
  - [Retrieve a Resource](https://developers.intandem.tech/reference/get_v3-scheduling-resources-uid.md): ## Overview Get a specific resource by UID.  Available for **Staff, Directory, and Client tokens**
  - [Update a Resource](https://developers.intandem.tech/reference/put_v3-scheduling-resources-uid.md): ## Overview Update a resource's properties Available for **Staff Tokens**.
  - [Delete a Resource](https://developers.intandem.tech/reference/delete_v3-scheduling-resources-uid.md): ## Overview Soft-delete a resource Available for **Staff Tokens**.

## API Reference: Sales
- Financial Operations
  - Product Orders
    - [Create Product Order](https://developers.intandem.tech/reference/post_business-payments-v1-product-orders.md): ## Overview Creates a Product Order. Available for **Staff and Internal tokens**.
    - [Get Product Order](https://developers.intandem.tech/reference/get_business-payments-v1-product-orders-product-order-uid.md): ## Overview Gets a Product Order. Available for **Staff Tokens**.
    - [Update Product Order](https://developers.intandem.tech/reference/put_business-payments-v1-product-orders-product-order-uid.md): ## Overview Updates a Product Order. Available for **Staff and Internal tokens**.
  - Sales Reports
    - [Retrieve Payment Plans Summary](https://developers.intandem.tech/reference/getpaymentplanssummary.md): ## Overview Fetch the totals shown at the top of the payment plans page: what plans collected this year, how many plans are active, what active plans will charge in the next 4 weeks, and what failed…
    - [Retrieve Payments Forecast Data](https://developers.intandem.tech/reference/get_v3-sales-reports-forecast-payments.md): ## Overview Fetch detailed data for the Payments forecast widget, providing predictions of future payments on a month-by-month basis. This endpoint is accessible with **Staff Tokens** only.…
    - [Retrieve Payments Widget Data](https://developers.intandem.tech/reference/get_v3-sales-reports-payments-widget.md): ## Overview Fetch summarized data for the Payments widget, including total payments, overdue payments, and pending estimates. This endpoint is accessible with **Staff Tokens** only.  Available for…
  - Estimates
    - [Create Estimate](https://developers.intandem.tech/reference/post_business-payments-v1-estimates.md): ## Overview Creates an Estimate Available for **Staff, App, and Directory tokens**.
    - [Get Estimate](https://developers.intandem.tech/reference/get_business-payments-v1-estimates-estimate-uid.md): ## Overview Fetch a specific estimate. The returned status is one of DRAFT / ISSUED / APPROVED / REJECTED / INVOICED; INVOICED means an invoice was created from the estimate. Available for **Staff…
    - [update](https://developers.intandem.tech/reference/put_business-payments-v1-estimates-estimate-uid.md): ## Overview update an existing estimate Available for **Staff, App, and Directory tokens**.
    - [Get Estimates List](https://developers.intandem.tech/reference/get_platform-v1-estimates.md): ## Overview Returns a list of estimates for the business.  ## Authentication Available for **Staff tokens** only. Requires `payments.manage` permission.  > ⚠️ **Fallback API Required** - This…
  - Invoices
    - [Create Invoice](https://developers.intandem.tech/reference/post_business-payments-v1-invoices.md): ## Overview Creates an Invoice Available for **Staff, App, and Directory tokens**.
    - [Get Invoice](https://developers.intandem.tech/reference/get_business-payments-v1-invoices-invoice-uid.md): ## Overview Fetch a specific invoice. Available for **Staff Tokens**.
    - [update](https://developers.intandem.tech/reference/put_business-payments-v1-invoices-invoice-uid.md): ## Overview Update an existing invoice. Available for **Staff, App, and Directory tokens**.  ## Important - When updating invoice items, `item_index` is required to properly order the items. -…
    - [Cancel Invoice](https://developers.intandem.tech/reference/put_business-payments-v1-invoices-invoice-uid-cancel.md): ## Overview Cancels an Invoice Available for **Staff, App, and Directory tokens**.
    - [Get Invoices List](https://developers.intandem.tech/reference/get_platform-v1-invoices.md): ## Overview Get Invoices List. Available for **Application Tokens**.
    - [Create New Invoice](https://developers.intandem.tech/reference/post_platform-v1-invoices.md): ## Overview Create New Invoice. Available for **Application Tokens**.
    - [Get Invoice By ID](https://developers.intandem.tech/reference/get_platform-v1-invoices-invoice-id.md): ## Overview Get Invoice By ID.  Available for **Staff, Directory, and Client tokens**
  - Sales
    - [Create Sale](https://developers.intandem.tech/reference/post_business-payments-v1-carts.md): ## Overview Creates a Sale Available for **Staff, App, and Directory tokens**.
    - [Get Sale](https://developers.intandem.tech/reference/get_business-payments-v1-carts-uid.md): ## Overview Show specific sale data.  Available for **Staff, Directory, and Client tokens**
    - [Cancel an open sale](https://developers.intandem.tech/reference/put_business-payments-v1-carts-uid-cancel.md): ## Overview Cancel a sale Available for **Staff, App, and Directory tokens**.  ## Prerequisites This endpoint is only available for businesses with the `point_of_sale` feature enabled. The cart must…
    - [Complete an open sale](https://developers.intandem.tech/reference/put_business-payments-v1-carts-uid-cart-completed.md): ## Overview Completes and finalizes the sale Available for **Staff, App, and Directory tokens**.  ## Prerequisites Requires business to have `point_of_sale` feature enabled. Use POST…
- Payment Plan
  - [Get all PaymentPlans](https://developers.intandem.tech/reference/listpaymentplans.md): ## Overview Get a list of PaymentPlans for the business, newest updated first. Use `payment_request_uid` to find the plan collecting against a specific invoice, and `status` to list only running…
  - [Create a PaymentPlan](https://developers.intandem.tech/reference/createpaymentplan.md): Create a PaymentPlan that charges the client's saved card on a recurring schedule. Omit `payment_request_uid` for a standalone plan; supply it to collect against an open invoice.  `amount` is…
  - [Retrieve a PaymentPlan](https://developers.intandem.tech/reference/retrievepaymentplan.md): ## Overview Retrieve a specific PaymentPlan based on its unique identifier (UID), including `payment_request_uid` and the plan's collection progress.  Available for **Staff Tokens**.
  - [Update a PaymentPlan](https://developers.intandem.tech/reference/updatepaymentplan.md): Update a PaymentPlan's payment method, or set its `status`: `active` resumes a `paused` plan, `cancelled` stops an `active` or `paused` plan.  Available for **Staff Tokens**.
- LeadGen
  - [Creates a lead](https://developers.intandem.tech/reference/post_platform-v1-leadgen.md): ## Overview Creates a lead Available for **Staff, App, and Directory tokens**.
- Payment Processing
  - Payment Cards
    - [The Client Payment Card Object](https://developers.intandem.tech/reference/the-client-payment-card-object.md)
    - [List stored Payment Cards](https://developers.intandem.tech/reference/get_v3-payments-client-payment-cards.md): Returns stored payment cards for a client.  Available for **Client and Staff tokens**. - For **Client tokens**, the client is inferred from the authenticated token. The `client_uid` parameter is…
  - Scheduled Payment Rule
    - [Get list of Scheduled Payment Rules](https://developers.intandem.tech/reference/get_business-payments-v1-scheduled-payments-rules.md): ## Overview Get a list of Scheduled Payment Rules. Available for **Staff Tokens**.  ## Prerequisites Scheduled payments require: 1. Payment gateway configured that supports recurring payments…
    - [Create Scheduled Payment Rule](https://developers.intandem.tech/reference/post_business-payments-v1-scheduled-payments-rules.md): ## Overview Creates a Scheduled Payment Rule Available for **Staff, App, and Directory tokens**.  ## Prerequisites 1. Business must have the `scheduled_payments` feature enabled. 2. Business must…
    - [Get Scheduled Payment Rule](https://developers.intandem.tech/reference/get_business-payments-v1-scheduled-payments-rules-uid.md): ## Overview Gets a Scheduled Payment Rule. Available for **Staff Tokens**.  ## Prerequisites Scheduled payments require complex pre-configuration: 1. **Payment Gateway**: Business must have a payment…
    - [Update Scheduled Payment Rule](https://developers.intandem.tech/reference/put_business-payments-v1-scheduled-payments-rules-uid.md): ## Overview Updates a Scheduled Payment Rule Available for **Staff, App, and Directory tokens**.  ## Prerequisites 1. **Payment Gateway**: Business must have a payment gateway configured that…
    - [Cancel Recurring Payments Rule](https://developers.intandem.tech/reference/put_business-payments-v1-scheduled-payments-rules-uid-cancel.md): ## Overview Cancels a Recurring Payments Rule Available for **Staff, App, and Directory tokens**.  ## Prerequisites Requires business to have a payment gateway that supports recurring payments. The…
  - Bulk Taxes
    - [Delete Multiple Taxes](https://developers.intandem.tech/reference/delete_business-payments-v1-tax-bulk.md): ## Overview Deletes some taxes. Available for **Staff and Internal tokens**.
    - [Create Multiple Taxes](https://developers.intandem.tech/reference/post_business-payments-v1-tax-bulk.md): ## Overview Creates some taxes. Available for **Staff and Internal tokens**.
    - [Update Multiple Taxes](https://developers.intandem.tech/reference/put_business-payments-v1-tax-bulk.md): ## Overview Updates some taxes. Available for **Staff and Internal tokens**.
    - [Apply Default Taxes](https://developers.intandem.tech/reference/put_business-payments-v1-tax-bulk-apply-defaults.md): ## Overview Apply default taxes on items (Services/Products/Booking Packages) that don't have any taxes configured. Available for **Staff and Internal tokens**.
  - Card Requests
    - [Create Card Request](https://developers.intandem.tech/reference/post_business-payments-v1-card-requests.md): ## Overview Creates a Card Request Available for **Staff, App, and Directory tokens**.  ## Prerequisites The business must have a payment gateway configured that supports the…
    - [Get Card Request](https://developers.intandem.tech/reference/get_business-payments-v1-card-requests-client-uid.md): ## Overview Gets a Card Request. Available for **Staff Tokens**.
  - Client Payment Cards
    - [Get Client Payment Cards](https://developers.intandem.tech/reference/get_platform-v1-clients-payment-cards.md): ## Overview Retrieve all payment cards for a client. Available for **Client Tokens only**.  ## Authentication This endpoint requires client token authentication rather than staff token.
    - [Get Client Payment Cards (Staff Access)](https://developers.intandem.tech/reference/getclientpaymentcards.md): ## Overview Retrieve all payment cards for a specific client. Available for **Staff Tokens**.
  - Payments
    - [List Payments](https://developers.intandem.tech/reference/get_business-payments-v1-payments.md): ## Overview List Payments. Available for **Staff Tokens**.
    - [Get Payment](https://developers.intandem.tech/reference/get_business-payments-v1-payments-payment-uid.md): ## Overview Get Payment. Available for **Staff Tokens**.
    - [Update Payment](https://developers.intandem.tech/reference/put_business-payments-v1-payments-payment-uid.md): ## Overview Update Payment Available for **Staff, App, and Directory tokens**.
    - [Get Payments List](https://developers.intandem.tech/reference/get_platform-v1-payments.md): ## Overview Get Payments List. Available for **Staff Tokens**.  ## Prerequisites The business must have the `payments_module` feature enabled.
    - [Create New Payment](https://developers.intandem.tech/reference/post_platform-v1-payments.md): ## Overview Create New Payment. Available for **Staff, App, and Directory tokens**. Directory tokens require the `X-On-Behalf-Of` header.  ## Prerequisites The business must have the…
    - [Match Payment](https://developers.intandem.tech/reference/post_platform-v1-payments-payment-uid-match.md): ## Overview Match Payment Available for **Staff, App, and Directory tokens**.
    - [Get Payment by ID](https://developers.intandem.tech/reference/get_platform-v1-payments-payment-uid.md): ## Overview Get Payment by ID. Available for **Staff Tokens**.  ## Prerequisites The business must have the `payments_module` feature enabled.
  - Payment Checkout
    - [Send checkout update by webhook ](https://developers.intandem.tech/reference/put_platform-v1-payment-checkout.md): ## Overview Update a checkout process from webhook Available for **Staff, Directory, and Client tokens**.  ## Important This is a webhook endpoint designed to be called by external payment providers…
    - [Get Open Checkout For Specific url_key](https://developers.intandem.tech/reference/get_platform-v1-payment-checkout-url-key.md): ## Overview Get Open Checkout For Specific url_key.  Available for **Staff, Directory, and Client tokens**
  - Payment Gateways
    - [Delete a PaymentGateway](https://developers.intandem.tech/reference/delete_v3-payment-processing-payment-gateways-uid.md): Delete an existing payment gateway - Available for **Application Tokens**
    - [Retrieve a PaymentGateway](https://developers.intandem.tech/reference/get_v3-payment-processing-payment-gateways-uid.md): Get details of a specific payment gateway - Available for **Directory, Business, and Application Tokens**. Note: Application tokens can only access their own gateway.
    - [Get all PaymentGateways](https://developers.intandem.tech/reference/get_v3-payment-processing-payment-gateways.md): Retrieve all available payment gateways - Available for **Directory, Business, and Client Tokens**  **Note:** When using a **Client token**, all fields are returned in the response, but sensitive…
    - [Create a PaymentGatewayAssignment](https://developers.intandem.tech/reference/post_v3-payment-processing-payment-gateway-assignments.md): Assign a payment gateway to a directory - Available for **Directory Tokens**
    - [Create a PaymentGateway](https://developers.intandem.tech/reference/post_v3-payment-processing-payment-gateways.md): Create a new payment gateway - Available for **Application Tokens**
    - [Update a PaymentGateway](https://developers.intandem.tech/reference/put_v3-payment-processing-payment-gateways-uid.md): Update an existing payment gateway - Available for **Application Tokens**
  - Payment Requests
    - [GET Payment Requests List](https://developers.intandem.tech/reference/get_business-payments-v1-payment-requests.md): ## Overview GET Payment Requests List. Available for **Staff, App, and Directory tokens**.
    - [GET Payment Request](https://developers.intandem.tech/reference/get_business-payments-v1-payment-requests-payment-request-uid.md): ## Overview GET Payment Request. Available for **Staff Tokens**.
    - [update](https://developers.intandem.tech/reference/put_business-payments-v1-payment-requests-payment-request-uid.md): ## Overview update an existing payment request Available for **Staff, App, and Directory tokens**.
    - [Send payment request link](https://developers.intandem.tech/reference/post_business-payments-v1-payment-requests-payment-request-uid-send-link.md): ## Overview Send payment request link Available for **Staff tokens**.
  - Payment Settings
    - [Get Current Payment Settings](https://developers.intandem.tech/reference/get_platform-v1-payment-settings.md): ## Overview Get Current Payment Settings. Available for **Staff Tokens**.
    - [Update Payment Settings](https://developers.intandem.tech/reference/post_platform-v1-payment-settings.md): ## Overview Update Payment Settings Available for **Staff, App, and Directory tokens**.
    - [Update Default Currency](https://developers.intandem.tech/reference/put_platform-v1-payment-settings-update-default-currency.md): ## Overview Update Default Currency Available for **Staff, App, and Directory tokens**.
  - Packages
    - [Reorder Catalog Packages [Alpha]](https://developers.intandem.tech/reference/put_business-payments-v1-packages-reorder.md): ## Overview Set the display order of package catalog templates. Controls the sequence in which packages appear in the business's package catalog and client-facing portal.  ## Authentication Available…
    - [List Catalog Packages](https://developers.intandem.tech/reference/get_platform-v1-payment-packages.md): ## Overview Retrieve a list of package catalog templates for the business. A package is a reusable template that defines a bundle of services and/or products a client can purchase, including pricing,…
    - [Create Catalog Package](https://developers.intandem.tech/reference/post_platform-v1-payment-packages.md): ## Overview Create a new package catalog template for the business. A package defines a bundle of services and/or products that can be sold to clients, including pricing, credit allocations per…
    - [Show Catalog Package Details](https://developers.intandem.tech/reference/get_platform-v1-payment-packages-package-id.md): ## Overview Retrieve detailed information for a single package catalog template, including its items (service/product groups), pricing, expiration settings, and active status.  ## Authentication…
    - [Update Catalog Package [Alpha]](https://developers.intandem.tech/reference/put_platform-v1-payment-packages-package-id.md): ## Overview Update an existing package catalog template. You can modify pricing, name, description, expiration settings, items, and active status. Changes to the catalog template do NOT retroactively…
  - Payment Statuses
    - [Apply Coupon](https://developers.intandem.tech/reference/put_platform-v1-payment-statuses-id-apply-coupon.md): ## Overview Applies a coupon code to a payment status, reducing the amount due. The payment status must reference a coupon-eligible entity type: `Meeting`, `EventAttendance`, `PendingBooking`, or…
    - [Validate Coupon](https://developers.intandem.tech/reference/get_platform-v1-payment-statuses-id-validate-coupon.md): ## Overview Validates whether a coupon code can be applied to a payment status without actually applying it. Available for **Staff, App, and Directory tokens**.  ## Required Parameters -…
  - card
    - [Update Card](https://developers.intandem.tech/reference/put_business-payments-v1-cards-uid.md): ## Overview Updates a Card Available for **Staff, App, and Directory tokens**.
    - [Create sync card](https://developers.intandem.tech/reference/post_platform-v1-payment-cards-sync-card.md): ## Overview Create sync card Available for **Staff, App, and Directory tokens**.  ## Required Fields - `customer_id`: The customer ID from the payment gateway (e.g., Stripe customer ID). This is…
    - [Delete saved card](https://developers.intandem.tech/reference/delete_platform-v1-payment-cards-card-id.md): ## Overview Delete saved card Available for **Staff, App, and Directory tokens**.
  - Payouts
    - [Create Payout](https://developers.intandem.tech/reference/post_business-payments-v1-payouts.md): ## Overview Creates a Payout Available for **Staff, App, and Directory tokens**.
    - [Get Payout](https://developers.intandem.tech/reference/get_business-payments-v1-payouts-provider-payout-id.md): ## Overview Gets a Payout.  Available for **Staff, Directory, and Client tokens**
    - [Update Payout](https://developers.intandem.tech/reference/put_business-payments-v1-payouts-provider-payout-id.md): ## Overview Updates a Payout Available for **Staff, App, and Directory tokens**.
  - Refunds
    - [Create Refund](https://developers.intandem.tech/reference/post_business-payments-v1-refunds.md): ## Overview Creates a Refund Available for **Staff, App, and Directory tokens**.
  - Taxes
    - [Get Taxes List [Alpha]](https://developers.intandem.tech/reference/get_business-payments-v1-taxes.md): ## Overview Get Taxes List [Alpha]. Available for **Staff Tokens**.
    - [Create Tax [Alpha]](https://developers.intandem.tech/reference/post_business-payments-v1-taxes.md): ## Overview Create Tax [Alpha]. Available for **Staff and Internal tokens**.
    - [Remove Tax [Alpha]](https://developers.intandem.tech/reference/delete_business-payments-v1-taxes-tax-uid.md): ## Overview Remove Tax [Alpha]. Available for **Staff and Internal tokens**.
    - [Get Tax [Alpha]](https://developers.intandem.tech/reference/get_business-payments-v1-taxes-tax-uid.md): ## Overview Get Tax [Alpha]. Available for **Staff Tokens**.
    - [Update Tax [Alpha]](https://developers.intandem.tech/reference/put_business-payments-v1-taxes-tax-uid.md): ## Overview Update Tax [Alpha]. Available for **Staff and Internal tokens**.
  - Deposits
    - [Show Deposits List](https://developers.intandem.tech/reference/get_business-payments-v1-deposits.md): ## Overview Show list of deposits. Available for **Staff, App, and Directory tokens**.  ## Filter Validation Rules - When filtering by `entity_uid`, the `entity_type` filter must also be provided -…
    - [Create Deposit](https://developers.intandem.tech/reference/post_business-payments-v1-deposits.md): ## Overview Creates a Deposit Available for **Staff, App, and Directory tokens**.
    - [Delete Deposit](https://developers.intandem.tech/reference/delete_business-payments-v1-deposits-uid.md): ## Overview Delete a specific deposit Available for **Staff, App, and Directory tokens**.
    - [Show Deposit](https://developers.intandem.tech/reference/get_business-payments-v1-deposits-uid.md): ## Overview Show specific deposit data. Available for **Staff Tokens**.
    - [Update Deposit](https://developers.intandem.tech/reference/put_business-payments-v1-deposits-uid.md): ## Overview Update specific deposit Available for **Staff, App, and Directory tokens**.
  - Transactions
    - [Create Transaction](https://developers.intandem.tech/reference/post_business-payments-v1-transactions.md): ## Overview Creates a Transaction Available for **Staff, App, and Directory tokens**.
    - [Get Transaction](https://developers.intandem.tech/reference/get_business-payments-v1-transactions-provider-transaction-id.md): ## Overview Gets a Transaction.  Available for **Staff, Directory, and Client tokens**
    - [Update Transaction](https://developers.intandem.tech/reference/put_business-payments-v1-transactions-provider-transaction-id.md): ## Overview Updates a Transaction Available for **Staff, App, and Directory tokens**.
- Catalog
  - Client Packages
    - [Cancel Credit Redemption [Alpha]](https://developers.intandem.tech/reference/put_platform-v1-payment-client-packages-cancel-redemption.md): ## Overview Reverse a previous package credit redemption, restoring the consumed credit back to the client's package. This is the undo operation for `POST…
    - [Use Client Package Credit [Alpha]](https://developers.intandem.tech/reference/post_platform-v1-payment-client-packages-update-usage.md): ## Overview Redeem a credit from a client's active package to pay for an appointment or service session. This marks the associated payment status as paid (price set to $0) and decrements one credit…
    - [Show Client Package [Alpha]](https://developers.intandem.tech/reference/get_business-payments-v1-client-packages-uid.md): ## Overview Retrieve detailed information for a specific client package (a package subscription assigned to a client). Returns the package's validity dates, pricing, active status, and booking credit…
    - [Update Client Package [Alpha]](https://developers.intandem.tech/reference/put_business-payments-v1-client-packages-uid.md): ## Overview Update an existing client package subscription. Allows extending the validity period and adjusting credit allocations for the package's booking credits.  ## Authentication Available for…
    - [Create Client Package](https://developers.intandem.tech/reference/post_platform-v1-payment-client-packages.md): ## Overview Create a Client Package — assigns a payment package to a specific client, creating a subscription-like record with optional validity dates and custom pricing.  ## Feature Requirement…
  - Services
    - [Get Services List](https://developers.intandem.tech/reference/get_platform-v1-services.md): ## Overview Get services list. Available for **Staff Tokens**.  ## Parameters Note: The `business_id` parameter should contain the business UID (unique identifier like '88pzdbz1hmkdoel4'), not the…
    - [Get Services Availability](https://developers.intandem.tech/reference/get_platform-v1-services-availability.md): ## Overview Get services availability.  ## Required Parameters Either `service_ids` OR `id` must be provided. These parameters are mutually exclusive - use one or the other.  Available for **Staff,…
    - [Get Service Details](https://developers.intandem.tech/reference/get_platform-v1-services-service-uid.md): ## Overview Get specific service details.  Available for **Staff, Directory, and Client tokens**
    - [Get Service Specific Availability](https://developers.intandem.tech/reference/get_platform-v1-services-service-uid-availability.md): ## Overview Get specific service availability.  Available for **Staff, Directory, and Client tokens**
    - [Create Service](https://developers.intandem.tech/reference/post_v2-settings-services.md): ## Overview Creates a new service for the business. This is the write endpoint for services — the read-only list is at `GET /platform/v1/services`.  Available for **Staff tokens**.  ## Important…
  - Products
    - [Get Products List](https://developers.intandem.tech/reference/get_business-payments-v1-products.md): ## Overview Get Products List. Available for **Staff Tokens**.
    - [Create Product](https://developers.intandem.tech/reference/post_business-payments-v1-products.md): ## Overview Each business has a limit of 8,500 products. Available for **Staff and Internal tokens**.
    - [Remove Product [Alpha]](https://developers.intandem.tech/reference/delete_business-payments-v1-products-product-uid.md): ## Overview Remove Product [Alpha]. Available for **Staff and Internal tokens**.
    - [Get Product [Alpha]](https://developers.intandem.tech/reference/get_business-payments-v1-products-product-uid.md): ## Overview Get Product [Alpha]. Available for **Staff Tokens**.
    - [Update Product](https://developers.intandem.tech/reference/put_business-payments-v1-products-product-uid.md): ## Overview Update Product. Available for **Staff and Internal tokens**.
- Categories
  - [List Categories](https://developers.intandem.tech/reference/get_v2-settings-categories.md): Returns all service categories for the business, each with its nested services. Use this to retrieve category UIDs needed when creating services via POST /v2/settings/services.
  - [Create Category](https://developers.intandem.tech/reference/post_v2-settings-categories.md): Creates a new service category for the business.
- Credit Note
  - [Get all Credit Notes](https://developers.intandem.tech/reference/get_v3-payments-credit-notes.md): ## Overview Get a list of credit notes with pagination.
  - [Create a Credit Note](https://developers.intandem.tech/reference/post_v3-payments-credit-notes.md): ## Overview Creates and issues a new credit note against an existing invoice. The credit note is immediately issued (no draft status). The service validates that the credit amount doesn't exceed the…
  - [Retrieve a Credit Note](https://developers.intandem.tech/reference/get_v3-payments-credit-notes-uid.md): ## Overview Retrieves the details of a specific credit note by its UID.  Available for **Staff, Directory, and Client tokens**
- Coupons
  - [The Coupon Object](https://developers.intandem.tech/reference/coupon.md)
  - [List Coupons](https://developers.intandem.tech/reference/get_v2-coupons.md): ## Overview **DEPRECATED** - Use the v3 alternative `GET /v3/sales/coupons` instead.  Retrieves a list of coupons for the business. Available for **Staff tokens**.  ## Filtering You can filter…
  - [Create Coupon](https://developers.intandem.tech/reference/post_v2-coupons.md): ## Overview Creates a new coupon for the business. Available for **Staff tokens**.  ## Coupon Code If the `code` field is left blank, a random alphanumeric code will be auto-generated. Coupon codes…
  - [Get Valid Coupons for Entity](https://developers.intandem.tech/reference/get_v2-coupons-valid-coupons.md): ## Overview **DEPRECATED** - Use the v3 alternative `GET /v3/sales/coupons` instead.  Retrieves a list of valid (redeemable) coupons for a specific entity. Available for **Staff tokens**.  This…
  - [Remove Coupon from Entity](https://developers.intandem.tech/reference/post_v2-coupons-remove.md): ## Overview Removes a previously applied coupon from an entity (payment, appointment, or event attendance). Available for **Staff tokens**.  This reverses the discount that was applied via the Apply…
  - [Get Coupon](https://developers.intandem.tech/reference/get_v2-coupons-uid.md): ## Overview **DEPRECATED** - Use the v3 alternative `GET /v3/sales/coupons` instead.  Retrieves a single coupon by its UID. Available for **Staff tokens**.
  - [Update Coupon](https://developers.intandem.tech/reference/put_v2-coupons-uid.md): ## Overview Updates an existing coupon. Available for **Staff tokens**.  ## Validation Rules The same validation rules as coupon creation apply. Additionally: - You cannot change the `code` to a code…
  - [Delete Coupon](https://developers.intandem.tech/reference/delete_v2-coupons-uid.md): ## Overview Deletes a coupon. Available for **Staff tokens**.  This permanently removes the coupon. Existing redemptions are not affected.
  - [Expire Coupon](https://developers.intandem.tech/reference/post_v2-coupons-uid-expire.md): ## Overview Manually expires an active coupon, making it no longer redeemable. Available for **Staff tokens**.  This sets the coupon's `expires_at` to the current time, effectively deactivating it…
  - [Enable Coupon](https://developers.intandem.tech/reference/post_v2-coupons-uid-enable.md): ## Overview Enables a previously disabled coupon, making it redeemable again. Available for **Staff tokens**.  This removes the `disabled` flag from the coupon's configuration. The coupon must still…
  - [Disable Coupon](https://developers.intandem.tech/reference/post_v2-coupons-uid-disable.md): ## Overview Disables an active coupon, temporarily preventing it from being redeemed. Available for **Staff tokens**.  Unlike expiring a coupon, disabling is reversible - the coupon can be re-enabled…
  - [Apply Coupon to Entity](https://developers.intandem.tech/reference/post_v2-coupons-uid-apply.md): ## Overview Applies a coupon to a specific entity (payment, appointment, or event attendance), granting the associated discount. Available for **Staff tokens**.  ## Validation - The coupon must be…
  - [Get all Coupons](https://developers.intandem.tech/reference/get_v3-sales-coupons.md): ## Overview Get a list of Coupons. Available for **Staff Tokens**.
- Invoice
  - [Create an Invoice](https://developers.intandem.tech/reference/post_v3-payments-invoices.md): ## Overview Create a new invoice Available for **Staff Tokens**.
  - [Update an Invoice](https://developers.intandem.tech/reference/put_v3-payments-invoices-uid.md): ## Overview Update an existing invoice Available for **Staff Tokens**.

## API Reference: Reviews
- Business Reviews Settings
  - [The BusinessReviewsSettings Object](https://developers.intandem.tech/reference/the-business-reviews-settings-entity.md)
  - [Retrieve Business Reviews Settings](https://developers.intandem.tech/reference/get_v3-reviews-business-reviews-settings-business-uid.md): ## Overview Get the reviews settings for a specific business.  ## Authentication **Available for Staff Tokens.**
  - [Create Business Reviews Settings](https://developers.intandem.tech/reference/post_v3-reviews-business-reviews-settings.md): ## Overview Create new business reviews settings.  ## Authentication **Available for Staff Tokens.**  ## Uniqueness Constraint Each business can only have one Business Reviews Settings record. If…
  - [Update Business Reviews Settings](https://developers.intandem.tech/reference/put_v3-reviews-business-reviews-settings-business-uid.md): ## Overview Update the reviews settings for a specific business - Update the reviews settings for a specific business - Available for **Staff Tokens**.

## Changelog
- [Subscription webhooks moved to v3](https://developers.intandem.tech/changelog/subscription-webhooks-moved-to-v3.md)
- [New Permissions Framework  + Staff API Updates](https://developers.intandem.tech/changelog/new-permissions-framework-staff-api-updates.md)