GET api/todo/getleads?branchId={branchId}&excludeTasks={excludeTasks}
Get the list of all InboundLead ToDo's
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| branchId | integer |
None. |
|
| excludeTasks | boolean |
Default value is False |
Body Parameters
None.
Response Information
Resource Description
PagedCollectionDataContractOfDezrez.Core.DataContracts.External.Api.ToDo.Query.ActiveToDoDataContract| Name | Description | Type | Additional information |
|---|---|---|---|
| TotalCount | integer |
None. |
|
| CurrentCount | integer |
None. |
|
| PageSize | integer |
None. |
|
| PageNumber | integer |
None. |
|
| Collection | Collection of Dezrez.Core.DataContracts.External.Api.ToDo.Query.ActiveToDoDataContract |
None. |
Response Formats
application/json, text/json
Sample:
{
"TotalCount": 1,
"CurrentCount": 2,
"PageSize": 1,
"PageNumber": 1,
"Collection": [
{
"ToDoOwner": {
"Email": {
"Type": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Value": "sample string 1",
"Notes": "sample string 2",
"ContactOrder": 3,
"AllowContact": true,
"MarketingContactStatus": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Name": "sample string 5",
"Id": 6
},
"ContactName": "sample string 1",
"FirstName": "sample string 2",
"LastName": "sample string 3",
"Id": 4
},
"Interval": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Title": "sample string 1",
"Description": "sample string 2",
"Priority": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Negotiators": [
{
"Email": {
"Type": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Value": "sample string 1",
"Notes": "sample string 2",
"ContactOrder": 3,
"AllowContact": true,
"MarketingContactStatus": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Name": "sample string 5",
"Id": 6
},
"ContactName": "sample string 1",
"FirstName": "sample string 2",
"LastName": "sample string 3",
"Id": 4
},
{
"Email": {
"Type": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Value": "sample string 1",
"Notes": "sample string 2",
"ContactOrder": 3,
"AllowContact": true,
"MarketingContactStatus": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Name": "sample string 5",
"Id": 6
},
"ContactName": "sample string 1",
"FirstName": "sample string 2",
"LastName": "sample string 3",
"Id": 4
}
],
"Tasks": [
{
"Id": 1,
"DueDate": "2024-10-30T15:16:46.8389339Z",
"StatusType": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"ScheduleType": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Event": {
"Name": "sample string 1",
"Description": "sample string 2",
"DateTime": "2024-10-30T15:16:46.8389339Z",
"EventCategory": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"EventType": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"EventStatus": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Id": 4
},
"TeamIds": [
1,
2
],
"SearchTerms": [
"sample string 1",
"sample string 2"
]
},
{
"Id": 1,
"DueDate": "2024-10-30T15:16:46.8389339Z",
"StatusType": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"ScheduleType": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Event": {
"Name": "sample string 1",
"Description": "sample string 2",
"DateTime": "2024-10-30T15:16:46.8389339Z",
"EventCategory": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"EventType": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"EventStatus": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Id": 4
},
"TeamIds": [
1,
2
],
"SearchTerms": [
"sample string 1",
"sample string 2"
]
}
],
"ToDoType": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"SuggestedSchedule": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"EventType": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Id": 3
},
{
"ToDoOwner": {
"Email": {
"Type": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Value": "sample string 1",
"Notes": "sample string 2",
"ContactOrder": 3,
"AllowContact": true,
"MarketingContactStatus": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Name": "sample string 5",
"Id": 6
},
"ContactName": "sample string 1",
"FirstName": "sample string 2",
"LastName": "sample string 3",
"Id": 4
},
"Interval": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Title": "sample string 1",
"Description": "sample string 2",
"Priority": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Negotiators": [
{
"Email": {
"Type": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Value": "sample string 1",
"Notes": "sample string 2",
"ContactOrder": 3,
"AllowContact": true,
"MarketingContactStatus": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Name": "sample string 5",
"Id": 6
},
"ContactName": "sample string 1",
"FirstName": "sample string 2",
"LastName": "sample string 3",
"Id": 4
},
{
"Email": {
"Type": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Value": "sample string 1",
"Notes": "sample string 2",
"ContactOrder": 3,
"AllowContact": true,
"MarketingContactStatus": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Name": "sample string 5",
"Id": 6
},
"ContactName": "sample string 1",
"FirstName": "sample string 2",
"LastName": "sample string 3",
"Id": 4
}
],
"Tasks": [
{
"Id": 1,
"DueDate": "2024-10-30T15:16:46.8389339Z",
"StatusType": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"ScheduleType": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Event": {
"Name": "sample string 1",
"Description": "sample string 2",
"DateTime": "2024-10-30T15:16:46.8389339Z",
"EventCategory": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"EventType": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"EventStatus": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Id": 4
},
"TeamIds": [
1,
2
],
"SearchTerms": [
"sample string 1",
"sample string 2"
]
},
{
"Id": 1,
"DueDate": "2024-10-30T15:16:46.8389339Z",
"StatusType": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"ScheduleType": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Event": {
"Name": "sample string 1",
"Description": "sample string 2",
"DateTime": "2024-10-30T15:16:46.8389339Z",
"EventCategory": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"EventType": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"EventStatus": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Id": 4
},
"TeamIds": [
1,
2
],
"SearchTerms": [
"sample string 1",
"sample string 2"
]
}
],
"ToDoType": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"SuggestedSchedule": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"EventType": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Id": 3
}
]
}