LeadSquared Developer Centre

ON THIS PAGE

API
Developer Apps

Get Appointments by Search Criteria

Try it

Retrieves appointments for users by passing search criteria.

The API request uses condition groups similar to the User Advanced Search API.

Pass a “FromDate” and “ToDate” within which you want to retrieve appointments. The difference between the from and to date cannot be more than 100 days.
Pass one or more conditions within the “GroupConditions” parameter to specify which users you want to retrieve appointments for.

The API response returns all appointment details including system and custom fields.

API URL

URL

POST https://{host}/v2/Task.svc/RetrieveAppointments/ByUserSearchCriteria?accessKey=AccessKey&secretKey=SecretKey

Request

Content-Type: application/json

JSON Body/Payload Icon

{
    "FromDate": "2022-04-25",
    "ToDate": "2022-06-25",
    "UserSearchCriteria": {
        "GroupConditions": [
            {
                "GroupConditions": [
                    {
                        "Condition": [
                            {
                                "LookupName": "FirstName",
                                "Operator": "lik_s",
                                "LookupValue": "V",
                                "ConditionOperator": null
                            }
                        ],
                        "GroupOperator": null
                    }
                ],
                "GroupOperator": "AND"
            },
            {
                "Condition": [
                    {
                        "LookupName": "LastName",
                        "Operator": "eq",
                        "LookupValue": "Singh",
                        "ConditionOperator": null
                    }
                ],
                "GroupOperator": null
            }
        ]
    }
}

Request Parameters

Parameter	Description
FromDate	Starting date to retrieve appointments from.
ToDate	End date you want to retrieve appointments till.
UserSearchCriteria	“GroupConditions” – You can create one or more condition groups. You can set multiple conditions inside each condition group. “Condition” – “LookupName” – The user attribute you want to search by (FirstName, LastName etc.) “Operator” – The following operators are permitted –eq – equals neq – not equal to lik – like nlik – not like lik_s – starts with lik_e – ends with n – null nn – not null “LookupValue” – The value of the user attribute you passed in LookupName. “ConditionOperator” – “AND” or “OR”. You can add multiple conditions with a condition group. When you’re adding the next condition, you must specify its relationship with the previous condition here. You must use the same operator between conditions within a group (Condition 1 AND Condition to AND Condition 3 or Condition 1 OR Condition 2 OR Condition 3)

Parameter

Description

FromDate

Starting date to retrieve appointments from.

ToDate

End date you want to retrieve appointments till.

UserSearchCriteria

“GroupConditions” – You can create one or more condition groups. You can set multiple conditions inside each condition group.

“Condition” –

“LookupName” – The user attribute you want to search by (FirstName, LastName etc.)
“Operator” – The following operators are permitted –eq – equals
neq – not equal to
lik – like
nlik – not like
lik_s – starts with
lik_e – ends with
n – null
nn – not null
“LookupValue” – The value of the user attribute you passed in LookupName.
“ConditionOperator” – “AND” or “OR”. You can add multiple conditions with a condition group. When you’re adding the next condition, you must specify its relationship with the previous condition here. You must use the same operator between conditions within a group (Condition 1 AND Condition to AND Condition 3 or Condition 1 OR Condition 2 OR Condition 3)

Response

200 OK

Content-Type: application/json

{
   "RecordCount":2,
   "List":[
      {
         "UserTaskId":"59cfdcfe-3330-49ea-a975-d1dd61206532",
         "Name":"Follow-Up:",
         "Description":"",
         "RelatedEntity":0,
         "DueDate":"2022-06-15 11:30:00.000",
         "Reminder":15,
         "ReminderBeforeDays":0,
         "NotifyBy":"1000",
         "StatusCode":0,
         "OwnerId":"3b1041fb-8374-11e7-8758-0a106ee76b21",
         "OwnerName":"Vir Singh",
         "CreatedBy":"3b1041fb-8374-11e7-8758-0a106ee76b21",
         "CreatedByName":"Vir Singh",
         "CreatedOn":"2022-05-30 10:25:07.000",
         "ModifiedBy":"3b1041fb-8374-11e7-8758-0a106ee76b21",
         "ModifiedByName":"Vir Singh",
         "ModifiedOn":"2022-05-30 10:25:07.000",
         "RelatedEntityIdName":"",
         "CompletedOn":"0001-01-01 00:00:00.000",
         "TaskType":{
            "Category":0,
            "Color":"#F8BBD0",
            "ColumnConfiguration":[
               
            ],
            "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":false,
            "PreventConflict":true,
            "ReminderConfiguration":{
               "IsEnable":false
            },
            "Sequence":1,
            "ShowLeadCalendarInvite":false,
            "ShowOrganiserCalendarInvite":false,
            "ShowOwnerCalendarInvite":false,
            "ShowParticipantCalendarInvite":null,
            "Status":1,
            "TaskTypeConfiguration":{
               "BusinessWorkFlow":{
                  "IsEnabled":false,
                  "Status":{
                     "Label":null,
                     "Values":[
                        
                     ]
                  }
               },
               "CalenderInvite":{
                  "Lead":{
                     "IsEnabled":false,
                     "IsSent":false,
                     "Subject":null,
                     "TemplateContent":null
                  },
                  "Organiser":{
                     "IsEnabled":false,
                     "IsSent":false,
                     "Subject":null,
                     "TemplateContent":null
                  },
                  "Owner":{
                     "IsEnabled":false,
                     "IsSent":false,
                     "Subject":null,
                     "TemplateContent":null
                  },
                  "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
               }
            }
         },
         "OwnerEmailAddress":"virkdsingh@gmail.com",
         "EndDate":"2022-06-15 12:00:00",
         "PercentCompleted":0,
         "Priority":"",
         "Location":"",
         "CustomFields":{
            
         }
      },
      {
         "UserTaskId":"3503e8d6-86d6-4853-aaab-e7df02fd7b3f",
         "Name":"Follow-Up:",
         "Description":"",
         "RelatedEntity":0,
         "DueDate":"2022-06-01 11:30:00.000",
         "Reminder":15,
         "ReminderBeforeDays":0,
         "NotifyBy":"1000",
         "StatusCode":0,
         "OwnerId":"3b1041fb-8374-11e7-8758-0a106ee76b21",
         "OwnerName":"Vir Singh",
         "CreatedBy":"3b1041fb-8374-11e7-8758-0a106ee76b21",
         "CreatedByName":"Vir Singh",
         "CreatedOn":"2022-05-30 10:25:07.000",
         "ModifiedBy":"3b1041fb-8374-11e7-8758-0a106ee76b21",
         "ModifiedByName":"Vir Singh",
         "ModifiedOn":"2022-05-30 10:25:07.000",
         "RelatedEntityIdName":"",
         "CompletedOn":"0001-01-01 00:00:00.000",
         "TaskType":{
            "Category":0,
            "Color":"#F8BBD0",
            "ColumnConfiguration":[
               
            ],
            "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":false,
            "PreventConflict":true,
            "ReminderConfiguration":{
               "IsEnable":false
            },
            "Sequence":1,
            "ShowLeadCalendarInvite":false,
            "ShowOrganiserCalendarInvite":false,
            "ShowOwnerCalendarInvite":false,
            "ShowParticipantCalendarInvite":null,
            "Status":1,
            "TaskTypeConfiguration":{
               "BusinessWorkFlow":{
                  "IsEnabled":false,
                  "Status":{
                     "Label":null,
                     "Values":[
                        
                     ]
                  }
               },
               "CalenderInvite":{
                  "Lead":{
                     "IsEnabled":false,
                     "IsSent":false,
                     "Subject":null,
                     "TemplateContent":null
                  },
                  "Organiser":{
                     "IsEnabled":false,
                     "IsSent":false,
                     "Subject":null,
                     "TemplateContent":null
                  },
                  "Owner":{
                     "IsEnabled":false,
                     "IsSent":false,
                     "Subject":null,
                     "TemplateContent":null
                  },
                  "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
               }
            }
         },
         "OwnerEmailAddress":"virkdsingh@gmail.com",
         "EndDate":"2022-06-01 12:00:00",
         "PercentCompleted":0,
         "Priority":"",
         "Location":"",
         "CustomFields":{
            
         }
      }
   ]
}

HTTP Response Codes

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.

POST ?accessKey=&secretKey=

URL Parameters

Get account details

Code

Host Name Please enter valid URL.

Access Key

Secret Key

Additional Header

Remove

Add more

Body

{
    "FromDate": "2022-04-25",
    "ToDate": "2022-06-25",
    "UserSearchCriteria": {
        "GroupConditions": [
            {
                "GroupConditions": [
                    {
                        "Condition": [
                            {
                                "LookupName": "FirstName",
                                "Operator": "lik_s",
                                "LookupValue": "V",
                                "ConditionOperator": null
                            }
                        ],
                        "GroupOperator": null
                    }
                ],
                "GroupOperator": "AND"
            },
            {
                "Condition": [
                    {
                        "LookupName": "LastName",
                        "Operator": "eq",
                        "LookupValue": "Singh",
                        "ConditionOperator": null
                    }
                ],
                "GroupOperator": null
            }
        ]
    }
}

Reset

Response

You have not yet submited

Generate Code


<?php $url = $url;
$data_string = "<?php echo $json_data; ?>";
$header=array(
                "Content-Type:application/json",
                "Content-Length:" 0,
            );
        if(!empty($header)&&isset($_POST["ad_key"])&&!empty($_POST["ad_key"])){
            foreach ($_POST["ad_key"] as $key => $value) {
                if(!empty($value)&&!empty($_POST["ad_value"][$key]))
                $header[]= $value.$colan.$_POST["ad_value"][$key];
            }
        }
try
    {
    $curl = curl_init($url);
    curl_setopt($curl, CURLOPT_CUSTOMREQUEST, "POST");
    curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
    curl_setopt($curl, CURLOPT_HEADER, 0);
    curl_setopt($curl, CURLOPT_POSTFIELDS, $data_string);
    curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, false);
    curl_setopt($curl, CURLOPT_HTTPHEADER, $header);
    $response = curl_exec($curl);
        curl_close($curl);
        if ($err) {
            echo "cURL Error #:" . $err;
        }else{
            echo $response;
        }
    } catch (Exception $ex) {
        curl_close($curl);
    }?>


import requests
url = "<?php echo $surl; ?>"
querystring = <?php echo $jsqry;?>
payload = <?php var_export(str_replace(" ","",$json_data; ?>
headers = {
        "content-type": "application/json",
        "cache-control": "no-cache"
    }
        response = requests.request("POST", url, data=payload, headers=headers, params=querystring)
        print(response.text)

Submit a Ticket
First Name
Last Name
Email
Subject
Issue Description
Priority
Attachment	Attach files Each of your file(s) can be up to 20MB in size.
Captcha	Refresh

	powered by

LeadSquared Developer Centre

Get Appointments by Search Criteria

API URL

Request

Request Parameters

Response

HTTP Response Codes

On this page

Resources

Related Sites

Get in Touch