How to get task types for a dealer

This endpoint allows you to retrieve all task types configured for a specific dealer.

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

GET  https://api.mykaarma.com/leads/followup/dealer/{dealerUUID}/task-types/list

Parameters

Required path parameters:

Parameter Name	Value	Description
dealerUUID	string	Unique identifier for the dealer for which the follow up task types need to be retrieved

Authorization

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

Sample Request

curl --location --request GET 'https://api.mykaarma.com/leads/followup/dealer/{dealerUUID}/task-types/list' \
--header 'accept: application/json' \
--header 'authorization: <your-credentials>' \
--header 'Content-Type: application/json'

Response

{
    "statusCode": 200,
    "error": null,
    "warnings": null,
    "taskTypeList": [
        {
            "uuid": "task-type-uuid-1",
            "dealerUuid": "dealer-uuid",
            "taskName": "Declined Service",
            "taskDisplayName": "Declined Service",
            "taskDescription": "Follow up for declined service recommendations"
        },
        {
            "uuid": "task-type-uuid-2",
            "dealerUuid": "dealer-uuid",
            "taskName": "No Show",
            "taskDisplayName": "No Show",
            "taskDescription": "Follow up for missed appointments"
        }
    ]
}

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
taskTypeList	array	List of task type objects

Task Type Object Fields

Field	Type	Description
uuid	string	Unique identifier of the task type
dealerUuid	string	Unique identifier of the dealer
taskName	string	Name of the task type
taskDisplayName	string	Display name of the task type
taskDescription	string	Description of the task type