LeadSquared Developer Centre

You are here: Get Appointments by User Id
Table of contents
ON THIS PAGE

Get Appointments by User Id

Try it

Lets you retrieve appointments for multiple users by passing their user Ids.

  • 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 user Ids in the “Users” parameter.

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

 

API URL

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

Request

Content-Type: application/json
JSON Body/Payload Icon 
{
  "FromDate": "2018-08-25",
  "ToDate": "2018-09-25",
  "Users": [
    "8fce0bee-a46a-11e8-a43f-02742c1c8abe",
    "3b1041fb-8374-11e7-8758-0a106ee76b21"
  ],
  "Paging": {
    "PageIndex": 1,
    "PageSize": 200
  }
}

Request Parameters

Parameter Description
FromDate

Starting date to retrieve appointments from.
ToDate

End date you want to retrieve appointments till.
Users

You can pass multiple user Ids here.
Paging

Use “PageIndex” to specify the number of pages to return and “PageSize” to indicate the number of records you want returned per page.

Response

200 OK
Content-Type: application/json 
{
   "RecordCount":4,
   "List":[
      {
         "UserTaskId":"cad802c2-0c01-11ed-b7fd-0218d8753a48",
         "Name":"Follow-Up:",
         "Description":"",
         "RelatedEntity":0,
         "DueDate":"2022-07-25 10: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-07-25 10:08:55.000",
         "ModifiedBy":"3b1041fb-8374-11e7-8758-0a106ee76b21",
         "ModifiedByName":"Vir Singh",
         "ModifiedOn":"2022-07-25 10:08:55.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-07-25 11:00:00",
         "EffortEstimateUnit":"",
         "PercentCompleted":0,
         "Priority":"",
         "Location":"",
         "CustomFields":{
            
         }
      },
      {
         "UserTaskId":"a95d198f-09bf-11ed-993a-06f221480cd8",
         "Name":"Follow-Up: Carl Jung",
         "Description":"",
         "RelatedEntity":1,
         "RelatedEntityId":"b35b807f-fa08-49f6-9a00-c5d24b815258",
         "DueDate":"2022-07-22 13:11:30.000",
         "Reminder":0,
         "ReminderBeforeDays":0,
         "ReminderTime":"00:00:00",
         "NotifyBy":"1000",
         "StatusCode":0,
         "OwnerId":"3b1041fb-8374-11e7-8758-0a106ee76b21",
         "OwnerName":"Vir Singh",
         "CreatedBy":"3b1041fb-8374-11e7-8758-0a106ee76b21",
         "CreatedByName":"Vir Singh",
         "CreatedOn":"2022-07-22 13:10:30.000",
         "ModifiedBy":"3b1041fb-8374-11e7-8758-0a106ee76b21",
         "ModifiedByName":"Vir Singh",
         "ModifiedOn":"2022-07-22 13:10:30.000",
         "RelatedEntityIdName":"Carl Jung",
         "CompletedOn":"0001-01-01 00:00:00.000",
         "TaskType":{
            "Category":0,
            "Color":"#F8BBD0",
            "ColumnConfiguration":[
               
            ],
            "CreatedBy":null,
            "CreatedOn":"/Date(-62135596800000+0000)/",
            "FormLayout":null,
            "Id":"3c8c1673-8374-11e7-ab78-02de49b06427",
            "IsDefault":false,
            "IsDeleteable":false,
            "IsEditable":false,
            "ModifiedBy":null,
            "ModifiedOn":"/Date(-62135596800000+0000)/",
            "Name":"Follow-Up",
            "OpenCompletedTasks":false,
            "PreventConflict":false,
            "ReminderConfiguration":{
               "IsEnable":false
            },
            "Sequence":0,
            "ShowLeadCalendarInvite":null,
            "ShowOrganiserCalendarInvite":null,
            "ShowOwnerCalendarInvite":null,
            "ShowParticipantCalendarInvite":null,
            "Status":0,
            "TaskTypeConfiguration":{
               "BusinessWorkFlow":{
                  "IsEnabled":false,
                  "Status":{
                     "Label":"",
                     "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":""
               },
               "Priority":{
                  "IsEnabled":false,
                  "Value":null,
                  "Values":null
               },
               "TaskCompleted":{
                  "IsEnabled":false
               }
            }
         },
         "OwnerEmailAddress":"virkdsingh@gmail.com",
         "EndDate":"2022-07-22 13:41:30",
         "EffortEstimateUnit":"",
         "PercentCompleted":0,
         "Priority":"",
         "Location":"",
         "CustomFields":{
            
         }
      },
      {
         "UserTaskId":"2032c8f1-09a8-11ed-993a-06f221480cd8",
         "Name":"Follow-Up: William James",
         "Description":"",
         "RelatedEntity":1,
         "RelatedEntityId":"05d32e9e-8770-4b2e-afdd-a293fd15430d",
         "DueDate":"2022-07-22 10:23:02.000",
         "Reminder":0,
         "ReminderBeforeDays":0,
         "ReminderTime":"00:00:00",
         "NotifyBy":"1000",
         "StatusCode":0,
         "OwnerId":"3b1041fb-8374-11e7-8758-0a106ee76b21",
         "OwnerName":"Vir Singh",
         "CreatedBy":"3b1041fb-8374-11e7-8758-0a106ee76b21",
         "CreatedByName":"Vir Singh",
         "CreatedOn":"2022-07-22 10:22:01.000",
         "ModifiedBy":"3b1041fb-8374-11e7-8758-0a106ee76b21",
         "ModifiedByName":"Vir Singh",
         "ModifiedOn":"2022-07-22 10:22:01.000",
         "RelatedEntityIdName":"William James",
         "CompletedOn":"0001-01-01 00:00:00.000",
         "TaskType":{
            "Category":0,
            "Color":"#F8BBD0",
            "ColumnConfiguration":[
               
            ],
            "CreatedBy":null,
            "CreatedOn":"/Date(-62135596800000+0000)/",
            "FormLayout":null,
            "Id":"3c8c1673-8374-11e7-ab78-02de49b06427",
            "IsDefault":false,
            "IsDeleteable":false,
            "IsEditable":false,
            "ModifiedBy":null,
            "ModifiedOn":"/Date(-62135596800000+0000)/",
            "Name":"Follow-Up",
            "OpenCompletedTasks":false,
            "PreventConflict":false,
            "ReminderConfiguration":{
               "IsEnable":false
            },
            "Sequence":0,
            "ShowLeadCalendarInvite":null,
            "ShowOrganiserCalendarInvite":null,
            "ShowOwnerCalendarInvite":null,
            "ShowParticipantCalendarInvite":null,
            "Status":0,
            "TaskTypeConfiguration":{
               "BusinessWorkFlow":{
                  "IsEnabled":false,
                  "Status":{
                     "Label":"",
                     "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":""
               },
               "Priority":{
                  "IsEnabled":false,
                  "Value":null,
                  "Values":null
               },
               "TaskCompleted":{
                  "IsEnabled":false
               }
            }
         },
         "OwnerEmailAddress":"virkdsingh@gmail.com",
         "EndDate":"2022-07-22 10:53:01",
         "EffortEstimateUnit":"",
         "PercentCompleted":0,
         "Priority":"",
         "Location":"",
         "CustomFields":{
            
         }
      },
      {
         "UserTaskId":"30b96583-099d-11ed-993a-06f221480cd8",
         "Name":"Follow-Up: John Smith",
         "Description":"",
         "RelatedEntity":1,
         "RelatedEntityId":"637080a2-dcc1-4acb-8e52-db8d48b8905e",
         "DueDate":"2022-07-22 09:04:45.000",
         "Reminder":0,
         "ReminderBeforeDays":0,
         "ReminderTime":"00:00:00",
         "NotifyBy":"1000",
         "StatusCode":0,
         "OwnerId":"3b1041fb-8374-11e7-8758-0a106ee76b21",
         "OwnerName":"Vir Singh",
         "CreatedBy":"3b1041fb-8374-11e7-8758-0a106ee76b21",
         "CreatedByName":"Vir Singh",
         "CreatedOn":"2022-07-22 09:03:45.000",
         "ModifiedBy":"3b1041fb-8374-11e7-8758-0a106ee76b21",
         "ModifiedByName":"Vir Singh",
         "ModifiedOn":"2022-07-22 09:03:45.000",
         "RelatedEntityIdName":"John Smith",
         "CompletedOn":"0001-01-01 00:00:00.000",
         "TaskType":{
            "Category":0,
            "Color":"#F8BBD0",
            "ColumnConfiguration":[
               
            ],
            "CreatedBy":null,
            "CreatedOn":"/Date(-62135596800000+0000)/",
            "FormLayout":null,
            "Id":"3c8c1673-8374-11e7-ab78-02de49b06427",
            "IsDefault":false,
            "IsDeleteable":false,
            "IsEditable":false,
            "ModifiedBy":null,
            "ModifiedOn":"/Date(-62135596800000+0000)/",
            "Name":"Follow-Up",
            "OpenCompletedTasks":false,
            "PreventConflict":false,
            "ReminderConfiguration":{
               "IsEnable":false
            },
            "Sequence":0,
            "ShowLeadCalendarInvite":null,
            "ShowOrganiserCalendarInvite":null,
            "ShowOwnerCalendarInvite":null,
            "ShowParticipantCalendarInvite":null,
            "Status":0,
            "TaskTypeConfiguration":{
               "BusinessWorkFlow":{
                  "IsEnabled":false,
                  "Status":{
                     "Label":"",
                     "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":""
               },
               "Priority":{
                  "IsEnabled":false,
                  "Value":null,
                  "Values":null
               },
               "TaskCompleted":{
                  "IsEnabled":false
               }
            }
         },
         "OwnerEmailAddress":"virkdsingh@gmail.com",
         "EndDate":"2022-07-22 09:34:44",
         "EffortEstimateUnit":"",
         "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.

On this page

leadsquared

LeadSquared LeadSquared

Get in Touch

sales@leadsquared.com
North America: +1-732-385-3546
India Sales: (+91) 90191 72733
India Support: 080-46801265

© 2022 by MarketXpander Services Pvt Ltd. All Rights Reserved.