Get To-Dos by Email Address

Lets you retrieve to-dos for multiple users by passing their email addresses.

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

The API response returns all to-do details including system and custom fields.

 

API URL

POST
https://{host}/v2/Task.svc/RetrieveToDos/ByUserEmailAddress?accessKey=AccessKey&secretKey=SecretKey
Copy URL

Request

JSON Body/Payload

Content-Type: application/json

{
  "FromDate": "2018-08-25",
  "ToDate": "2018-09-25",
  "Users": [
    "bhargavi.tasknew14@mailinator.com",
    "User.25090@mailinator.com"
  ],
  "Paging": {
    "PageIndex": 1,
    "PageSize": 200
  }
}

JSON Properties

Parameter Description
FromDate

Starting date to retrieve to-dos from.
ToDate

End date you want to retrieve to-dos till.
Users

You can pass multiple user email addresses 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": "ec274833-c0c9-11e8-a43f-02742c1c8abe",
      "Name": "Meeting:",
      "Description": "",
      "RelatedEntity": 0,
      "DueDate": "/Date(1537905600000+0000)/",
      "Reminder": 15,
      "NotifyBy": "1100",
      "OwnerId": "8fce0bee-a46a-11e8-a43f-02742c1c8abe",
      "OwnerName": "Anu.tasknew14",
      "CreatedBy": "8371b49f-a465-11e8-aa96-0258598489d8",
      "CreatedByName": "Bhargavi.tasknew14",
      "CreatedOn": "/Date(1537883411000+0000)/",
      "ModifiedBy": "8371b49f-a465-11e8-aa96-0258598489d8",
      "ModifiedByName": "Bhargavi.tasknew14",
      "ModifiedOn": "/Date(1537883411000+0000)/",
      "RelatedEntityIdName": "",
      "CompletedOn": "/Date(-62135596800000+0000)/",
      "UserTaskAutoId": "T10062",
      "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": "Anu.tasknew14@mailinator.com",
      "RelatedEntityIdSchemaName": "Phone",
      "HasUpdatePermission": true,
      "HasDeletePermission": true,
      "TaskTypeId": "856d14cd-a465-11e8-a43f-02742c1c8abe",
      "Location": "",
      "EndDate": "2018-09-25 20:30:00",
      "PercentCompleted": 0,
      "Priority": "",
      "CustomFields": {},
      "ReminderBeforeDays": 0,
      "EffortEstimateUnit": ""
    },
    {
      "UserTaskId": "c0c3502f-c0c9-11e8-a43f-02742c1c8abe",
      "Name": "Meeting:",
      "Description": "",
      "RelatedEntity": 0,
      "DueDate": "/Date(1537898400000+0000)/",
      "Reminder": 15,
      "NotifyBy": "1100",
      "OwnerId": "8fce0bee-a46a-11e8-a43f-02742c1c8abe",
      "OwnerName": "Anu.tasknew14",
      "CreatedBy": "8371b49f-a465-11e8-aa96-0258598489d8",
      "CreatedByName": "Bhargavi.tasknew14",
      "CreatedOn": "/Date(1537883338000+0000)/",
      "ModifiedBy": "8371b49f-a465-11e8-aa96-0258598489d8",
      "ModifiedByName": "Bhargavi.tasknew14",
      "ModifiedOn": "/Date(1537883338000+0000)/",
      "RelatedEntityIdName": "",
      "CompletedOn": "/Date(-62135596800000+0000)/",
      "UserTaskAutoId": "T10061",
      "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": "Anu.tasknew14@mailinator.com",
      "RelatedEntityIdSchemaName": "Phone",
      "HasUpdatePermission": true,
      "HasDeletePermission": true,
      "TaskTypeId": "856d14cd-a465-11e8-a43f-02742c1c8abe",
      "Location": "",
      "EndDate": "2018-09-25 18: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.