POST api/list/todos?pageSize={pageSize}&pageNumber={pageNumber}

Get list of todos

Request Information

URI Parameters

Name	Description	Type	Additional information
pageSize		integer	Default value is 20
pageNumber		integer	Default value is 1

Body Parameters

Dezrez.Core.DataContracts.External.Api.Lists.Todos.Filter.TodoListFilterDataContract

Name	Type	Additional information
FilterCategory	string	None.
IncludeGlobal	boolean	None.
OnlyGlobal	boolean	None.
OwningNegotiatorId	integer	None.
NegotiatorIds	Collection of integer	None.
Statuses	Collection of string	None.
ToDoTypes	Collection of string	None.
Schedules	Collection of string	None.
Priorities	Collection of string	None.
Intervals	Collection of string	None.
DateTo	date	None.
DateFrom	date	None.
Date	Dezrez.Core.DataContracts.External.Api.Lists.DateRangeFilterDataContract	None.
Sort	Dezrez.Core.DataContracts.External.Api.Lists.Todos.TodoListSort	None.
AdditionalIds	Collection of integer	None.
ExcludedIds	Collection of integer	None.
Name	string	None.
CustomFilterConfig	string	None.
BranchId	integer	None.
BranchIds	Collection of integer	None.
EventBranchIds	Collection of integer	None.
Order	Dezrez.Core.DataContracts.External.Api.Lists.ListOrder	None.
SearchTerm	string	None.
FilterType	Dezrez.Core.DataContracts.External.Api.System.EnumDataContract	None.
ShowDeleted	boolean	None.
ShowCancelled	boolean	None.
OwningTeamId	integer	None.
Id	integer	None.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

application/json, text/json

Sample:

{
  "FilterCategory": "sample string 1",
  "IncludeGlobal": true,
  "OnlyGlobal": true,
  "OwningNegotiatorId": 1,
  "NegotiatorIds": [
    1,
    2
  ],
  "Statuses": [
    "sample string 1",
    "sample string 2"
  ],
  "ToDoTypes": [
    "sample string 1",
    "sample string 2"
  ],
  "Schedules": [
    "sample string 1",
    "sample string 2"
  ],
  "Priorities": [
    "sample string 1",
    "sample string 2"
  ],
  "Intervals": [
    "sample string 1",
    "sample string 2"
  ],
  "DateTo": "2024-10-30T15:16:38.5929345Z",
  "DateFrom": "2024-10-30T15:16:38.5929345Z",
  "Date": {
    "FromStaticDate": "2024-10-30T15:16:38.5929345Z",
    "ToStaticDate": "2024-10-30T15:16:38.5929345Z",
    "PredefinedDateRange": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "FromExpression": "sample string 1",
    "ToExpression": "sample string 2",
    "Id": 3
  },
  "Sort": 0,
  "AdditionalIds": [
    1,
    2
  ],
  "ExcludedIds": [
    1,
    2
  ],
  "Name": "sample string 4",
  "CustomFilterConfig": "sample string 5",
  "BranchId": 1,
  "BranchIds": [
    1,
    2
  ],
  "EventBranchIds": [
    1,
    2
  ],
  "Order": 0,
  "SearchTerm": "sample string 6",
  "FilterType": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "ShowDeleted": true,
  "ShowCancelled": true,
  "OwningTeamId": 9,
  "Id": 10
}

Response Information

Resource Description

PagedCollectionDataContractOfDezrez.Core.DataContracts.External.Api.Lists.Todos.TodoListDataContract

Name	Type	Additional information
TotalCount	integer	None.
CurrentCount	integer	None.
PageSize	integer	None.
PageNumber	integer	None.
Collection	Collection of Dezrez.Core.DataContracts.External.Api.Lists.Todos.TodoListDataContract	None.

Response Formats

application/json, text/json

Sample:

{
  "TotalCount": 1,
  "CurrentCount": 2,
  "PageSize": 1,
  "PageNumber": 1,
  "Collection": [
    {
      "ToDoOwner": {
        "ContactName": "sample string 1",
        "Gender": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "Title": "sample string 2",
        "FirstName": "sample string 3",
        "LastName": "sample string 4",
        "PrimaryTelephone": {
          "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
        },
        "PrimaryEmail": {
          "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
        },
        "JobTitle": "sample string 5",
        "Id": 6
      },
      "Title": "sample string 1",
      "Description": "sample string 2",
      "Negotiators": [
        {
          "ContactName": "sample string 1",
          "Gender": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Title": "sample string 2",
          "FirstName": "sample string 3",
          "LastName": "sample string 4",
          "PrimaryTelephone": {
            "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
          },
          "PrimaryEmail": {
            "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
          },
          "JobTitle": "sample string 5",
          "Id": 6
        },
        {
          "ContactName": "sample string 1",
          "Gender": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Title": "sample string 2",
          "FirstName": "sample string 3",
          "LastName": "sample string 4",
          "PrimaryTelephone": {
            "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
          },
          "PrimaryEmail": {
            "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
          },
          "JobTitle": "sample string 5",
          "Id": 6
        }
      ],
      "Interval": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "Priority": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "SuggestedSchedule": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "ToDoType": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "Tasks": [
        {
          "Id": 1,
          "DueDate": "2024-10-30T15:16:38.5929345Z",
          "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:38.5929345Z",
            "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:38.5929345Z",
          "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:38.5929345Z",
            "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"
          ]
        }
      ],
      "CompletedTasks": 3,
      "PendingTasks": 4,
      "TotalTasks": 5,
      "Id": 6
    },
    {
      "ToDoOwner": {
        "ContactName": "sample string 1",
        "Gender": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "Title": "sample string 2",
        "FirstName": "sample string 3",
        "LastName": "sample string 4",
        "PrimaryTelephone": {
          "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
        },
        "PrimaryEmail": {
          "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
        },
        "JobTitle": "sample string 5",
        "Id": 6
      },
      "Title": "sample string 1",
      "Description": "sample string 2",
      "Negotiators": [
        {
          "ContactName": "sample string 1",
          "Gender": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Title": "sample string 2",
          "FirstName": "sample string 3",
          "LastName": "sample string 4",
          "PrimaryTelephone": {
            "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
          },
          "PrimaryEmail": {
            "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
          },
          "JobTitle": "sample string 5",
          "Id": 6
        },
        {
          "ContactName": "sample string 1",
          "Gender": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Title": "sample string 2",
          "FirstName": "sample string 3",
          "LastName": "sample string 4",
          "PrimaryTelephone": {
            "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
          },
          "PrimaryEmail": {
            "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
          },
          "JobTitle": "sample string 5",
          "Id": 6
        }
      ],
      "Interval": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "Priority": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "SuggestedSchedule": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "ToDoType": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "Tasks": [
        {
          "Id": 1,
          "DueDate": "2024-10-30T15:16:38.5929345Z",
          "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:38.5929345Z",
            "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:38.5929345Z",
          "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:38.5929345Z",
            "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"
          ]
        }
      ],
      "CompletedTasks": 3,
      "PendingTasks": 4,
      "TotalTasks": 5,
      "Id": 6
    }
  ]
}