How to get appointment by appointment UUID

Use this endpoint to fetch a single appointment by its unique identifier (UUID). Use it when you already have the appointment UUID—for example from a create/update response or from another list endpoint (by date, customer, or order).

You need API credentials to call this endpoint. If you don't have them, see the Authentication and Authorization page to request credentials.

For errors and warnings that this endpoint can return, see Get appointment by UUID — Errors and warnings.

What you need

Parameter	How to get it
departmentUuid	Provided at integration time (dealer department identifier).
appointmentUuid	From a create/update appointment response, or from Get appointments by date, by customer, or by order.

Request

HTTP request

GET https://api.mykaarma.com/appointment/v2/dealerDepartment/{departmentUuid}/uuid/{appointmentUuid}

Path parameters

Parameter	Type	Description	Required
departmentUuid	String	Unique identifier of the dealer department	Yes
appointmentUuid	String	Unique identifier of the appointment in myKaarma	Yes

Authorization

Scope	Level	Description
appointment.get	Department	Authorises client to get appointments for the department

Example

curl -X GET "https://api.mykaarma.com/appointment/v2/dealerDepartment/{{departmentUuid}}/uuid/{{appointmentUuid}}" \
  -H "accept: application/json" \
  -H "Authorization: {{basic_auth_token}}"

Response

Returns a single appointment in the appointmentInfo object, including customer, vehicle, order info, assigned advisor, date/time, transport option, services, and related fields. Top-level error and warnings arrays are present when applicable.

{
  "error": [
    {
      "errorCode": 0,
      "errorDescription": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": 0,
      "warningDescription": "string"
    }
  ],
  "appointmentInfo": {
      "uuid": "string",
      "customerInformation": {
        "firstName": "string",
        "lastName": "string",
        "company": "string",
        "isBusiness": false,
        "customerKey": "string",
        "confirmationPhone": "string",
        "confirmationEmail": "string",
        "custLocale": "string",
        "uuid": "string"
      },
      "vehicleInformation": {
        "vin": "string",
        "vehicleKey": "string",
        "model": "string",
        "year": "string",
        "brand": "string",
        "trim": "string",
        "engine": "string",
        "mileage": "string",
        "dealerUuid": "string",
        "uuid": "string"
      },
      "orderInformation": {
        "uuid": "string",
        "orderNumber": "string",
        "orderDate": "string",
        "orderType": "string"
      },
      "dealerUuid": "string",
      "assignedAdvisorUuid": "string",
      "creatorAdvisorUuid": "string",
      "assignedAdvisorUserUuid": "string",
      "creatorAdvisorUserUuid": "string",
      "assignedAdvisorDmsDepartmentCode": 0,
      "date": "string",
      "preferredDate": "string",
      "startTime": "string",
      "endTime": "string",
      "transportOption": {
        "uuid": "string",
        "altTransportation": "string",
        "bookingId": "string",
        "bookInThirdParty": false,
        "bookingStartDate": "string",
        "bookingEndDate": "string",
        "bookingIsManual": "string",
        "bookingIsValid": "string",
        "loanerSmartLink": "string",
        "transportation": "string",
        "organicTransportation": "string",
        "subTransportOptionUuid": "string"
      },
      "appointmentKey": "string",
      "mileageText": "string",
      "recall": false,
      "platform": "string",
      "appointmentSource": "string",
      "newStatus": "string",
      "comments": "string",
      "internalNotes": "string",
      "isCancelled": false,
      "reminderCount": 0,
      "serviceList": [
        {
          "uuid": "string",
          "opCode": "string",
          "laborOpCode": "string",
          "description": "string",
          "operationType": "string",
          "laborTotal": 0,
          "partsTotal": 0,
          "shopFees": 0,
          "taxes": 0,
          "price": 0,
          "isValid": true,
          "payType": "string",
          "sortOrder": 1,
          "parentOpcodeUuid": "string",
          "menuUuid": "string",
          "recallID": "string",
          "durationInMins": 1,
          "isCustomConcern": false,
          "isDealerAddedLine": false
        }
      ],
      "skillList": [{
        "uuid":"string",
        "name":"string",
        "dealerUuid":"string",
        "departmentUuid":"string",
        "operationList":null,
        "isValid":true
      }],
      "appointmentCommunicationPreferences": {
        "emailConfirmation": true,
        "textConfirmation": false,
        "emailReminder": true,
        "textReminder": false,
        "confirmationEmail": "string",
        "confirmationPhoneNumber": "string",
        "notifyCustomer": true,
        "sendCommunicationToDA": true
      },
      "pdrToOpcodes": {},
      "teamUuid": "string",
      "dispatchCode": "string",
      "customerVehicleInspectionId": "string",
      "sarmetaData": {
        "dmsMetaData":{
            "type":"string",
            "title":"string",
            "description":"string",
            "vehicleUuid":"string",
            "dealerAssociateId":"string"
        },
        "appointmentData": {}
      }
    }
}