Get To-Dos by Search Criteria
Retrieves to-dos 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 to-dos. 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 to-dos for.
The API response returns all to-do details including system and custom fields.
API URL
URL
POST
https://{host}/v2/Task.svc/RetrieveToDos/ByUserSearchCriteria?accessKey=AccessKey&secretKey=SecretKey
Request
Content-Type: application/jsonJSON Body/Payload
{
"FromDate": "2018-09-25",
"ToDate": "2018-09-25",
"UserSearchCriteria": {
"GroupConditions": [
{
"GroupConditions": [
{
"Condition": [
{
"LookupName": "FirstName",
"Operator": "lik_s",
"LookupValue": "z",
"ConditionOperator": null
}
],
"GroupOperator": null
}
],
"GroupOperator": "AND"
},
{
"Condition": [
{
"LookupName": "StatusCode",
"Operator": "eq",
"LookupValue": "0",
"ConditionOperator": null
}
],
"GroupOperator": null
}
]
}
}
Request Parameters
| Parameter | Description |
|---|---|
| FromDate | Starting date to retrieve to-dos from. |
| ToDate | End date you want to retrieve to-dos till. |
| UserSearchCriteria | “GroupConditions” – You can create one or more condition groups. You can set multiple conditions inside each condition group. “Condition” –
|
Response
200 OK
Content-Type: application/json
{
"RecordCount":1,
"List":[
{
"UserTaskId":"aad2dceb-0c04-11ed-b7fd-0218d8753a48",
"Name":"Revive Old Lead:",
"Category":1,
"Description":"",
"RelatedEntity":0,
"DueDate":"2022-07-24 18: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:29:30.000",
"ModifiedBy":"3b1041fb-8374-11e7-8758-0a106ee76b21",
"ModifiedByName":"Vir Singh",
"ModifiedOn":"2022-07-25 10:29:30.000",
"RelatedEntityIdName":"",
"CompletedOn":"0001-01-01 00:00:00.000",
"TaskType":{
"Category":1,
"Color":"",
"ColumnConfiguration":[
],
"CreatedBy":"Vir Singh",
"CreatedOn":"/Date(1534242096000+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\":\"mx_Custom_1\",\"DisplayName\":null,\"Colspan\":1,\"Disabled\":false},{\"SchemaName\":\"Location\",\"DisplayName\":null,\"Colspan\":1,\"Disabled\":true},{\"SchemaName\":\"PercentCompleted\",\"DisplayName\":null,\"Colspan\":1,\"Disabled\":true},{\"SchemaName\":\"Priority\",\"DisplayName\":null,\"Colspan\":1,\"Disabled\":true},{\"SchemaName\":\"EffortEstimate\",\"DisplayName\":null,\"Colspan\":1,\"Disabled\":true}]}",
"Id":"d30b3e91-9fab-11e8-9f20-020714094d7e",
"IsDefault":false,
"IsDeleteable":true,
"IsEditable":true,
"ModifiedBy":"Vir Singh",
"ModifiedOn":"/Date(1568597681000+0000)/",
"Name":"Revive Old Lead",
"OpenCompletedTasks":false,
"PreventConflict":false,
"ReminderConfiguration":{
"IsEnable":false
},
"Sequence":7,
"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":"thismonth",
"Values":null
},
"EffortEstimate":{
"IsEnabled":false,
"Value":"30",
"ValueUnit":"Minute",
"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-31 18:29:00",
"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. |
