How to fetch follow ups for a dealer

This endpoint allows you to retrieve follow-ups for a dealer with pagination and filtering capabilities. You can fetch follow-ups in batches using filters such as task type.

To use this endpoint, you first need your credentials. If you don't already have one, please head over to the Authentication and Authorization page to see how you can request for credentials from us.

Request

HTTP request

POST  https://api.mykaarma.com/leads/followup/dealer/{dealerUUID}/list

Parameters

Required path parameters:

Parameter Name	Value	Description
`dealerUUID`	`string`	Unique identifier for the dealer

Authorization

This request requires authorization. Include your credentials in the authorization header.

Request Body

Property Name	Type	Description
`dealerDepartmentUUID`	`string`	Unique identifier of the dealer's department
`entriesToBeSkipped`	`integer`	Number of entries to skip for pagination (default: 0)
`entriesLimitToBeFetched`	`integer`	Maximum number of entries to fetch (default: 50, max limit)
`filterData`	`object`	(Optional) Filter criteria for follow-ups

Sample Request

curl --location 'https://api.mykaarma.com/leads/followup/dealer/{dealerUUID}/list' \
--header 'accept: application/json' \
--header 'authorization: <your-credentials>' \
--header 'Content-Type: application/json' \
--data '{
    "dealerDepartmentUUID": "1798d108ffb4dc7be6c78754d0794f8c749ff94877e36ebb9547bdb48d378060",
    "entriesToBeSkipped": 0,
    "entriesLimitToBeFetched": 10,
    "filterData": {}
}'

Pagination

If entriesLimitToBeFetched is not provided, a default maximum limit of 50 is applied
Use entriesToBeSkipped and entriesLimitToBeFetched together for pagination
Fetch follow-ups in batches using filters such as task type to send messages efficiently

Response

{
    "statusCode": 200,
    "error": null,
    "warnings": null,
    "followUpsList": [
        {
            "uuid": "follow-up-uuid",
            "dealerUuid": "dealer-uuid",
            "dealerDepartmentUuid": "department-uuid",
            "customerUuid": "customer-uuid",
            "customerFName": "John",
            "customerLName": "Doe",
            "address": null,
            "phoneNumber": {
                "communicationValue": "**********",
                "commType": "TEXT",
                "optOutStatus": "OPTED_IN",
                "timeOfChange": "2024-07-26T20:29:44.000+00:00",
                "canSendOptinRequest": false
            },
            "emailAddress": {
                "communicationValue": "****************",
                "commType": "EMAIL",
                "optOutStatus": null,
                "timeOfChange": null,
                "canSendOptinRequest": null
            },
            "source": {
                "uuid": "task-type-uuid",
                "dealerUuid": "dealer-uuid",
                "taskName": "Declined Service",
                "taskDisplayName": "Declined Service",
                "taskDescription": "Declined Services Task Type"
            },
            "vehicle": {
                "id": 329048323,
                "uuid": "vehicle-uuid",
                "vehicleKey": null,
                "isValid": true,
                "vin": "1GBHK34K07E528181",
                "make": "Chevrolet",
                "model": "Silverado 3500 HD",
                "year": "2007",
                "lastMileage": null
            },
            "dealerOrder": {
                "dealerOrderUuid": "order-uuid",
                "orderNumber": "202405162",
                "orderType": "RO",
                "orderDate": "2024-05-16 08:00:00.0",
                "createdDate": "2024-05-16 01:31:26.0",
                "closeDate": "2024-05-16 01:32:18.0",
                "orderStatus": "C",
                "invoiceURL": "https://payment-files.mykaarma.com/...",
                "daUuid": null,
                "daFName": null,
                "daLName": null
            },
            "assignee": {
                "uuid": "user-uuid",
                "fname": "Chetan",
                "lname": "Rawat"
            },
            "taskName": "Air Conditioner/Heater Recommendation, Fluid Leak Repair Recommendation",
            "lastVisitedDate": null,
            "declineInfo": {
                "dmsID": 9,
                "hasReturned": null,
                "mpiUUID": "mpi-uuid",
                "declines": [
                    {
                        "declinedServiceID": null,
                        "opcode": null,
                        "opcodeDescription": null,
                        "internalName": "Air Conditioner/Heater Recommendation",
                        "internalDescription": "Air Conditioner Refrigerant Recharge and Leak Test",
                        "displayName": "Air Conditioner/Heater Recommendation",
                        "displayDescription": "Air Conditioner Refrigerant Recharge and Leak Test",
                        "type": "DeclinedRecommendation",
                        "source": "SERVICECART",
                        "recommendationUUID": "recommendation-uuid",
                        "amount": 253.0,
                        "status": null
                    }
                ],
                "mpiLink": "scct.mkvwa42.com/p/lsfkjeorijrdes.html"
            },
            "dueDate": "2024-05-30T18:29:59.000+00:00",
            "insertDate": "2024-05-15T18:30:00.000+00:00",
            "textModeCurrentStatus": null,
            "emailModeCurrentStatus": null,
            "textMessageUuid": null,
            "textMessageFollowupStatus": null,
            "emailMessageUuid": "email-message-uuid",
            "emailMessageFollowupStatus": "Complete",
            "callMessageUuid": null,
            "callMessageFollowupStatus": null,
            "followedUpStatus": "Complete",
            "isValid": true,
            "appointments": null,
            "noShowAppointmentInfo": null
        }
    ]
}

Response Fields

Field	Type	Description
`statusCode`	`integer`	HTTP status code (200 for success)
`error`	`object`	Error details if the request failed
`warnings`	`array`	Warning messages if any
`followUpsList`	`array`	List of follow-up objects

Follow-up Object Key Fields

Field	Type	Description
`uuid`	`string`	Unique identifier of the follow-up task
`dealerUuid`	`string`	Unique identifier of the dealer
`dealerDepartmentUuid`	`string`	Unique identifier of the dealer's department
`customerUuid`	`string`	Unique identifier of the customer for whom the task belongs
`customerFName`	`string`	Customer's first name
`customerLName`	`string`	Customer's last name
`phoneNumber`	`object`	Customer's primary cell details
`emailAddress`	`object`	Customer's primary email details
`source`	`object`	The task type information (e.g., Declined Services, No Show)
`vehicle`	`object`	Vehicle details
`dealerOrder`	`object`	Details of the dealer order if the task is generated from it (present in the case of declined services)
`assignee`	`object`	Details of the user the task is assigned to
`taskName`	`string`	Task name
`declineInfo`	`object`	Details of the recommendations that are declined by the customer in the MPI
`dueDate`	`string`	Due date of the task (in UTC)
`insertDate`	`string`	Insert date of the task (in UTC)
`textMessageFollowupStatus`	`string`	Status if the follow-up is completed through text
`emailMessageFollowupStatus`	`string`	Status if the follow-up is completed through email
`callMessageFollowupStatus`	`string`	Status if the follow-up is completed through call
`followedUpStatus`	`string`	Status if the follow-up is completed through any of the modes
`appointments`	`array`	List of appointments scheduled for the customer
`noShowAppointmentInfo`	`object`	Information of the appointment through which the no show follow-up was created (only in the case of no show or missed appointment)

Request​

HTTP request​

Parameters​

Authorization​

Request Body​

Sample Request​

Response​

Response Fields​

Follow-up Object Key Fields​