---
title: "Search Projects under an Organization."
method: GET
path: "/v1/projects:search"
tags: ["Projects"]
---

# Search Projects under an Organization.

`GET /v1/projects:search`

## Query parameters

- `query` string
- `page_size` integer
- `page_token` string

## Response `200`

A successful response.

- ListProjectsResponse — List of Projects and continuation token for pagination.
  - `projects` Project[] — Paginated list of Project resources.
    - `name` string — The resource name of the Project. Should match the pattern `projects/{project_id}`.
    - `display_name` string — A user defined name for the Project.
    - `oid` string
    - `state` 'STATE_ACTIVE' | 'STATE_INACTIVE' | 'STATE_ACTIVE_PENDING' — State represents represents if a Project or Connection is Active or Inactive on the data exchange networks. - STATE_ACTIVE: Represents a Project/Connection that is registered on the data exchange networks. - STATE_INACTIVE: Represents a Project that is either not registered, or not active on the data exchange networks. - STATE_ACTIVE_PENDING: Represents a Project that is pending registration on the data exchange networks.
    - `npi` string — National Provider Index for the Project.
    - `address` ProjectsV1alphaAddress — Address for the Project.
      - `line1` string
      - `line2` string
      - `city` string
      - `state` string
      - `postal_code` string
    - `create_time` string, date-time
    - `update_time` string, date-time
    - `commonwell_type` 'COMMONWELL_TYPE_PHARMACY' | 'COMMONWELL_TYPE_AMBULATORY' | 'COMMONWELL_TYPE_HOSPITAL' | 'COMMONWELL_TYPE_POSTACUTECARE' | 'COMMONWELL_TYPE_LABSYSTEMS' | 'COMMONWELL_TYPE_ACUTECARE' — CommonwellType is a network required ENUM and should be chosen as the value that closest resembles the treatment relation this entity has with its patients.
    - `is_obo` boolean — True if the Project is an OBO entity on at least one of the networks.
    - `epic_approval_status` string — Epic Approval Status of the Project.
    - `npi_type` string
  - `next_page_token` string — Token to retrieve the next page of results, or empty if there are no more results in the list.

## Other responses

- `400` — Returned when the request is malformed or missing required fields.
- `401` — Returned when the caller does not have permission to access the resource.
- `404` — Returned when the resource does not exist.
- `429` — Returned when the caller has exceeded the rate limit.
- `500` — Server error

---

[API](https://skmtc.net/particlehealth/apis/particle-health-api.md) · [All operations](https://skmtc.net/particlehealth/apis/particle-health-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/particlehealth/particle-health-api/revisions/5aead0b7515e/schema)