Skip to main content

How to get appointments in myKaarma

This document is designed to help you understand how you can get appointments made in the myKaarma system. Let's get started.

How to get all appointments create/update events in myKaarma

The most efficient and our recommended approach would be webhooks. This would make sure that you get real time updates of all events related to appointments in mykaarma.

To catch up on the appointments that have already been made, contact apisupport@mykaarma.com.

For detailed documentation on how to enable webhooks for your integration please refer to this page.

If for some reason, webhooks subscription doesn't work for you and you would like to use our APIs, though we think you should still be using webhooks :), please check if you want to get appointments by:

Get appointments by UUID​

If you already have the UUID (unique identifier of the appointment in myKaarma), please go through this page on how to get appointment by UUID.

Get appointments by customer​

Need to find appointments for a particular customer? Please go through this page on how to get appointments by customer. Please note this would require you to first fetch UUID of the customer - details on the linked page.

Get appointments by appointment date​

If your use case requires you to search appointments by appointment date. Please go through this page on how to get appointments by appointment date.

Get appointment for a particular repair order​

If you want to find an appointment linked to a particular repair order, please go through this page on how to get appointment for a particular repair order. Please note this would require you to first UUID of the repair order - details on the linked page.

Get appointments by filter​

If none of the above cases fit your use case, then you can try using the get appointments by filter method desribed in detail on this page. This will help you fetch appointments by

  • Appointment keys (Keys or identifiers of appointments in DMS).
  • Created date (Date when appointment was created)
  • Appointment date (For a range of dates when appointment is scheduled)
  • Customers (Filter using UUIDs of customer)
  • Appointments assigned to particular teams (Filter using UUIDs of teams)
  • Created by (Check what appointments were created by dealer app or web scheduler or API)

Note this is a paginated endpoint with recommended limit of no more than 100 page size. We would advise to use this only if your use case is not satisfied by any of the other methods to get appointments.

The response of all the APIs to get appointments are similar.

Appointment data model​

Please refer to appointment data model to see all the parameters you will get when you get appointments from myKaarma APIs or events.