List pharmacogenomics reference values
pgx_list_referenceInspect gene symbols, gene-specific source results, CPIC levels, ClinPGx testing labels, recommendation classifications and input formats. phenotypes requires geneSymbol and preserves distinct activity-score rows, frequencies and consultation text. Live genes/phenotypes support paging; static topics return their complete vocabulary without upstream requests. Use returned values in subsequent discovery, diplotype and recommendation calls.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Positive safe-integer row limit; values above 100 are clamped to 100 with a notice (default 25). | |
| topic | Yes | genes lists source gene records; phenotypes requires geneSymbol and lists full gene-result rows; other topics return verified static vocabulary. | |
| offset | No | Zero-based offset; use nextOffset to continue (default 0). | |
| geneSymbol | No | Exact gene symbol; required for phenotypes, optional for genes, omit for static topics. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| cap | No | Effective public page limit. | |
| page | No | Source pagination metadata. | |
| error | No | Present when the call failed. Absent on success. | |
| items | No | Full live gene/result rows or complete static vocabulary entries. | |
| shown | No | Number of returned rows, equal to page.returned. | |
| notices | No | Notices about this result; empty when none apply. | |
| truncated | No | Whether more matching rows remain after this page. | |
| provenance | No | Live access provenance or static verification provenance. | |
| effectiveQuery | No | Normalized topic, gene selector and effective paging. |