Returns tasks assigned to a particular owner/user.
- Pass the “OwnerId” or “OwnerEmailAddress” in the JSON body to specify the owner.
- You can also provide the additional parameters, “FromDate” and “ToDate” to find tasks between a specific time frame.
- Use “StatusCode” = “0” to find incomplete tasks and “1” to find completed tasks.
API URL
Request
JSON Body/Payload
Content-Type: application/json
{
"Parameter": {
"LookupName": "OwnerEmailAddress",
"LookupValue": "userlead@yopmail.com",
"FromDate": "2017-05-09 18:30:00",
"ToDate": "2017-05-10 18:29:59",
"StatusCode": 0,
"TypeName": "<>"
},
"Columns": {
"Exclude_CSV": "ProspectID,FirstName"
},
"Sorting": {
"ColumnName": "Duedate",
"Direction": "1"
},
"Paging": {
"Offset": 0,
"RowCount": 200
}
}
JSON Properties
{ "Parameter": { "LookupName": "OwnerEmailAddress", "LookupValue": "userlead@yopmail.com", "FromDate": "2017-05-09 18:30:00", "ToDate": "2017-05-10 18:29:59", "StatusCode": 0, "TypeName": "<>" }, "Columns": { "Exclude_CSV": "ProspectID,FirstName" }, "Sorting": { "ColumnName": "Duedate", "Direction": "1" }, "Paging": { "Offset": 0, "RowCount": 200 } }
JSON Properties
Parameter | Description |
---|---|
LookupName | Pass “OwnerId” here. |
LookupValue | Value of the “OwnerId”. |
FromDate | Starting date to search for tasks. |
ToDate | End date to search for tasks. |
StatusCode | This is the status code of the task.
|
TypeName | The task type Id. |
Exclude_CSV | The columns you don’t want displayed in the response. |
ColmnName | The column on which results will be sorted. For example, if you want results to be shown based on creation date, pass “CreatedOn”. |
Direction | Direction “1” means descending order and “0” means ascending order. |
Offset | The number of results to skip. |
RowCount | The number of results to display. |
Response
200 OK
Content-Type: application/json
{ "RecordCount": 1, "List": [ { "UserTaskId": "1c12e3d1-5153-11e5-981b-22000a9700b4", "Name": "My Task TODO", "Description": "Describing the task", "RelatedEntity": 1, "RelatedEntityId": "81c9663b-9aa1-468d-8522-85979f638d18", "DueDate": "2015-09-30 11:11:00.000", "Reminder": 15, "NotifyBy": "1100", "OwnerId": "e2553ede-c6ee-11e4-981b-22000a9700b4", "OwnerName": "Syed Rizwan", "CreatedBy": "6ba64831-b1c1-11e4-981b-22000a9700b4", "CreatedByName": "rizwan ali", "CreatedOn": "2015-09-02 09:15:09.000", "ModifiedBy": "6ba64831-b1c1-11e4-981b-22000a9700b4", "ModifiedByName": "rizwan ali", "ModifiedOn": "2015-09-18 09:48:37.000", "RelatedEntityIdName": "John Smith", "CompletedOn": "0001-01-01 00:00:00.000" } ] }
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. |