List Action Items

Get a list of action items. The returned data includes Action item details and linked entities.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
^(eq|in):.+$

Filters records by using a query string on the field client.id.

Supports comparison operators eq, in.

Operator semantics:

  • eq — Exact match. Default when no operator prefix is supplied.
  • in — Matches any value in a comma-separated list.

Query examples:

filter[client.id]=0d3e7d0k-241a-461r-av15-758a90d70283

filter[client.id]=eq:0d3e7d0k-241a-461r-av15-758a90d70283

filter[client.id]=in:0d3e7d0k-241a-461r-av15-758a90d70283,1a2b3c4d-5e6f-7a8b-9c0d-e1f2a3b4c5d6

string
^(eq):.+$

Filters records by using a query string on the field is_completed.

Supports comparison operators eq.

Operator semantics:

  • eq — Exact match. Default when no operator prefix is supplied.

Query examples:

filter[is_completed]=true

filter[is_completed]=eq:true

string
^(eq):.+$

Filters records by using a query string on the field is_overdue.

Supports comparison operators eq.

Operator semantics:

  • eq — Exact match. Default when no operator prefix is supplied.

Query examples:

filter[is_overdue]=true

filter[is_overdue]=eq:true

string
^(eq|in):.+$

Filters records by using a query string on the field status.

Supports comparison operators eq, in.

Operator semantics:

  • eq — Exact match. Default when no operator prefix is supplied.
  • in — Matches any value in a comma-separated list.

Query examples:

filter[status]=example_string

filter[status]=eq:example_string

filter[status]=in:example_string,another_string

Available values: Upcoming, Overdue, Completed.

string

IANA timezone the statuses are evaluated in, deciding when a due day has ended.
A task is Upcoming throughout its due day in this timezone and Overdue once that day
ends. Defaults to UTC when omitted.

Free-text search over the task title and the name of the client the task belongs to.
Matched as a case-insensitive substring; the value is taken literally, with no operator prefix.

string
^(eq|in):.+$

Filters records by using a query string on the field assigned_user_ids.

Supports comparison operators eq, in.

Operator semantics:

  • eq — Exact match. Default when no operator prefix is supplied.
  • in — Matches any value in a comma-separated list.

Query examples:

filter[assigned_user_ids]=0d3e7d0k-241a-461r-av15-758a90d70283

filter[assigned_user_ids]=eq:0d3e7d0k-241a-461r-av15-758a90d70283

filter[assigned_user_ids]=in:0d3e7d0k-241a-461r-av15-758a90d70283,1a2b3c4d-5e6f-7a8b-9c0d-e1f2a3b4c5d6

string
^(eq|in):.+$

Filters records by using a query string on the field created_by_user_id.

Supports comparison operators eq, in.

Operator semantics:

  • eq — Exact match. Default when no operator prefix is supplied.
  • in — Matches any value in a comma-separated list.

Query examples:

filter[created_by_user_id]=0d3e7d0k-241a-461r-av15-758a90d70283

filter[created_by_user_id]=eq:0d3e7d0k-241a-461r-av15-758a90d70283

filter[created_by_user_id]=in:0d3e7d0k-241a-461r-av15-758a90d70283,1a2b3c4d-5e6f-7a8b-9c0d-e1f2a3b4c5d6

string
^(eq):.+$

Filters records by using a query string on the field is_unassigned.

Supports comparison operators eq.

Operator semantics:

  • eq — Exact match. Default when no operator prefix is supplied.

Query examples:

filter[is_unassigned]=true

filter[is_unassigned]=eq:true

filter[client.segment_id]
array of strings

Narrows results to clients in any supplied segment. Repeat eq: for each segment, or use in: with a
comma-separated list. Use null:true to match clients with no segment; combined with ids it matches either.

filter[client.segment_id]
filter[client.vertical_id]
array of strings

Narrows results to clients in any supplied vertical. Repeat eq: for each vertical, or use in: with a
comma-separated list. Use null:true to match clients with no vertical; combined with ids it matches either.

filter[client.vertical_id]
filter[client.client_access_group_id]
array of strings

Narrows results to clients in any supplied client access group. Repeat eq: for each group, or use in: with
a comma-separated list. Use null:true to match clients with no access group; combined with ids it matches
either.

filter[client.client_access_group_id]
string
^[+-]?[a-z][a-z0-9_]*(\.[a-z][a-z0-9_]*)*(,[+-]?[a-z][a-z0-9_]*(\.[a-z][a-z0-9_]*)*)*$

One or more sortable fields, separated by commas. Prefix with '+' to sort ascending or '-' to sort descending.

Available fields: due_at, sort_rank

int32

The number of records to be returned in a single page

string

Opaque cursor of the page to return. Omit this value for the first
page, then pass the next_cursor value from the previous response.

  • Cursor pagination cannot guarantee atomicity.
  • Endpoints may skip new records inserted between paginated reads.
  • Endpoints may occasionally return duplicate records.
Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json