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
POST
https://{host}/v2/Task.svc/RetrieveAppointments/ByUserId?accessKey=AccessKey&secretKey=SecretKey
Copy URL
Request
JSON Body/Payload
Content-Type: application/json
{
"FromDate": "2018-08-25",
"ToDate": "2018-09-25",
"Users": [
"8fce0bee-a46a-11e8-a43f-02742c1c8abe",
"3b1041fb-8374-11e7-8758-0a106ee76b21"
],
"Paging": {
"PageIndex": 1,
"PageSize": 200
}
}
JSON Properties
{
"FromDate": "2018-08-25",
"ToDate": "2018-09-25",
"Users": [
"8fce0bee-a46a-11e8-a43f-02742c1c8abe",
"3b1041fb-8374-11e7-8758-0a106ee76b21"
],
"Paging": {
"PageIndex": 1,
"PageSize": 200
}
}
JSON Properties
| 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": 2,
"List": [
{
"UserTaskId": "b39bbbdb-aa90-11e8-8a14-020714094d7e",
"Name": "Proposal:",
"Description": "HSR",
"RelatedEntity": 1,
"RelatedEntityId": "91b0b29b-63ab-48f4-8af6-31718480c22e",
"DueDate": "2018-08-28 10:00:00.000",
"Reminder": 15,
"ReminderBeforeDays": 0,
"NotifyBy": "1100",
"OwnerId": "3b1041fb-8374-11e7-8758-0a106ee76b21",
"OwnerName": "Vir Singh",
"CreatedBy": "3b1041fb-8374-11e7-8758-0a106ee76b21",
"CreatedByName": "Vir Singh",
"CreatedOn": "2018-08-28 07:05:10.000",
"ModifiedBy": "3b1041fb-8374-11e7-8758-0a106ee76b21",
"ModifiedByName": "Vir Singh",
"ModifiedOn": "2018-08-28 07:05:10.000",
"RelatedEntityIdName": "Harry Kane",
"CompletedOn": "0001-01-01 00:00:00.000",
"TaskType": {
"Category": 0,
"Color": "#00c06a",
"ColumnConfiguration": [],
"CreatedBy": "Vir Singh",
"CreatedOn": "/Date(1530797907000+0000)/",
"FormLayout": "{"Sections":[{"DisplayName":"Task Details","Fields":[{"SchemaName":"OwnerId","Disabled":"False","Colspan":2},{"SchemaName":"RelatedEntityId","Disabled":"False","Colspan":2},{"SchemaName":"Name","Disabled":"False","Colspan":2},{"SchemaName":"Location","Disabled":"False","Colspan":2},{"SchemaName":"DueDate","Disabled":"False","Colspan":2},{"SchemaName":"Reminder","Disabled":"False","Colspan":1},{"SchemaName":"Description","Disabled":"False","Colspan":2},{"SchemaName":"mx_Custom_1","Disabled":"False","Colspan":1},{"SchemaName":"CreatedBy","Disabled":"False","Colspan":2}]},{"DisplayName":"New Section","Fields":[{"SchemaName":"Priority","Disabled":"False","Colspan":1}]}],"AvailableFields":[{"SchemaName":"PercentCompleted","Disabled":"True","Colspan":1}]}",
"Id": "b26e72ca-8058-11e8-9af7-020714094d7e",
"IsDefault": false,
"IsDeleteable": true,
"IsEditable": true,
"ModifiedBy": "Vir Singh",
"ModifiedOn": "/Date(1530797996000+0000)/",
"Name": "Proposal",
"PreventConflict": false,
"ReminderConfiguration": {
"IsEnable": true
},
"Sequence": 4,
"ShowLeadCalendarInvite": true,
"ShowOrganiserCalendarInvite": true,
"ShowOwnerCalendarInvite": true,
"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": "45",
"Values": null
},
"EffortEstimate": {
"IsEnabled": false,
"Value": null,
"ValueUnit": null,
"Values": null
},
"Location": {
"IsEnabled": true,
"IsMandatory": true,
"LocationValue": null
},
"Priority": {
"IsEnabled": true,
"Value": "high",
"Values": null
},
"TaskCompleted": {
"IsEnabled": false
}
}
},
"OwnerEmailAddress": "virkdsingh@gmail.com",
"EndDate": "2018-08-28 10:45:00",
"EffortEstimateUnit": "",
"PercentCompleted": 0,
"Priority": "High",
"Location": "s",
"CustomFields": {}
},
{
"UserTaskId": "9ab8489e-aa90-11e8-8a14-020714094d7e",
"Name": "Follow-Up:",
"Description": "",
"RelatedEntity": 1,
"RelatedEntityId": "6f75b09d-0187-45d6-86dd-f848bd5a0aca",
"DueDate": "2018-08-28 09:15:00.000",
"Reminder": 15,
"ReminderBeforeDays": 0,
"NotifyBy": "1100",
"OwnerId": "3b1041fb-8374-11e7-8758-0a106ee76b21",
"OwnerName": "Vir Singh",
"CreatedBy": "3b1041fb-8374-11e7-8758-0a106ee76b21",
"CreatedByName": "Vir Singh",
"CreatedOn": "2018-08-28 07:04:28.000",
"ModifiedBy": "3b1041fb-8374-11e7-8758-0a106ee76b21",
"ModifiedByName": "Vir Singh",
"ModifiedOn": "2018-08-28 07:04:28.000",
"RelatedEntityIdName": "George Jackson",
"CompletedOn": "0001-01-01 00:00:00.000",
"TaskType": {
"Category": 0,
"Color": "#F8BBD0",
"ColumnConfiguration": [],
"CreatedBy": "System",
"CreatedOn": "/Date(1502992091000+0000)/",
"FormLayout": null,
"Id": "3c8c1673-8374-11e7-ab78-02de49b06427",
"IsDefault": true,
"IsDeleteable": true,
"IsEditable": true,
"ModifiedBy": "Vir Singh",
"ModifiedOn": "/Date(1530756750000+0000)/",
"Name": "Follow-Up",
"PreventConflict": false,
"ReminderConfiguration": {
"IsEnable": true
},
"Sequence": 1,
"ShowLeadCalendarInvite": false,
"ShowOrganiserCalendarInvite": false,
"ShowOwnerCalendarInvite": false,
"ShowParticipantCalendarInvite": null,
"Status": 1,
"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": null,
"Values": null
},
"EffortEstimate": {
"IsEnabled": false,
"Value": null,
"ValueUnit": null,
"Values": null
},
"Location": {
"IsEnabled": false,
"IsMandatory": false,
"LocationValue": null
},
"Priority": {
"IsEnabled": false,
"Value": null,
"Values": null
},
"TaskCompleted": {
"IsEnabled": false
}
}
},
"OwnerEmailAddress": "virkdsingh@gmail.com",
"EndDate": "2018-08-28 09:45:00",
"EffortEstimateUnit": "",
"PercentCompleted": 0,
"Priority": "",
"Location": "",
"CustomFields": {}
}
]
}
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. |