Get List of Task Types

Returns the list of Task Types configured in your LeadSquared account.

Note:

  • The Task Type Id is present in the response body, and is listed againstId.
  • You can pass aColumnNameattribute in the query string. This is an optional parameter. Possible values include TaskTypeId, TaskTypeName, and Category.
  • You can pass aColumnValueattribute in the query string. This is an optional parameter.
    • For the TaskTypeId, pass the task type Id value.
    • For the TaskTypeName, pass the name of the task type. To get the list of task type names, see Get List of Task Types Names.
    • For the Category, pass ‘0’ to retrieve appointments, and ‘1’ to retrieve to-dos.

API URL

GET
https://api-in21.leadsquared.com/v2/Task.svc/RetrieveTaskType?accessKey=AccessKey&secretKey=SecretKey
Copy URL

Response

200 OK

Content-Type: application/json

[
   {
      "Category":0,
      "Color":"#F8BBD0",
      "ColumnConfiguration":[
         {
            "DataType":8,
            "DisplayName":"Owner",
            "InternalSchemaName":"OwnerId",
            "IsDefault":true,
            "IsMandatoryConfigurable":false,
            "Mandatory":true,
            "Options":null,
            "RenderType":0,
            "SchemaName":"OwnerId"
         },
         {
            "DataType":8,
            "DisplayName":"Associated Lead",
            "InternalSchemaName":"RelatedEntityId",
            "IsDefault":true,
            "IsMandatoryConfigurable":true,
            "Mandatory":false,
            "Options":null,
            "RenderType":0,
            "SchemaName":"RelatedEntityId"
         },
         {
            "DataType":0,
            "DisplayName":"Subject",
            "InternalSchemaName":"Name",
            "IsDefault":true,
            "IsMandatoryConfigurable":false,
            "Mandatory":true,
            "Options":null,
            "RenderType":0,
            "SchemaName":"Name"
         },
         {
            "DataType":0,
            "DisplayName":"Custom 1",
            "InternalSchemaName":"mx_Custom_1",
            "IsDefault":false,
            "IsMandatoryConfigurable":true,
            "Mandatory":false,
            "Options":null,
            "RenderType":0,
            "SchemaName":"mx_Custom_1"
         }
      ],
      "CreatedBy":"System",
      "CreatedOn":"/Date(1502992091000+0000)/",
      "FormLayout":"{\"Sections\":[{\"DisplayName\":\"Task Details\",\"Fields\":[{\"SchemaName\":\"OwnerId\",\"DisplayName\":null,\"Colspan\":2,\"Disabled\":false},{\"SchemaName\":\"RelatedEntityId\",\"DisplayName\":null,\"Colspan\":2,\"Disabled\":false},{\"SchemaName\":\"Name\",\"DisplayName\":null,\"Colspan\":2,\"Disabled\":false},{\"SchemaName\":\"DueDate\",\"DisplayName\":null,\"Colspan\":2,\"Disabled\":false},{\"SchemaName\":\"Reminder\",\"DisplayName\":null,\"Colspan\":2,\"Disabled\":false},{\"SchemaName\":\"Description\",\"DisplayName\":null,\"Colspan\":2,\"Disabled\":false},{\"SchemaName\":\"CreatedBy\",\"DisplayName\":null,\"Colspan\":2,\"Disabled\":false}]}],\"AvailableFields\":[{\"SchemaName\":\"Location\",\"DisplayName\":null,\"Colspan\":1,\"Disabled\":true},{\"SchemaName\":\"Priority\",\"DisplayName\":null,\"Colspan\":1,\"Disabled\":false},{\"SchemaName\":\"EffortEstimate\",\"DisplayName\":null,\"Colspan\":1,\"Disabled\":true},{\"SchemaName\":\"PercentCompleted\",\"DisplayName\":null,\"Colspan\":1,\"Disabled\":true},{\"SchemaName\":\"mx_Custom_1\",\"DisplayName\":null,\"Colspan\":1,\"Disabled\":false}]}",
      "Id":"3c8c1673-8374-11e7-ab78-02de49b06427",
      "IsDefault":true,
      "IsDeleteable":true,
      "IsEditable":true,
      "ModifiedBy":"Vir Singh",
      "ModifiedOn":"/Date(1568597681000+0000)/",
      "Name":"Follow-Up",
      "OpenCompletedTasks":true,
      "PreventConflict":true,
      "ReminderConfiguration":{
         "IsEnable":false
      },
      "Sequence":1,
      "ShowLeadCalendarInvite":null,
      "ShowOrganiserCalendarInvite":null,
      "ShowOwnerCalendarInvite":null,
      "ShowParticipantCalendarInvite":null,
      "Status":1,
      "TaskTypeConfiguration":{
         "BusinessWorkFlow":{
            "IsEnabled":false,
            "Status":{
               "Label":null,
               "Values":[
                  
               ]
            }
         },
         "CalenderInvite":{
            "Lead":{
               "IsEnabled":false,
               "IsSent":null,
               "Subject":null,
               "TemplateContent":"Hi, 

Please find the attached calendar invitation.

@{TaskOrganiser:Signature ,} 
" }, "Organiser":{ "IsEnabled":false, "IsSent":null, "Subject":null, "TemplateContent":"Hi, 

Please find the attached calendar invitation.

@{TaskOrganiser:Signature ,} 
" }, "Owner":{ "IsEnabled":false, "IsSent":null, "Subject":null, "TemplateContent":"Hi, 

Please find the attached calendar invitation.

@{TaskOrganiser:Signature ,} 
" }, "ParticipantUsers":{ "IsEnabled":false, "IsSent":null, "Subject":null, "TemplateContent":null } }, "Duration":{ "IsEnabled":false, "Value":"30", "Values":null }, "EffortEstimate":{ "IsEnabled":false, "Value":null, "ValueUnit":null, "Values":null }, "Location":{ "GeofenceLocation":false, "GeofenceRange":100, "IsEnabled":false, "IsMandatory":false, "LocationValue":null }, "Priority":{ "IsEnabled":false, "Value":null, "Values":null }, "TaskCompleted":{ "IsEnabled":false } } } ]

HTTP Response Code

Code Description
200 OK

This is the status code for successful API call.

401 Unauthorized

The API call was made with invalid access credentials. Check your AccessKey and SecretKey.

400 Bad Request

The message body on the request is not as per API specification. Make sure that content type is set to “application/json” and the JSON body has correct attribute names and structure.

404 Not Found

The API could not be found. Please check the API signature.

429 Too Many Requests

API calls exceeded the limit of 25 in 5 second(s)

500 Internal Server Error

The API called failed. There could be many reasons for it. Check the exception message to get more details.