Get tasks and sales process steps

get

https://app.nutshell.com/rest/todos

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 Params

filter[assignee]

string

^[0-9]+-users$

User whose to-dos should be returned. Defaults to the authenticated user. View-restricted users may request only users they can view.

filter[type]

array of strings

To-do types to include. Multiple values may be comma-separated.

filter[type]

Allowed:

filter[stagesets]

array of strings

Pipeline IDs whose related to-dos should be returned. Multiple values may be comma-separated.

filter[stagesets]

filter[dueTime]

string

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.

filter[dueWindow]

string

enum

Server-defined due-date bucket, using the assignee's Nutshell timezone.

Allowed:

string

Fuzzy search on the task title or sales process step label.

includeComplete

integer

enum

Defaults to 0

Set to 1 to include completed to-dos with incomplete ones.

Allowed:

onlyComplete

integer

enum

Defaults to 0

Set to 1 to return only completed to-dos, newest first. Takes precedence over includeComplete.

Allowed:

includeDoneFacet

integer

enum

Defaults to 0

Set to 1 to include a done count and keep all facet counts independent of the selected date or completion filter.

Allowed:

onlyDue

integer

enum

Defaults to 1

Set to 0 to include to-dos without a due time.

Allowed:

onlyHotLeads

integer

enum

Defaults to 0

Set to 1 to include only to-dos related to hot leads.

Allowed:

singleStep

integer

enum

Defaults to 1

Set to 0 to allow multiple sales process steps for the same lead when single-step gating is active.

Allowed:

page[startIndex]

integer

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.

page[limit]

integer

Defaults to 100

Number of rows to return. Defaults to 100.

page[endIndex]

integer

Inclusive zero-based index of the final row. When present, it determines the page size with page[startIndex].

Responses

401

Authentication required.

403

The credentials lack read scope, or the authenticated user cannot view the requested assignee's to-dos.

Language

Credentials

Basic

base64

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200A page of to-dos and facet counts.