Get tasks and sales process steps
Returns the authenticated user's to-dos, or another viewable user's to-dos when filter[assignee] is provided. OAuth access tokens require the read scope. Date windows and facets use the assignee's Nutshell timezone.
Query parameters
User whose to-dos should be returned. Defaults to the authenticated user. View-restricted users may request only users they can view.
To-do types to include. Multiple values may be comma-separated.
Pipeline IDs whose related to-dos should be returned. Multiple values may be comma-separated.
[ "1-stagesets" ]
Nutshell report-period string, such as a YYYY-MM-DD date or +w2 for the next two weeks, interpreted in the assignee's Nutshell timezone. Ignored when a valid due window is also provided.
Server-defined due-date bucket, using the assignee's Nutshell timezone.
Fuzzy search on the task title or sales process step label.
Set to 1 to include completed to-dos with incomplete ones.
Set to 1 to return only completed to-dos, newest first. Takes precedence over includeComplete.
Set to 1 to include a done count and keep all facet counts independent of the selected date or completion filter.
Set to 0 to include to-dos without a due time.
Set to 1 to include only to-dos related to hot leads.
Set to 0 to allow multiple sales process steps for the same lead when single-step gating is active.
Zero-based index of the first row. When omitted for an unfiltered incomplete list, the server may center the first page around the overdue/today boundary.
Number of rows to return. Defaults to 100.
Inclusive zero-based index of the final row. When present, it determines the page size with page[startIndex].
Response
A page of to-dos and facet counts.
Example response
{
"todos": [
{
"id": "7-tasks",
"delays": [
{
"id": "1-delays"
}
]
}
]
}