---
title: "Search for tasks by a given filter"
method: POST
path: "/tasks/search"
tags: ["tasks"]
---

# Search for tasks by a given filter

`POST /tasks/search`

Currently, the following fields are filterable for tasks:

* account_id. Allowed operators: `equals`, `in`, `not_in`, `is_set`

* project_id. Allowed operators: `equals`, `in`, `not_in`, `is_set`, `is_unset`

* status. Valid values are `["not_started", "in_progress", "completed"]`. Allowed operators: `equals`, `in`, `not_in`

* assignee_id. Allowed operators: `equals`, `in`, `not_in`, `is_set`

* milestone_id. Allowed operators: `equals`, `in`, `not_in`, `is_set`

* created_at (in RFC3339 format). Allowed operators: `time_is_after`, `time_is_before`, `time_range`

* due_date (in RFC3339 format). Allowed operators: `time_is_after`, `time_is_before`, `time_range`, `is_set`

* updated_at (in RFC3339 format). Allowed operators: `time_is_after`, `time_is_before`, `time_range`

* custom fields (pass in the slug of the custom field)

**Rate limit:** 20 requests per minute

## Request body

- SearchTasksRequest
  - `cursor` string — The cursor to use for pagination.
  - `filter` Filter
    - `field` string, required — The field for this filter. For allowed fields, see the documentation for the specific endpoint you are using. For non-compound filters (any operators other than "and" or "or"), Field must be set, along with either Value or Values, depending on the operator.
    - `operator` 'equals' | 'not_equals' | 'contains' | 'does_not_contain' | 'in' | 'not_in' | 'and' | 'or' | 'time_is_after' | 'time_is_before' | 'time_range' | 'string_contains' | 'string_does_not_contain' | 'is_set' | 'is_unset' | 'greater_than' | 'less_than' | 'greater_than_or_equals' | 'less_than_or_equals', required — The operator for this filter. `equals`: Matches objects that are exactly equal to the value in the field. `not_equals`: Matches objects that are not exactly equal to the value in the field. `contains`: For a multi-valued field, such as tags, this operator will match objects that contain any of the values in the field. `does_not_contain`: For a multi-valued field, such as tags, this operator will match objects that do not contain any of the values in the field. `in`: Matches objects if the field is one of several possible values, as specified in the values array. `not_in`: Matches objects if the field is none of several possible values, as specified in the values array. `and`: Matches objects only if all subfilters match. `or`: Matches objects if any subfilter matches. `time_is_after`: Matches objects if the field is after the given time. `time_is_before`: Matches objects if the field is before the given time. `time_range`: Matches objects if the field is between the given times. `string_contains`: Matches objects if the field contains the given string. `string_does_not_contain`: Matches objects if the field does not contain the given string. `is_set`: Matches objects if the field is set. `is_unset`: Matches objects if the field is unset. `greater_than`: Matches objects if the numeric field is greater than the given value. `less_than`: Matches objects if the numeric field is less than the given value. `greater_than_or_equals`: Matches objects if the numeric field is greater than or equal to the given value. `less_than_or_equals`: Matches objects if the numeric field is less than or equal to the given value.
    - `subfilters` Filter[] — Sub-filters for this filter. Valid only when operator is "and" or "or". The maximum allowed depth for a tree of filters is 3.
    - `value` string — The value for this filter. Only used for single-valued operators ("equals", "not_equals", "contains", "does_not_contain")
    - `values` string[] — The values for this filter. Only used for multi-valued operators ("in", "not_in").
  - `limit` integer — The number of tasks to fetch. Defaults to 100. Must be greater than 0 and less than 1000.

## Response `200`

- SearchTasksResponseBody
  - `data` Task[]
    - `account` MiniAccount
      - `external_ids` ExternalID[] — External IDs associated with the account.
        - `external_id` string — The external ID. Must be unique per object type (ex. account).
        - `label` string — The label of the external ID. Must be unique per object.
      - `id` string — The ID of the account.
    - `assignee` Actor
      - `contact` MiniContact
        - `email` string — The email of the contact.
        - `id` string — The ID of the contact.
      - `user` MiniUser
        - `email` string — The email of the user.
        - `id` string — The ID of the user.
    - `body_html` string — The body of the task in HTML format.
    - `created_at` string — The created at time of the task.
    - `custom_fields` object — Custom field values associated with the task, keyed by custom field slug.
    - `customer_portal_visible` boolean — The customer portal visible of the task.
    - `due_date` string — The due date of the task in RFC3339 format.
    - `external_issues` ExternalIssue[] — The external product issues associated with the task, if any.
      - `external_id` string — The external ID of the external issue. Jira: ID of the issue (autoincrementing number from 10000). GitHub: Owner/Repo/IssueID. Linear: ID of the issue (UUID). Asana: ID of the task (Long number).
      - `link` string — Link to the product issue.
      - `source` string — The source of the external issue.
    - `id` string — The ID of the task.
    - `milestone` MiniMilestone
      - `id` string — The ID of the milestone.
    - `parent_task_id` string — The ID of the parent task, if this is a subtask.
    - `project` MiniProject
      - `id` string — The ID of the project.
    - `status` string
    - `subtask_ids` string[] — The IDs of subtasks belonging to this task.
    - `title` string — The title of the task.
    - `updated_at` string — The updated at time of the task.
  - `pagination` Pagination
    - `cursor` string, required — The cursor for the next page of results.
    - `has_next_page` boolean, required — Indicates if there is a next page of results.
  - `request_id` string

## Other responses

- `400` — The request was invalid or could not be completed.

---

[API](https://skmtc.net/usepylon/apis/pylon-api.md) · [All operations](https://skmtc.net/usepylon/apis/pylon-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/usepylon/pylon-api/versions/999c51740b4e/schema)