---
title: "Get all samples matching keyword"
method: GET
path: "/samples"
tags: ["Samples"]
---

# Get all samples matching keyword

`GET /samples`

## Query parameters

- `direction` 'ASC' | 'DESC'
- `keyword` string
- `pageNumber` integer
- `pageSize` integer
- `projection` 'DETAILED' | 'ID' | 'META' | 'SUMMARY'
- `sortBy` 'sampleId' | 'sampleType'

## Response `200`

OK

- Sample[]
  - `copyNumberSegmentPresent` boolean
  - `patientId` string, required
  - `sampleId` string, required
  - `sampleType` 'BLOOD_NORMAL' | 'METASTATIC' | 'PRIMARY_BLOOD_TUMOR' | 'PRIMARY_SOLID_TUMOR' | 'RECURRENT_BLOOD_TUMOR' | 'RECURRENT_SOLID_TUMOR' | 'SOLID_NORMAL'
  - `sequenced` boolean
  - `studyId` string, required
  - `uniquePatientKey` string
  - `uniqueSampleKey` string

## Changes

- **2020-08-20** `579332e67218` — 1 info
  - endpoint added
- **2019-04-05** `df161d3dbe1b` — 1 breaking
  - api path removed without deprecation

[Change history](https://skmtc.dev/waldronlab/apis/cbioportal-web-public-api-beta/changes/samples/get.md)

---

[API](https://skmtc.dev/waldronlab/apis/cbioportal-web-public-api-beta.md) · [All operations](https://skmtc.dev/waldronlab/apis/cbioportal-web-public-api-beta/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/waldronlab/cbioportal-web-public-api-beta/revisions/99265965e66b/schema)