GuidesChangelogAPI Reference
API Reference

/api/v5/task/

get
https://percolate.com/api/v5/task/

Get a list of tasks.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
date-time

Filter by due_at date (inclusive).

date-time

Filter by due_at date (exclusive).

date-time

Filter by updated_at date (inclusive).

date-time

Filter by updated_at date (exclusive).

string

A CSV of unique task IDs to filter by.

string

A CSV of scope IDs to filter by.

boolean
Defaults to false

Look inside any child scopes in addition to the supplied ones.

string

Keyword values to search for in task search fields.

string

Keyword values to search for on task titles.

{metadataSearch}
object

This is a dynamic query parameter name, used to filter endpoint response by its metadata field. The {schemaFieldId} template represents the schema id and field name concatenated together by a dot (.). In effect, it expands to the sub-template {schema-id}.{schema-field-name}. The {schema-id} template is the UID of a schema. The {schema-field-name} template is a path separated by the forward slash (/) (to allow for representation of nested objects).
The value of the query parameter is a CSV of strings appropriate for the given metadata field.
Valid options are:
metadata.{schemaFieldId}: string
 has_metadata.{schemaFieldId}: true - Filter by the existence of a metadata field.
metadata.{schemaFieldId}.from: string (date) - Filter by a metadata date field (inclusive)
 metadata.{schemaFieldId}.to: string (date) - Filter by a metadata date field (exclusive).

See the examples for each valid option:
metadata.schema:1.live_date_range
 has_metadata.schema:1.live_date_range
metadata.schema:1.live_date_range/from
 metadata.schema:1.live_date_range/to

boolean

If true is specified, use request user's ID from session to filter.

integer

Limit the number of paginated results.

integer

A 0-based offset to adjust the pagination window.

string

A CSV of unique term IDs to filter by.

string
enum

Apply this to any method that supports sorting.

string
enum

Control order direction.

Allowed:
string

A CSV of assignee IDs to filter by.

boolean

Filter by assignment state.

boolean

Filter by due_at existing.

boolean

Filter complete or incomplete tasks.

string

A CSV of subject IDs to filter by.

string
enum

Filter by subject type.

Allowed:
string

Get tasks in the hierarchy of these campaigns.

Responses

Retry-After header

Updated over 2 years ago

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

Updated over 2 years ago