======================== CODE SNIPPETS ======================== TITLE: Getting Started with Kolla API DESCRIPTION: Provides initial guidance for developers, including introduction, quick start steps, how to create invite links, and embedding KollaConnect for seamless integration. SOURCE: https://docs.kolla.dev/reference/appointments_confirmappointment LANGUAGE: APIDOC CODE: ``` Getting Started: - Introduction - Quick Start Guide - Create an Invite Link - Embed KollaConnect ``` ---------------------------------------- TITLE: Create Appointment API Call Example DESCRIPTION: This example demonstrates how to make a POST request to create a new appointment within the Unify Vet system. It specifies the HTTP method, the full API endpoint URL, and notes that credentials are required. SOURCE: https://docs.kolla.dev/reference/appointments_createappointment-3 LANGUAGE: APIDOC CODE: ``` Endpoint: Create Appointment Method: POST URL: https://unify.kolla.dev/vet/v1/appointments Description: Creates an appointment Credentials: Bearer +2 (Authentication token required) ``` ---------------------------------------- TITLE: Kolla API Endpoints Overview DESCRIPTION: This section outlines the available API resources and their respective methods (GET, POST, PATCH, PUT) for Kolla API v1.0, organized by functional areas such as Getting Started, API Basics, and specific services like Appointments, Claims, and Transactions within the Unify Dental services. SOURCE: https://docs.kolla.dev/reference/transactions_createtransaction LANGUAGE: APIDOC CODE: ``` API Reference: Getting Started: - Introduction - Quick Start - Create an Invite Link - Embed KollaConnect API Basics: - Filtering Unify Dental: Appointments: - List Appointments (GET) - Create Appointment (POST) - Get Appointment (GET) - Update Appointment (PATCH) - Cancel appointment (POST) - Set Confirmation Status (POST) - Create New Patient Appointment (POST) - List Appointment Types (GET) - List Confirmation Types (GET) Claims: - List Claimprocedures (GET) - Get Claimprocedure (GET) - List Claims (GET) - Get Claim (GET) CommunicationLogs: - List Communication Logs (GET) - Create Communication Log (POST) - Get Communication Log (GET) Contacts: - List Contacts (GET) - Create Contact (POST) - Get Contact (GET) - Update Contact (PATCH) Documents: - List Documents (GET) - Create Document (POST) Insurance: - List Insurance Coverages (GET) - List Insurance Benefits (GET) - Update Insurance Benefits (PUT) - Bulk Update Insurance Benefits (PUT) Meta: - List Document Categories (GET) - List Resources (GET) - Load Schedule (GET) Referrals: - List Referrals (GET) Tasks: - List Tasks (GET) - Create Task (POST) - Get Task (GET) Transactions: - List Custom Types (GET) - List Transactions (GET) - Create Transaction (POST) - Get Transaction (GET) - Update Transaction (PATCH) Treatment: - List Procedures (GET) - Get Procedure (GET) - List Treatment Plans (GET) - Get Treatment Plan (GET) ``` ---------------------------------------- TITLE: List TreatmentPlans API Reference DESCRIPTION: This API endpoint allows retrieval of a list of treatment plans. It is a GET request to the specified URL and requires Bearer token authentication. While various languages are mentioned as supported, no specific code examples are provided in the source. SOURCE: https://docs.kolla.dev/reference/treatment_listtreatmentplans LANGUAGE: APIDOC CODE: ``` Method: GET URL: https://unify.kolla.dev/dental/v1/treatmentPlans Description: Returns a list of treatmentPlans Supported Languages (no code provided): Shell, Node, Ruby, PHP, Python Credentials: Bearer +2 Response: Click `Try It!` to start a request and see the response here! ``` ---------------------------------------- TITLE: Kolla API Endpoint Overview DESCRIPTION: This section outlines the various API resources available in Kolla, such as Appointments, Claims, and Transactions, along with the specific operations (e.g., List, Create, Get, Update) and their corresponding HTTP methods (GET, POST, PATCH, PUT). SOURCE: https://docs.kolla.dev/reference/transactions_listcustomtypes LANGUAGE: APIDOC CODE: ``` API Endpoints: Appointments: List Appointments: GET Create Appointment: POST Get Appointment: GET Update Appointment: PATCH Cancel appointment: POST Set Confirmation Status: POST Create New Patient Appointment: POST List Appointment Types: GET List Confirmation Types: GET Claims: List Claimprocedures: GET Get Claimprocedure: GET List Claims: GET Get Claim: GET CommunicationLogs: List Communication Logs: GET Create Communication Log: POST Get Communication Log: GET Contacts: List Contacts: GET Create Contact: POST Get Contact: GET Update Contact: PATCH Documents: List Documents: GET Create Document: POST Insurance: List Insurance Coverages: GET List Insurance Benefits: GET Update Insurance Benefits: PUT Bulk Update Insurance Benefits: PUT Meta: List Document Categories: GET List Resources: GET Load Schedule: GET Referrals: List Referrals: GET Tasks: List Tasks: GET Create Task: POST Get Task: GET Transactions: List Custom Types: GET List Transactions: GET Create Transaction: POST Get Transaction: GET Update Transaction: PATCH Treatment: List Procedures: GET Get Procedure: GET List Treatment Plans: GET Get Treatment Plan: GET ``` ---------------------------------------- TITLE: Integration Metadata API Endpoints DESCRIPTION: This section describes API endpoints related to integration metadata, including operations for pinging linked accounts and creating invite links. These endpoints facilitate external system interactions and setup. SOURCE: https://docs.kolla.dev/reference/tasks_gettask LANGUAGE: APIDOC CODE: ``` Integration Metadata API: Ping Linked Account (GET) Create Invite Link (POST) ``` ---------------------------------------- TITLE: Retrieve and Use Slack Access Token with Kolla SDK in Go DESCRIPTION: This Go example demonstrates how to use the Kolla SDK to retrieve a customer's Slack OAuth2 token and then use that token to send a message via the Slack API. It shows initializing the Kolla client, fetching credentials for a specific consumer ID, and interacting with the Slack API using the obtained token. SOURCE: https://docs.kolla.dev/reference/embed-connect LANGUAGE: Go CODE: ``` package main import ( "context" os" "github.com/kollalabs/sdk-go/kc" "github.com/slack-go/slack" ) func main() { // Get api key from environment variable apiKey := os.Getenv("KC_API_KEY") // Create a new client kolla, err := kc.New(apiKey) if err != nil { log.Fatalf("unable to create kolla connect client: %s\n", err) } ctx := context.Background() creds, err := kolla.Credentials(ctx, "slack", "CONSUMER_ID") if err != nil { panic(err) } //creds.LinkedAccount.AuthData slackapi := slack.New(creds.Token) _, _, err = slackapi.PostMessage("general", slack.MsgOptionText("Hello world! (Sent with Kolla managed token)", false)) if err != nil { panic(err) } } ``` ---------------------------------------- TITLE: Get Visit API Endpoint Specification DESCRIPTION: Detailed specification for retrieving a single visit record via the Unify Vet API, including the endpoint URL, HTTP method, a brief description, and authentication requirements. This section also notes the programming languages for which code examples are available. SOURCE: https://docs.kolla.dev/reference/visits_getvisit LANGUAGE: APIDOC CODE: ``` Endpoint: GET https://unify.kolla.dev/vet/v1/visits/{visit} Description: Retrieves one visit Authentication: Bearer +2 Available Languages for Examples: Shell, Node, Ruby, PHP, Python ``` ---------------------------------------- TITLE: Guide to Creating an Invite Link for KollaConnect DESCRIPTION: A step-by-step guide explaining how to generate a secure Invite Link using the Kolla Portal to enable customers to authorize integrations with their third-party software without requiring front-end code changes. It covers the process from accessing the Kolla Portal to sending the link to the customer. SOURCE: https://docs.kolla.dev/reference/create-an-invite-link LANGUAGE: APIDOC CODE: ``` Create an Invite Link: Purpose: An easy way to connect to your customers' software without any front-end code changes. Process: 1. Go to the Linked Accounts section in your Kolla Portal. 2. Click the button at the top right titled "Create Invite Link". 3. Choose the connector you are creating the invite for, or if you want your customer to be able to choose the connector from the catalog themselves, select "Show All Integrations". 4. Input a unique customer identifier as a reference for you (most people use whatever customer ID they have in their own system). 5. Add an optional customer name for easy reference in our portal. 6. Click "Generate Link". 7. Copy the URL and send it to your customer (or use it yourself for testing). Behavior: - When the customer goes to the URL, they will see the Konnect Catalog appear with the selected connector showing (or a list of connectors if you chose that when generating the link). - Your customer will follow the simple instructions for connecting their third-party software to you. - Note: For on-premise systems (e.g., OpenDental), KollaConnect will download a data bridge agent to the server for the user to install. - After they complete the steps, a new Linked Account will be created and visible in the Kolla Portal. ``` ---------------------------------------- TITLE: Unify Vet API Endpoints Overview DESCRIPTION: Lists all available API endpoints for the Unify Vet module, categorized by resource, including methods like GET, POST, PATCH, and DELETE for managing animals, appointments, clinical notes, and contacts. SOURCE: https://docs.kolla.dev/reference/appointments_getappointment-1 LANGUAGE: APIDOC CODE: ``` Unify Vet: Animals: List Animals (GET) /reference/animals_listanimals Create Animal (POST) /reference/animals_createanimal Get Animal (GET) /reference/animals_getanimal Update Animal (PATCH) /reference/animals_updateanimal Appointments: List appointments (GET) /reference/appointments_listappointments-3 Create Appointment (POST) /reference/appointments_createappointment-3 Get Appointment (GET) /reference/appointments_getappointment-3 Update Appointment (PATCH) /reference/appointments_updateappointment-3 Cancel appointment (POST) /reference/appointments_cancelappointment-2 Set Confirmation Status (POST) /reference/appointments_confirmappointment-2 List Appointment Types (GET) /reference/appointments_listappointmenttypes-1 Clinical: List Notes (GET) /reference/clinical_listnotes Create Notes (POST) /reference/clinical_createnotes Get Notes (GET) /reference/clinical_getnotes Delete Notes (DELETE) /reference/clinical_deletenotes Update Notes (PATCH) /reference/clinical_updatenotes List note categories (GET) /reference/clinical_listnotecategories Contacts: List Contacts (GET) /reference/contacts_listcontacts-3 Create Contact (POST) /reference/contacts_createcontact-3 Get Contact (GET) /reference/contacts_getcontact-3 Update Contact (PATCH) /reference/contacts_updatecontact-3 Meta: List Resources (GET) /reference/meta_listresources-1 Load Schedule (GET) /reference/meta_loadschedule-1 List Species (GET) /reference/meta_listspecies List Breeds (GET) /reference/meta_listbreeds Transactions: List Transactions (GET) /reference/transactions_listtransactions-1 Get Transaction (GET) /reference/transactions_gettransaction-1 Visits: List visits (GET) /reference/visits_listvisits Get Visit (GET) /reference/visits_getvisit ``` ---------------------------------------- TITLE: Kolla API v1.0 Endpoint Index DESCRIPTION: This snippet outlines the available API resources and their corresponding HTTP methods (GET, POST, PATCH, PUT) as presented in the Kolla API v1.0 documentation. It provides a structured overview of the API's capabilities, organized by functional categories. SOURCE: https://docs.kolla.dev/reference/appointments_getappointment-3 LANGUAGE: APIDOC CODE: ``` API Reference v1.0 Getting Started: - Introduction - Quick Start - Create an Invite Link - Embed KollaConnect API Basics: - Filtering Unify Dental API Endpoints: Appointments: - List Appointments (GET) - Create Appointment (POST) - Get Appointment (GET) - Update Appointment (PATCH) - Cancel Appointment (POST) - Set Confirmation Status (POST) - Create New Patient Appointment (POST) - List Appointment Types (GET) - List Confirmation Types (GET) Claims: - List Claim Procedures (GET) - Get Claim Procedure (GET) - List Claims (GET) - Get Claim (GET) CommunicationLogs: - List Communication Logs (GET) - Create Communication Log (POST) - Get Communication Log (GET) Contacts: - List Contacts (GET) - Create Contact (POST) - Get Contact (GET) - Update Contact (PATCH) Documents: - List Documents (GET) - Create Document (POST) Insurance: - List Insurance Coverages (GET) - List Insurance Benefits (GET) - Update Insurance Benefits (PUT) - Bulk Update Insurance Benefits (PUT) Meta: - List Document Categories (GET) - List Resources (GET) - Load Schedule (GET) Referrals: - List Referrals (GET) Tasks: - List Tasks (GET) - Create Task (POST) - Get Task (GET) Transactions: - List Custom Types (GET) - List Transactions (GET) - Create Transaction (POST) - Get Transaction (GET) - Update Transaction (PATCH) Treatment: - List Procedures (GET) - Get Procedure (GET) - List Treatment Plans (GET) - Get Treatment Plan (GET) ``` ---------------------------------------- TITLE: Integration Metadata API Endpoints DESCRIPTION: Documentation for Integration Metadata API endpoints, facilitating actions like pinging linked accounts and creating invite links for customer onboarding. SOURCE: https://docs.kolla.dev/reference/quick-start LANGUAGE: APIDOC CODE: ``` Integration Metadata: Ping Linked Account (GET) Create Invite Link (POST) ``` ---------------------------------------- TITLE: API Documentation: Tasks DESCRIPTION: Manages tasks within the system, allowing for listing, creation, and retrieval of individual tasks. SOURCE: https://docs.kolla.dev/reference/core-overview LANGUAGE: APIDOC CODE: ``` List Tasks (GET) Create Task (POST) Get Task (GET) ``` ---------------------------------------- TITLE: Get Procedure API Endpoint DESCRIPTION: This endpoint allows for the retrieval of a single procedure from a treatment plan using its unique identifier. It specifies the HTTP method, URL structure, required authentication, and notes the various programming languages supported for example implementations. SOURCE: https://docs.kolla.dev/reference/treatment_getprocedure LANGUAGE: APIDOC CODE: ``` Endpoint: GET https://unify.kolla.dev/dental/v1/procedures/{procedure} Description: Retrieves one procedure from a treatment plan Parameters: procedure: Path parameter, unique identifier for the procedure. Authentication: Bearer +2 (Token-based authentication) Supported Languages for Examples: Shell, Node, Ruby, PHP, Python Response: Click 'Try It!' to start a request and see the response here! ``` ---------------------------------------- TITLE: Integration Metadata API Endpoint Overview DESCRIPTION: Lists API endpoints related to integration metadata, including pinging linked accounts and creating invite links. SOURCE: https://docs.kolla.dev/reference/appointments_createappointment LANGUAGE: APIDOC CODE: ``` Integration Metadata API: - Ping Linked Account (GET /reference/ping-linked-account) - Create Invite Link (POST /reference/create-invite-link) ``` ---------------------------------------- TITLE: Get Animal API Endpoint Details DESCRIPTION: Detailed documentation for retrieving a single animal resource via the Unify Vet API, including the HTTP method, URL structure, a brief description of its purpose, authentication requirements, and supported languages for example code. SOURCE: https://docs.kolla.dev/reference/animals_getanimal LANGUAGE: APIDOC CODE: ``` Endpoint: Get Animal Method: GET URL: https://unify.kolla.dev/vet/v1/animals/{animal} Description: Retrieves one animal. Authentication: Bearer +2 Supported Code Examples: Shell, Node, Ruby, PHP, Python ``` ---------------------------------------- TITLE: Kolla API Endpoint Reference DESCRIPTION: A structured list of all available API endpoints within the Kolla platform, categorized by resource type. Each entry specifies the operation (e.g., List, Create, Get, Update, Cancel) and the associated HTTP method (GET, POST, PATCH, PUT). SOURCE: https://docs.kolla.dev/reference/appointments_createappointment-3 LANGUAGE: APIDOC CODE: ``` API Reference: Getting Started: - Introduction - Quick Start - Create an Invite Link - Embed KollaConnect API Basics: - Filtering Unify Dental: Appointments: - List Appointments (GET) - Create Appointment (POST) - Get Appointment (GET) - Update Appointment (PATCH) - Cancel appointment (POST) - Set Confirmation Status (POST) - Create New Patient Appointment (POST) - List Appointment Types (GET) - List Confirmation Types (GET) Claims: - List Claimprocedures (GET) - Get Claimprocedure (GET) - List Claims (GET) - Get Claim (GET) CommunicationLogs: - List Communication Logs (GET) - Create Communication Log (POST) - Get Communication Log (GET) Contacts: - List Contacts (GET) - Create Contact (POST) - Get Contact (GET) - Update Contact (PATCH) Documents: - List Documents (GET) - Create Document (POST) Insurance: - List Insurance Coverages (GET) - List Insurance Benefits (GET) - Update Insurance Benefits (PUT) - Bulk Update Insurance Benefits (PUT) Meta: - List Document Categories (GET) - List Resources (GET) - Load Schedule (GET) Referrals: - List Referrals (GET) Tasks: - List Tasks (GET) - Create Task (POST) - Get Task (GET) Transactions: - List Custom Types (GET) - List Transactions (GET) - Create Transaction (POST) - Get Transaction (GET) - Update Transaction (PATCH) Treatment: - List Procedures (GET) - Get Procedure (GET) - List TreatmentPlans (GET) - Get TreatmentPlan (GET) ``` ---------------------------------------- TITLE: Unify Vet API Endpoints Overview DESCRIPTION: Comprehensive overview of the available API endpoints for the Unify Vet platform, categorized by resource, including their HTTP methods and reference paths. SOURCE: https://docs.kolla.dev/reference/appointments_listappointments LANGUAGE: APIDOC CODE: ``` Animals: - List Animals (GET) /reference/animals_listanimals - Create Animal (POST) /reference/animals_createanimal - Get Animal (GET) /reference/animals_getanimal - Update Animal (PATCH) /reference/animals_updateanimal Appointments: - List appointments (GET) /reference/appointments_listappointments-3 - Create Appointment (POST) /reference/appointments_createappointment-3 - Get Appointment (GET) /reference/appointments_getappointment-3 - Update Appointment (PATCH) /reference/appointments_updateappointment-3 - Cancel appointment (POST) /reference/appointments_cancelappointment-2 - Set Confirmation Status (POST) /reference/appointments_confirmappointment-2 - List Appointment Types (GET) /reference/appointments_listappointmenttypes-1 Clinical: - List Notes (GET) /reference/clinical_listnotes - Create Notes (POST) /reference/clinical_createnotes - Get Notes (GET) /reference/clinical_getnotes - Delete Notes (DELETE) /reference/clinical_deletenotes - Update Notes (PATCH) /reference/clinical_updatenotes - List note categories (GET) /reference/clinical_listnotecategories Contacts: - List Contacts (GET) /reference/contacts_listcontacts-3 - Create Contact (POST) /reference/contacts_createcontact-3 - Get Contact (GET) /reference/contacts_getcontact-3 - Update Contact (PATCH) /reference/contacts_updatecontact-3 Meta: - List Resources (GET) /reference/meta_listresources-1 - Load Schedule (GET) /reference/meta_loadschedule-1 - List Species (GET) /reference/meta_listspecies - List Breeds (GET) /reference/meta_listbreeds Transactions: - List Transactions (GET) /reference/transactions_listtransactions-1 - Get Transaction (GET) /reference/transactions_gettransaction-1 Visits: - List visits (GET) /reference/visits_listvisits - Get Visit (GET) /reference/visits_getvisit ``` ---------------------------------------- TITLE: Get Procedure by ID (GET) DESCRIPTION: Retrieves a specific dental procedure by its unique identifier. This endpoint provides detailed information for a single procedure. SOURCE: https://docs.kolla.dev/reference/insurance_bulkupdateinsurancebenefit LANGUAGE: APIDOC CODE: ``` GET /treatment/procedures/{id} ``` ---------------------------------------- TITLE: Integration Metadata API Endpoints Overview DESCRIPTION: Lists available API endpoints for integration metadata operations, including pinging linked accounts and creating invite links. SOURCE: https://docs.kolla.dev/reference/appointments_getappointment-1 LANGUAGE: APIDOC CODE: ``` Integration Metadata: Ping Linked Account (GET) /reference/ping-linked-account Create Invite Link (POST) /reference/create-invite-link ``` ---------------------------------------- TITLE: Kolla Unify Dental API Endpoints Overview DESCRIPTION: This section outlines the available API endpoints for the Kolla Unify Dental platform, categorized by resource. Each entry specifies the operation (e.g., List, Create, Get, Update, Cancel) and the corresponding HTTP method (GET, POST, PATCH, PUT). SOURCE: https://docs.kolla.dev/reference/embed-connect LANGUAGE: APIDOC CODE: ``` API Reference: Kolla Dental Unify API Getting Started: Introduction Quick Start Create an Invite Link Embed KollaConnect API Basics: Filtering Unify Dental API Endpoints: Appointments: List Appointments (GET) Create Appointment (POST) Get Appointment (GET) Update Appointment (PATCH) Cancel Appointment (POST) Set Confirmation Status (POST) Create New Patient Appointment (POST) List Appointment Types (GET) List Confirmation Types (GET) Claims: List Claim Procedures (GET) Get Claim Procedure (GET) List Claims (GET) Get Claim (GET) CommunicationLogs: List Communication Logs (GET) Create Communication Log (POST) Get Communication Log (GET) Contacts: List Contacts (GET) Create Contact (POST) Get Contact (GET) Update Contact (PATCH) Documents: List Documents (GET) Create Document (POST) Insurance: List Insurance Coverages (GET) List Insurance Benefits (GET) Update Insurance Benefits (PUT) Bulk Update Insurance Benefits (PUT) Meta: List Document Categories (GET) List Resources (GET) Load Schedule (GET) Referrals: List Referrals (GET) Tasks: List Tasks (GET) Create Task (POST) Get Task (GET) Transactions: List Custom Types (GET) List Transactions (GET) Create Transaction (POST) Get Transaction (GET) Update Transaction (PATCH) Treatment: List Procedures (GET) Get Procedure (GET) List Treatment Plans (GET) Get Treatment Plan (GET) ``` ---------------------------------------- TITLE: Kolla Unify Dental API Endpoints Overview DESCRIPTION: A structured overview of the Kolla Unify Dental API, listing all major resource categories and their associated HTTP methods (GET, POST, PATCH, PUT) for various operations like listing, creating, updating, and retrieving data. SOURCE: https://docs.kolla.dev/reference/appointments_listappointments-3 LANGUAGE: APIDOC CODE: ``` API Reference: Kolla Unify Dental Services Getting Started: - Introduction - Quick Start - Create an Invite Link - Embed KollaConnect API Basics: - Filtering Unify Dental API Endpoints: Appointments: - List Appointments (GET) - Create Appointment (POST) - Get Appointment (GET) - Update Appointment (PATCH) - Cancel appointment (POST) - Set Confirmation Status (POST) - Create New Patient Appointment (POST) - List Appointment Types (GET) - List Confirmation Types (GET) Claims: - List Claimprocedures (GET) - Get Claimprocedure (GET) - List Claims (GET) - Get Claim (GET) CommunicationLogs: - List Communication Logs (GET) - Create Communication Log (POST) - Get Communication Log (GET) Contacts: - List Contacts (GET) - Create Contact (POST) - Get Contact (GET) - Update Contact (PATCH) Documents: - List Documents (GET) - Create Document (POST) Insurance: - List Insurance Coverages (GET) - List Insurance Benefits (GET) - Update Insurance Benefits (PUT) - Bulk Update Insurance Benefits (PUT) Meta: - List Document Categories (GET) - List Resources (GET) - Load Schedule (GET) Referrals: - List Referrals (GET) Tasks: - List Tasks (GET) - Create Task (POST) - Get Task (GET) Transactions: - List Custom Types (GET) - List Transactions (GET) - Create Transaction (POST) - Get Transaction (GET) - Update Transaction (PATCH) Treatment: - List Procedures (GET) - Get Procedure (GET) - List TreatmentPlans (GET) - Get TreatmentPlan (GET) ``` ---------------------------------------- TITLE: Get Transaction by ID (GET) DESCRIPTION: Retrieves a specific transaction by its unique identifier. This endpoint provides detailed information for a single transaction record. SOURCE: https://docs.kolla.dev/reference/insurance_bulkupdateinsurancebenefit LANGUAGE: APIDOC CODE: ``` GET /transactions/{id} ``` ---------------------------------------- TITLE: Integration Metadata API Endpoints Overview DESCRIPTION: Overview of API endpoints related to integration metadata, such as pinging linked accounts and creating invite links. SOURCE: https://docs.kolla.dev/reference/meta_loadschedule LANGUAGE: APIDOC CODE: ``` Integration Metadata API: Ping Linked Account (GET /reference/ping-linked-account) Create Invite Link (POST /reference/create-invite-link) ``` ---------------------------------------- TITLE: Get Task by ID (GET) DESCRIPTION: Retrieves a specific task by its unique identifier. This endpoint provides detailed information for a single task record. SOURCE: https://docs.kolla.dev/reference/insurance_bulkupdateinsurancebenefit LANGUAGE: APIDOC CODE: ``` GET /tasks/{id} ``` ---------------------------------------- TITLE: Integration Metadata API Endpoints Overview DESCRIPTION: Provides an overview of the API endpoints for managing integration metadata, including pinging linked accounts and creating invite links. SOURCE: https://docs.kolla.dev/reference/create-invite-link LANGUAGE: APIDOC CODE: ``` Integration Metadata API: Ping Linked Account: GET /reference/ping-linked-account Create Invite Link: POST /reference/create-invite-link ``` ---------------------------------------- TITLE: Unify Core API Endpoints Overview DESCRIPTION: This section details the API endpoints available for the Unify Core service. It includes operations for managing appointments and contacts, providing methods for listing, creating, getting, and updating these resources. SOURCE: https://docs.kolla.dev/reference/appointments_getappointment LANGUAGE: APIDOC CODE: ``` Overview: /reference/core-overview Appointments: List appointments (GET) /reference/appointments_listappointments-1 Create Appointment (POST) /reference/appointments_createappointment-1 Get Appointment (GET) /reference/appointments_getappointment-1 Update Appointment (PATCH) /reference/appointments_updateappointment-1 Contacts: List Contacts (GET) /reference/contacts_listcontacts-1 Create Contact (POST) /reference/contacts_createcontact-1 Get Contact (GET) /reference/contacts_getcontact-1 Update Contact (PATCH) /reference/contacts_updatecontact-1 ``` ---------------------------------------- TITLE: Unify Core API Endpoints Overview DESCRIPTION: This section provides an overview of the API endpoints available for the Unify Core platform. It details operations related to Appointments and Contacts within the core business system. SOURCE: https://docs.kolla.dev/reference/appointments_createappointment-1 LANGUAGE: APIDOC CODE: ``` Overview: /reference/core-overview Appointments: List appointments (GET /reference/appointments_listappointments-1) Create Appointment (POST /reference/appointments_createappointment-1) Get Appointment (GET /reference/appointments_getappointment-1) Update Appointment (PATCH /reference/appointments_updateappointment-1) Contacts: List Contacts (GET /reference/contacts_listcontacts-1) Create Contact (POST /reference/contacts_createcontact-1) Get Contact (GET /reference/contacts_getcontact-1) Update Contact (PATCH /reference/contacts_updatecontact-1) ``` ---------------------------------------- TITLE: Get Contact by ID (GET) DESCRIPTION: Retrieves a specific contact by its unique identifier. This endpoint provides detailed information for a single contact record. SOURCE: https://docs.kolla.dev/reference/insurance_bulkupdateinsurancebenefit LANGUAGE: APIDOC CODE: ``` GET /contacts/{id} ``` ---------------------------------------- TITLE: Get Claim by ID (GET) DESCRIPTION: Retrieves a specific claim by its unique identifier. This endpoint provides detailed information for a single claim record. SOURCE: https://docs.kolla.dev/reference/insurance_bulkupdateinsurancebenefit LANGUAGE: APIDOC CODE: ``` GET /claims/{id} ``` ---------------------------------------- TITLE: Unify Core API Endpoints Overview DESCRIPTION: Provides an overview of the API endpoints available for the Unify Core service, covering general overview, appointments, and contacts. SOURCE: https://docs.kolla.dev/reference/create-invite-link LANGUAGE: APIDOC CODE: ``` Unify Core API: Overview: /reference/core-overview Appointments: List appointments: GET /reference/appointments_listappointments-1 Create Appointment: POST /reference/appointments_createappointment-1 Get Appointment: GET /reference/appointments_getappointment-1 Update Appointment: PATCH /reference/appointments_updateappointment-1 Contacts: List Contacts: GET /reference/contacts_listcontacts-1 Create Contact: POST /reference/contacts_createcontact-1 Get Contact: GET /reference/contacts_getcontact-1 Update Contact: PATCH /reference/contacts_updatecontact-1 ``` ---------------------------------------- TITLE: Unify Core API Endpoints Overview DESCRIPTION: Overview of the available API endpoints for the Unify Core platform, categorized by resource, including their HTTP methods and reference paths. SOURCE: https://docs.kolla.dev/reference/appointments_listappointments LANGUAGE: APIDOC CODE: ``` Appointments: - List appointments (GET) /reference/appointments_listappointments-1 - Create Appointment (POST) /reference/appointments_createappointment-1 - Get Appointment (GET) /reference/appointments_getappointment-1 - Update Appointment (PATCH) /reference/appointments_updateappointment-1 Contacts: - List Contacts (GET) /reference/contacts_listcontacts-1 - Create Contact (POST) /reference/contacts_createcontact-1 - Get Contact (GET) /reference/contacts_getcontact-1 - Update Contact (PATCH) /reference/contacts_updatecontact-1 ``` ---------------------------------------- TITLE: Get Appointment by ID (GET) DESCRIPTION: Retrieves a specific appointment by its unique identifier. This endpoint provides detailed information for a single appointment record. SOURCE: https://docs.kolla.dev/reference/insurance_bulkupdateinsurancebenefit LANGUAGE: APIDOC CODE: ``` GET /appointments/{id} ``` ---------------------------------------- TITLE: Get Contact API Endpoint Details (Unify Dental) DESCRIPTION: Detailed documentation for the GET /dental/v1/contacts/{contact} endpoint, including its purpose, full URL, and authentication requirements. SOURCE: https://docs.kolla.dev/reference/contacts_getcontact LANGUAGE: APIDOC CODE: ``` Endpoint: GET https://unify.kolla.dev/dental/v1/contacts/{contact} Description: Retrieves one contact Authentication: Bearer +2 Supported Example Languages: Shell, Node, Ruby, PHP, Python ``` ---------------------------------------- TITLE: Unify Vet API Endpoints Overview DESCRIPTION: Comprehensive list of API endpoints available under the Unify Vet service, categorized by resource. SOURCE: https://docs.kolla.dev/reference/appointments_getappointment-3 LANGUAGE: APIDOC CODE: ``` Unify Vet API: Animals: - List Animals (GET /reference/animals_listanimals) - Create Animal (POST /reference/animals_createanimal) - Get Animal (GET /reference/animals_getanimal) - Update Animal (PATCH /reference/animals_updateanimal) Appointments: - List appointments (GET /reference/appointments_listappointments-3) - Create Appointment (POST /reference/appointments_createappointment-3) - Get Appointment (GET /reference/appointments_getappointment-3) - Update Appointment (PATCH /reference/appointments_updateappointment-3) - Cancel appointment (POST /reference/appointments_cancelappointment-2) - Set Confirmation Status (POST /reference/appointments_confirmappointment-2) - List Appointment Types (GET /reference/appointments_listappointmenttypes-1) Clinical: - List Notes (GET /reference/clinical_listnotes) - Create Notes (POST /reference/clinical_createnotes) - Get Notes (GET /reference/clinical_getnotes) - Delete Notes (DELETE /reference/clinical_deletenotes) - Update Notes (PATCH /reference/clinical_updatenotes) - List note categories (GET /reference/clinical_listnotecategories) Contacts: - List Contacts (GET /reference/contacts_listcontacts-3) - Create Contact (POST /reference/contacts_createcontact-3) - Get Contact (GET /reference/contacts_getcontact-3) - Update Contact (PATCH /reference/contacts_updatecontact-3) Meta: - List Resources (GET /reference/meta_listresources-1) - Load Schedule (GET /reference/meta_loadschedule-1) - List Species (GET /reference/meta_listspecies) - List Breeds (GET /reference/meta_listbreeds) Transactions: - List Transactions (GET /reference/transactions_listtransactions-1) - Get Transaction (GET /reference/transactions_gettransaction-1) Visits: - List visits (GET /reference/visits_listvisits) - Get Visit (GET /reference/visits_getvisit) ``` ---------------------------------------- TITLE: Kolla API Endpoints Overview DESCRIPTION: This section provides a structured overview of the Kolla API's available resources and their respective methods. It serves as an index to the API's capabilities, detailing how to interact with different data entities like appointments, claims, and contacts within the Unify Dental context. SOURCE: https://docs.kolla.dev/reference/appointments_getappointment-1 LANGUAGE: APIDOC CODE: ``` API Resources: Appointments: - List Appointments (GET) - Create Appointment (POST) - Get Appointment (GET) - Update Appointment (PATCH) - Cancel appointment (POST) - Set Confirmation Status (POST) - Create New Patient Appointment (POST) - List Appointment Types (GET) - List Confirmation Types (GET) Claims: - List Claimprocedures (GET) - Get Claimprocedure (GET) - List Claims (GET) - Get Claim (GET) CommunicationLogs: - List Communication Logs (GET) - Create Communication Log (POST) - Get Communication Log (GET) Contacts: - List Contacts (GET) - Create Contact (POST) - Get Contact (GET) - Update Contact (PATCH) Documents: - List Documents (GET) - Create Document (POST) Insurance: - List Insurance Coverages (GET) - List Insurance Benefits (GET) - Update Insurance Benefits (PUT) - Bulk Update Insurance Benefits (PUT) Meta: - List Document Categories (GET) - List Resources (GET) - Load Schedule (GET) Referrals: - List Referrals (GET) Tasks: - List Tasks (GET) - Create Task (POST) - Get Task (GET) Transactions: - List Custom Types (GET) - List Transactions (GET) - Create Transaction (POST) - Get Transaction (GET) - Update Transaction (PATCH) Treatment: - List Procedures (GET) - Get Procedure (GET) - List TreatmentPlans (GET) - Get TreatmentPlan (GET) ``` ---------------------------------------- TITLE: List Resources GET Endpoint DESCRIPTION: Documents the GET endpoint for retrieving a list of resources from the Unify Vet API. It specifies the HTTP method, full URL, and required credentials for authentication. SOURCE: https://docs.kolla.dev/reference/meta_listresources-1 LANGUAGE: APIDOC CODE: ``` GET /vet/v1/resources Host: unify.kolla.dev Description: Returns a list of resources Credentials: Bearer +2 ``` ---------------------------------------- TITLE: Get Treatment Plan by ID (GET) DESCRIPTION: Retrieves a specific treatment plan by its unique identifier. This endpoint provides detailed information for a single treatment plan. SOURCE: https://docs.kolla.dev/reference/insurance_bulkupdateinsurancebenefit LANGUAGE: APIDOC CODE: ``` GET /treatment/plans/{id} ``` ---------------------------------------- TITLE: Unify Core API Endpoints Overview DESCRIPTION: Comprehensive list of API endpoints available under the Unify Core service, categorized by resource. SOURCE: https://docs.kolla.dev/reference/appointments_getappointment-3 LANGUAGE: APIDOC CODE: ``` Unify Core API: Overview: /reference/core-overview Appointments: - List appointments (GET /reference/appointments_listappointments-1) - Create Appointment (POST /reference/appointments_createappointment-1) - Get Appointment (GET /reference/appointments_getappointment-1) - Update Appointment (PATCH /reference/appointments_updateappointment-1) Contacts: - List Contacts (GET /reference/contacts_listcontacts-1) - Create Contact (POST /reference/contacts_createcontact-1) - Get Contact (GET /reference/contacts_getcontact-1) - Update Contact (PATCH /reference/contacts_updatecontact-1) ``` ---------------------------------------- TITLE: Get Communication Log by ID (GET) DESCRIPTION: Retrieves a specific communication log entry by its unique identifier. This endpoint provides detailed information for a single log record. SOURCE: https://docs.kolla.dev/reference/insurance_bulkupdateinsurancebenefit LANGUAGE: APIDOC CODE: ``` GET /communicationlogs/{id} ``` ---------------------------------------- TITLE: Unify Core API Endpoints Overview DESCRIPTION: Overview of core API endpoints for the Unify system, including general overview, appointments, and contacts management. SOURCE: https://docs.kolla.dev/reference/claims_getclaim LANGUAGE: APIDOC CODE: ``` Overview: /reference/core-overview Appointments: - List appointments (GET) /reference/appointments_listappointments-1 - Create Appointment (POST) /reference/appointments_createappointment-1 - Get Appointment (GET) /reference/appointments_getappointment-1 - Update Appointment (PATCH) /reference/appointments_updateappointment-1 Contacts: - List Contacts (GET) /reference/contacts_listcontacts-1 - Create Contact (POST) /reference/contacts_createcontact-1 - Get Contact (GET) /reference/contacts_getcontact-1 - Update Contact (PATCH) /reference/contacts_updatecontact-1 ``` ---------------------------------------- TITLE: Get Claim Procedure by ID (GET) DESCRIPTION: Retrieves a specific claim procedure by its unique identifier. This endpoint provides detailed information for a single procedure within a claim. SOURCE: https://docs.kolla.dev/reference/insurance_bulkupdateinsurancebenefit LANGUAGE: APIDOC CODE: ``` GET /claims/procedures/{id} ``` ---------------------------------------- TITLE: List Treatment Plans (GET) DESCRIPTION: Retrieves a list of all treatment plans. This endpoint allows users to query and view existing patient treatment plans. SOURCE: https://docs.kolla.dev/reference/insurance_bulkupdateinsurancebenefit LANGUAGE: APIDOC CODE: ``` GET /treatment/plans ``` ---------------------------------------- TITLE: Unify Vet and Core API Endpoint Reference DESCRIPTION: Overview of the Unify Vet and Unify Core API endpoints, categorized by module, including HTTP methods and associated reference links. SOURCE: https://docs.kolla.dev/reference/claims_getclaimprocedure LANGUAGE: APIDOC CODE: ``` Unify Vet: Animals: List Animals (GET /reference/animals_listanimals) Create Animal (POST /reference/animals_createanimal) Get Animal (GET /reference/animals_getanimal) Update Animal (PATCH /reference/animals_updateanimal) Appointments: List appointments (GET /reference/appointments_listappointments-3) Create Appointment (POST /reference/appointments_createappointment-3) Get Appointment (GET /reference/appointments_getappointment-3) Update Appointment (PATCH /reference/appointments_updateappointment-3) Cancel appointment (POST /reference/appointments_cancelappointment-2) Set Confirmation Status (POST /reference/appointments_confirmappointment-2) List Appointment Types (GET /reference/appointments_listappointmenttypes-1) Clinical: List Notes (GET /reference/clinical_listnotes) Create Notes (POST /reference/clinical_createnotes) Get Notes (GET /reference/clinical_getnotes) Delete Notes (DELETE /reference/clinical_deletenotes) Update Notes (PATCH /reference/clinical_updatenotes) List note categories (GET /reference/clinical_listnotecategories) Contacts: List Contacts (GET /reference/contacts_listcontacts-3) Create Contact (POST /reference/contacts_createcontact-3) Get Contact (GET /reference/contacts_getcontact-3) Update Contact (PATCH /reference/contacts_updatecontact-3) Meta: List Resources (GET /reference/meta_listresources-1) Load Schedule (GET /reference/meta_loadschedule-1) List Species (GET /reference/meta_listspecies) List Breeds (GET /reference/meta_listbreeds) Transactions: List Transactions (GET /reference/transactions_listtransactions-1) Get Transaction (GET /reference/transactions_gettransaction-1) Visits: List visits (GET /reference/visits_listvisits) Get Visit (GET /reference/visits_getvisit) Unify Core: Overview (GET /reference/core-overview) Appointments: List appointments (GET /reference/appointments_listappointments-1) Create Appointment (POST /reference/appointments_createappointment-1) Get Appointment (GET /reference/appointments_getappointment-1) Update Appointment (PATCH /reference/appointments_updateappointment-1) Contacts: List Contacts (GET /reference/contacts_listcontacts-1) Create Contact (POST /reference/contacts_createcontact-1) Get Contact (GET /reference/contacts_getcontact-1) Update Contact (PATCH /reference/contacts_updatecontact-1) Integration Metadata: Ping Linked Account (GET /reference/ping-linked-account) Create Invite Link (POST /reference/create-invite-link) ``` ---------------------------------------- TITLE: Get Transaction API Endpoint Details DESCRIPTION: Detailed specification for the 'Get Transaction' API endpoint, which retrieves a single transaction. It includes the HTTP method, URL, supported client languages, and authentication requirements. SOURCE: https://docs.kolla.dev/reference/transactions_gettransaction LANGUAGE: APIDOC CODE: ``` Get Transaction: Method: GET URL: https://unify.kolla.dev/dental/v1/transactions/{transaction} Description: Retrieves one transaction Supported Languages: Shell, Node, Ruby, PHP, Python Credentials: Bearer +2 Response: Click `Try It!` to start a request and see the response here! ``` ---------------------------------------- TITLE: Kolla Unify Dental API Endpoints Overview DESCRIPTION: This section provides a structured overview of the API endpoints available under the 'Unify Dental' category. It lists various resources and the HTTP methods supported for each, such as GET for listing/retrieving and POST/PUT/PATCH for creating/updating. SOURCE: https://docs.kolla.dev/reference/referrals_listreferrals LANGUAGE: APIDOC CODE: ``` Unify Dental API Endpoints: Appointments: - List Appointments (GET) - Create Appointment (POST) - Get Appointment (GET) - Update Appointment (PATCH) - Cancel appointment (POST) - Set Confirmation Status (POST) - Create New Patient Appointment (POST) - List Appointment Types (GET) - List Confirmation Types (GET) Claims: - List Claimprocedures (GET) - Get Claimprocedure (GET) - List Claims (GET) - Get Claim (GET) CommunicationLogs: - List Communication Logs (GET) - Create Communication Log (POST) - Get Communication Log (GET) Contacts: - List Contacts (GET) - Create Contact (POST) - Get Contact (GET) - Update Contact (PATCH) Documents: - List Documents (GET) - Create Document (POST) Insurance: - List Insurance Coverages (GET) - List Insurance Benefits (GET) - Update Insurance Benefits (PUT) - Bulk Update Insurance Benefits (PUT) Meta: - List Document Categories (GET) - List Resources (GET) - Load Schedule (GET) Referrals: - List Referrals (GET) Tasks: - List Tasks (GET) - Create Task (POST) - Get Task (GET) Transactions: - List Custom Types (GET) - List Transactions (GET) - Create Transaction (POST) - Get Transaction (GET) - Update Transaction (PATCH) Treatment: - List Procedures (GET) - Get Procedure (GET) - List Treatment Plans (GET) - Get Treatment Plan (GET) ``` ---------------------------------------- TITLE: Unify Vet API Endpoints Overview DESCRIPTION: This section provides a hierarchical list of all available API endpoints under the Unify Vet service. It covers operations related to animals, appointments, clinical notes, contacts, meta-data, transactions, and visits, including methods like GET, POST, PATCH, and DELETE. SOURCE: https://docs.kolla.dev/reference/appointments_getappointment LANGUAGE: APIDOC CODE: ``` Animals: List Animals (GET) /reference/animals_listanimals Create Animal (POST) /reference/animals_createanimal Get Animal (GET) /reference/animals_getanimal Update Animal (PATCH) /reference/animals_updateanimal Appointments: List appointments (GET) /reference/appointments_listappointments-3 Create Appointment (POST) /reference/appointments_createappointment-3 Get Appointment (GET) /reference/appointments_getappointment-3 Update Appointment (PATCH) /reference/appointments_updateappointment-3 Cancel appointment (POST) /reference/appointments_cancelappointment-2 Set Confirmation Status (POST) /reference/appointments_confirmappointment-2 List Appointment Types (GET) /reference/appointments_listappointmenttypes-1 Clinical: List Notes (GET) /reference/clinical_listnotes Create Notes (POST) /reference/clinical_createnotes Get Notes (GET) /reference/clinical_getnotes Delete Notes (DELETE) /reference/clinical_deletenotes Update Notes (PATCH) /reference/clinical_updatenotes List note categories (GET) /reference/clinical_listnotecategories Contacts: List Contacts (GET) /reference/contacts_listcontacts-3 Create Contact (POST) /reference/contacts_createcontact-3 Get Contact (GET) /reference/contacts_getcontact-3 Update Contact (PATCH) /reference/contacts_updatecontact-3 Meta: List Resources (GET) /reference/meta_listresources-1 Load Schedule (GET) /reference/meta_loadschedule-1 List Species (GET) /reference/meta_listspecies List Breeds (GET) /reference/meta_listbreeds Transactions: List Transactions (GET) /reference/transactions_listtransactions-1 Get Transaction (GET) /reference/transactions_gettransaction-1 Visits: List visits (GET) /reference/visits_listvisits Get Visit (GET) /reference/visits_getvisit ```