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

# Search for projects by a given filter

`POST /projects/search`

Filterable fields and their allowed operators:

 Field | Allowed operators |
 --- | --- |
 `account_id` | `equals`, `in`, `not_in`, `is_set` |
 `status` | `equals`, `in`, `not_in` |
 `owner_id` | `equals`, `in`, `not_in`, `is_set`, `is_unset` |
 `is_archived` | `equals` |
 `created_at` | `time_is_after`, `time_is_before`, `time_range` |
 `updated_at` | `time_is_after`, `time_is_before`, `time_range` |

Timestamp values use RFC3339 format. Valid `status` values are `not_started`, `in_progress`, and `completed`. For custom fields, pass the field slug as `field`.

**Rate limit:** 20 requests per minute

## Request body

- SearchProjectsRequest
  - `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.
    - `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 projects to fetch. Defaults to 100. Must be greater than 0 and less than 1000.

## Response `200`

- SearchProjectsResponseBody
  - `data` Project[]
    - `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.
    - `archived_at` string — The archived at time of the project in RFC3339 format.
    - `created_at` string — The created at time of the project.
    - `custom_fields` object — Custom fields for this project, keyed by slug.
    - `customer_portal_visible` boolean — The customer portal visible of the project.
    - `description_html` string — The description of the project in HTML format.
    - `end_date` string — The end date of the project in RFC3339 format.
    - `id` string — The ID of the project.
    - `is_archived` boolean — Whether the project is archived.
    - `name` string — The name of the project.
    - `owner_id` string — The owner ID of the project.
    - `project_template` MiniProjectTemplate
      - `id` string — The ID of the project template.
    - `start_date` string — The start date of the project in RFC3339 format.
    - `updated_at` string — The updated at time of the project.
  - `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/revisions/cfd9e65e79bb/schema)