Lets you retrieve 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
Request
JSON Body/Payload
Content-Type: application/json
{
"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
}
]
}
}
JSON Properties
{ "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 } ] } }
JSON Properties
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": 3, "List": [ { "UserTaskId": "a11e699d-c089-11e8-a43f-02742c1c8abe", "Name": "Meeting:", "Description": "", "RelatedEntity": 0, "DueDate": "/Date(1537857000000+0000)/", "Reminder": 15, "NotifyBy": "1100", "OwnerId": "477aec30-bfee-11e8-a43f-02742c1c8abe", "OwnerName": "zoo", "CreatedBy": "8371b49f-a465-11e8-aa96-0258598489d8", "CreatedByName": "Bhargavi.tasknew14", "CreatedOn": "/Date(1537855798000+0000)/", "ModifiedBy": "8371b49f-a465-11e8-aa96-0258598489d8", "ModifiedByName": "Bhargavi.tasknew14", "ModifiedOn": "/Date(1537855798000+0000)/", "RelatedEntityIdName": "", "CompletedOn": "/Date(-62135596800000+0000)/", "UserTaskAutoId": "T10054", "TaskType": { "Category": 0, "Color": "#F8BBD0", "ColumnConfiguration": [], "CreatedBy": "System", "CreatedOn": "/Date(1534761657000)/", "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":"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},{"SchemaName":"Location","DisplayName":null,"Colspan":1,"Disabled":false},{"SchemaName":"EndDate","DisplayName":"End Date","Colspan":1,"Disabled":false},{"SchemaName":"EffortEstimateUnit","DisplayName":"Effort Estimate Unit","Colspan":1,"Disabled":false}]}", "Id": "856d14cd-a465-11e8-a43f-02742c1c8abe", "IsDefault": true, "IsDeleteable": true, "IsEditable": true, "ModifiedBy": "Bhargavi.tasknew14", "ModifiedOn": "/Date(1537789732000)/", "Name": "Meeting", "PreventConflict": true, "ReminderConfiguration": { "IsEnable": true }, "Sequence": 2, "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": "30", "Values": null }, "EffortEstimate": { "IsEnabled": false, "Value": null, "ValueUnit": null, "Values": null }, "Location": { "IsEnabled": true, "IsMandatory": true, "LocationValue": null }, "Priority": { "IsEnabled": false, "Value": null, "Values": null }, "TaskCompleted": { "IsEnabled": false } } }, "Validate": false, "CanUpdate": true, "TaskCompletedOn": "0001-01-01 00:00:00", "Status": 0, "OwnerEmailAddress": "zoo@lsqdev.in", "RelatedEntityIdSchemaName": "Phone", "HasUpdatePermission": true, "HasDeletePermission": true, "TaskTypeId": "856d14cd-a465-11e8-a43f-02742c1c8abe", "Location": "", "EndDate": "2018-09-25 07:00:00", "PercentCompleted": 0, "Priority": "", "CustomFields": {}, "ReminderBeforeDays": 0, "EffortEstimateUnit": "" }, { "UserTaskId": "8655cf56-c089-11e8-a43f-02742c1c8abe", "Name": "Task1:", "Description": "", "RelatedEntity": 0, "DueDate": "/Date(1537857000000+0000)/", "Reminder": 15, "NotifyBy": "1100", "OwnerId": "477aec30-bfee-11e8-a43f-02742c1c8abe", "OwnerName": "zoo", "CreatedBy": "8371b49f-a465-11e8-aa96-0258598489d8", "CreatedByName": "Bhargavi.tasknew14", "CreatedOn": "/Date(1537855753000+0000)/", "ModifiedBy": "8371b49f-a465-11e8-aa96-0258598489d8", "ModifiedByName": "Bhargavi.tasknew14", "ModifiedOn": "/Date(1537855753000+0000)/", "RelatedEntityIdName": "", "CompletedOn": "/Date(-62135596800000+0000)/", "UserTaskAutoId": "T10052", "TaskType": { "Category": 0, "Color": "#efbae7", "ColumnConfiguration": [], "CreatedBy": "Bhargavi.tasknew14", "CreatedOn": "/Date(1534830967000)/", "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},{"SchemaName":"mx_Custom_1","DisplayName":null,"Colspan":1,"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":"EndDate","DisplayName":"End Date","Colspan":1,"Disabled":false},{"SchemaName":"EffortEstimateUnit","DisplayName":"Effort Estimate Unit","Colspan":1,"Disabled":false},{"SchemaName":"mx_Custom_2","DisplayName":"Custom 2","Colspan":1,"Disabled":false}]}", "Id": "e5c18723-a506-11e8-a43f-02742c1c8abe", "IsDefault": false, "IsDeleteable": true, "IsEditable": true, "ModifiedBy": "Bhargavi.tasknew14", "ModifiedOn": "/Date(1534832654000)/", "Name": "Task1", "PreventConflict": false, "ReminderConfiguration": { "IsEnable": true }, "Sequence": 11, "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": "30", "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 } } }, "Validate": false, "CanUpdate": true, "TaskCompletedOn": "0001-01-01 00:00:00", "Status": 0, "OwnerEmailAddress": "zoo@lsqdev.in", "RelatedEntityIdSchemaName": "Phone", "HasUpdatePermission": true, "HasDeletePermission": true, "TaskTypeId": "e5c18723-a506-11e8-a43f-02742c1c8abe", "Location": "", "EndDate": "2018-09-25 07:00:00", "PercentCompleted": 0, "Priority": "", "CustomFields": { "mx_Custom_1": "dscds" }, "ReminderBeforeDays": 0, "EffortEstimateUnit": "" }, { "UserTaskId": "5bedd63d-c087-11e8-a43f-02742c1c8abe", "Name": "Meeting:", "Description": "", "RelatedEntity": 0, "DueDate": "/Date(1537855200000+0000)/", "Reminder": 15, "NotifyBy": "1100", "OwnerId": "477aec30-bfee-11e8-a43f-02742c1c8abe", "OwnerName": "zoo", "CreatedBy": "8371b49f-a465-11e8-aa96-0258598489d8", "CreatedByName": "Bhargavi.tasknew14", "CreatedOn": "/Date(1537854823000+0000)/", "ModifiedBy": "8371b49f-a465-11e8-aa96-0258598489d8", "ModifiedByName": "Bhargavi.tasknew14", "ModifiedOn": "/Date(1537854823000+0000)/", "RelatedEntityIdName": "", "CompletedOn": "/Date(-62135596800000+0000)/", "UserTaskAutoId": "T10050", "TaskType": { "Category": 0, "Color": "#F8BBD0", "ColumnConfiguration": [], "CreatedBy": "System", "CreatedOn": "/Date(1534761657000)/", "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":"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},{"SchemaName":"Location","DisplayName":null,"Colspan":1,"Disabled":false},{"SchemaName":"EndDate","DisplayName":"End Date","Colspan":1,"Disabled":false},{"SchemaName":"EffortEstimateUnit","DisplayName":"Effort Estimate Unit","Colspan":1,"Disabled":false}]}", "Id": "856d14cd-a465-11e8-a43f-02742c1c8abe", "IsDefault": true, "IsDeleteable": true, "IsEditable": true, "ModifiedBy": "Bhargavi.tasknew14", "ModifiedOn": "/Date(1537789732000)/", "Name": "Meeting", "PreventConflict": true, "ReminderConfiguration": { "IsEnable": true }, "Sequence": 2, "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": "30", "Values": null }, "EffortEstimate": { "IsEnabled": false, "Value": null, "ValueUnit": null, "Values": null }, "Location": { "IsEnabled": true, "IsMandatory": true, "LocationValue": null }, "Priority": { "IsEnabled": false, "Value": null, "Values": null }, "TaskCompleted": { "IsEnabled": false } } }, "Validate": false, "CanUpdate": true, "TaskCompletedOn": "0001-01-01 00:00:00", "Status": 0, "OwnerEmailAddress": "zoo@lsqdev.in", "RelatedEntityIdSchemaName": "Phone", "HasUpdatePermission": true, "HasDeletePermission": true, "TaskTypeId": "856d14cd-a465-11e8-a43f-02742c1c8abe", "Location": "", "EndDate": "2018-09-25 06:30:00", "PercentCompleted": 0, "Priority": "", "CustomFields": {}, "ReminderBeforeDays": 0, "EffortEstimateUnit": "" } ] }
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. |