GET api/todo/getall?pageSize={pageSize}&pageNumber={pageNumber}
Get the list of all ToDo's if no parameter is sent; if provided will filter by ToDo type Processes this default to do API request. The parameter and response sections describe the data exchanged with the API.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| FilterCategory |
The filter category value. |
string |
None. |
| ToDoType |
The to do type value. |
string |
None. |
| BranchId |
The unique identifier of the related branch resource. |
integer |
None. |
| NegotiatorIds |
The unique identifiers of the related negotiator resources. |
Collection of integer |
None. |
| pageSize |
The page size value supplied with the request. |
integer |
Default value is 100 |
| pageNumber |
The page number value supplied with the request. |
integer |
Default value is 1 |
Body Parameters
None.
Response Information
Resource Description
The response returned after the operation completes.
PagedCollectionDataContractOfActiveToDoDataContract| Name | Description | Type | Additional information |
|---|---|---|---|
| TotalCount |
The total count value. |
integer |
None. |
| CurrentCount |
The current count value. |
integer |
None. |
| PageSize |
The page size value. |
integer |
None. |
| PageNumber |
The page number value. |
integer |
None. |
| Collection |
The collection of collection. |
Collection of 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": "2026-08-05T00:21:39.888317Z",
"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": "2026-08-05T00:21:39.888317Z",
"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": "2026-08-05T00:21:39.888317Z",
"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": "2026-08-05T00:21:39.888317Z",
"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": "2026-08-05T00:21:39.888317Z",
"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": "2026-08-05T00:21:39.888317Z",
"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": "2026-08-05T00:21:39.888317Z",
"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": "2026-08-05T00:21:39.888317Z",
"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
}
]
}