Skip to content
Docs

Retrieve patients matching the filters

GET
/query

Gets a query ticket containing streamed information about patients that match the given query

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
treatment

Acceptable requested fields for querying

Array<string>

A pipe-separated list of treatments to look for

Example 
Bone marrow transplant|Chemotherapy
primary_site

Acceptable requested fields for querying

Array<string>

A pipe-separated list of affected primary sites to look for

Example 
Adrenal gland|Bladder
drug_name

Acceptable requested fields for querying

Array<string>

A pipe-separated list of drug names to look for

Example 
FLUOROURACIL|LEUCOVORIN
chrom

Acceptable requested string for querying

string

A chromosome to search for variants within. This cannot be used with a geneParam, and must be of the format chr#:start-end

gene

Acceptable requested fields for querying

Array<string>

A gene name to search for variants within. This cannot be used with chrParam

Example 
ZYG11A
assembly

Acceptable requested string for querying

string

A genomic assembly to search for variants within.

Example 
hg38
page_size

Acceptable integer for querying

integer

The number of donors to return per page

Example 
10
page

Acceptable integer for querying

integer

The page number to grab

Example 
1
exclude_programs

Acceptable requested fields for querying

Array<string>

A list of programs that will be excluded from results

Example 
SYNTHETIC-1
genomic_data_types

Acceptable requested fields for querying

Array<string>

A list of genomic data types to include in the query. If value includes ‘any’, return any genomic data type.

Example 
genomes|variants
donors

Acceptable requested fields for querying

Array<string>
Example 
[
  "Bone marrow transplant",
  "Chemotherapy"
]

A list of submitter_donor_ids to include in the results

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Retrieved donor information

Media type application/json

Query response

object
summary

Summary statistics

object
results

Donors matching the query

array
next

URL to grab the next set of results

string
prev

URL to grab the previous set of results

string
Example generated
{
  "summary": {},
  "results": [
    "example"
  ],
  "next": "example",
  "prev": "example"
}

400

Section titled “400 ”

The request was not processed, as the request parameters did not adhere to the specification

Media type application/json
object
query
required

Error object container

object
error
required

Name/type of the error that occurred

string
message
required

Message explaining why the error occurred

string
query
required
object
error
message
Example 
{
  "query": {
    "error": "InvalidInput",
    "message": "FOO is not an acceptable field"
  }
}

404

Section titled “404 ”

The request was not processed, as the requested object was not found

Media type application/json
object
query
required

Error object container

object
error
required

Name/type of the error that occurred

string
message
required

Message explaining why the error occurred

string
query
required
object
error
message
Example 
{
  "query": {
    "error": "NotFound",
    "message": "The requested resource could not be located"
  }
}

5XX

Section titled “5XX ”

Unspecified server error encountered

Media type application/json
object
query
required

Error object container

object
error
required

Name/type of the error that occurred

string
message
required

Message explaining why the error occurred

string
Example 
{
  "query": {
    "error": "ServerError",
    "message": "An unspecified server error occurred"
  }
}