Skip to main content
GET
Get catalog

Authorizations

Authorization
string
header
required

Environment AUTH_KEY. Full ledger access and primary API-key administration. Not OAuth or JWT.

Query Parameters

category
enum<string>

Exactly one parameter; booleans are true/false, arrays are comma-separated. Empty values are rejected.

Available options:
overview,
nutrients,
lab_panels,
lab_analytes,
measurements,
record_schemas
panel_key
string

Exactly one parameter; booleans are true/false, arrays are comma-separated. Empty values are rejected.

Required string length: 1 - 100
group_key
string

Exactly one parameter; booleans are true/false, arrays are comma-separated. Empty values are rejected.

Required string length: 1 - 100
field_path
string

Exactly one parameter; booleans are true/false, arrays are comma-separated. Empty values are rejected.

Required string length: 1 - 200
Pattern: ^(?:\/(?:[^~\/]|~[01])*)+$
key
string

Exactly one parameter; booleans are true/false, arrays are comma-separated. Empty values are rejected.

Required string length: 1 - 100
query
string

Exactly one parameter; booleans are true/false, arrays are comma-separated. Empty values are rejected.

Required string length: 1 - 100
include_schema
boolean

Exactly one parameter; booleans are true/false, arrays are comma-separated. Empty values are rejected.

limit
integer

Exactly one parameter; booleans are true/false, arrays are comma-separated. Empty values are rejected.

Required range: 1 <= x <= 100
cursor
string

Exactly one parameter; booleans are true/false, arrays are comma-separated. Empty values are rejected.

Required string length: 1 - 2000
catalog_version
string

Exactly one parameter; booleans are true/false, arrays are comma-separated. Empty values are rejected.

Required string length: 1 - 50

Response

Successful domain response

catalog_version
string
required
Allowed value: "1.0.4"
category
string
required
Allowed value: "overview"
response_variant
string
required
Allowed value: "overview"
categories
enum<string>[]
required
Maximum array length: 6
Available options:
overview,
nutrients,
lab_panels,
lab_analytes,
measurements,
record_schemas
record_types
enum<string>[]
required
Maximum array length: 8
Available options:
measurement,
nutrition,
hydration,
activity,
sleep,
checkin,
intake,
lab_result
counts
object
required
panel_keys
enum<string>[]
required
Maximum array length: 30
Available options:
cbc,
reticulocyte_hemoglobinopathy,
glycemic,
lipid,
renal_electrolytes,
urine_quantitative,
liver_protein,
thyroid,
iron_studies,
vitamins_minerals,
inflammation,
urinalysis,
coagulation,
cardiac_muscle,
pancreatic_digestive,
bone_metabolism,
pituitary_adrenal,
reproductive_hormones,
reproductive_semen,
immunology_autoimmune,
celiac,
infectious_serology,
microbiology_molecular,
stool_digestive,
tumor_markers,
therapeutic_drug_monitoring,
toxicology_metals,
blood_group_immunohematology,
specimen_quality,
blood_gas
nutrient_groups
object
required
measurement_groups
object
required
custom_analyte_policy
string
required
Required string length: 1 - 500
discovery_examples
object[]
required
openapi_path
string
required
Allowed value: "/openapi.json"
record_schema_path
string
required
Required string length: 1 - 100