List Units

GET

api

units

curl --url 'https://anivahealth.com/api/v1/units' \
  --header 'x-api-key: YOUR_API_KEY'

[
  {
    "id": 1,
    "title": "nmol/L",
    "display_title": null,
    "aliases": ["nmol/l"],
    "unit_type": "physical"
  },
  {
    "id": 2,
    "title": "mmol/L",
    "display_title": null,
    "aliases": ["mmol/l", "millimol/L"],
    "unit_type": "physical"
  },
  {
    "id": 47,
    "title": "ug/dL",
    "display_title": "µg/dL",
    "aliases": ["µg/dL", "mcg/dL"],
    "unit_type": "physical"
  }
]

Returns the catalog of measurement units. The numeric id is stable across renames — store it when persisting result data so display titles can be refreshed without breaking referential integrity. You’ll receive unit_id references in result payloads (Get Results) and on each biomarker’s default unit (List Biomarkers). Use this endpoint to dereference those IDs into a current display title.

Response

Returns an array of units.

number

Stable measurement unit identifier.

string

Canonical unit title (e.g. nmol/L).

string | null

Optional humanised display override. null means no override exists — render title as-is. Only populated when the canonical title (which prioritises machine-parseability) differs from the preferred UI form (e.g. ug/dL → µg/dL).

string[]

Alternative spellings and synonyms recognised for this unit (e.g. ["mmol/l", "millimol/L"]). Excludes the canonical title. Useful for matching free-text unit strings from external sources.

"physical" | "discrete"

physical for measurable quantities (e.g. nmol/L, mg). discrete for enumerated/categorical values (e.g. positive/negative).

Error responses

Status	Description
`403`	Forbidden — missing `panels_access` scope.
`500`	Internal server error.

curl --url 'https://anivahealth.com/api/v1/units' \
  --header 'x-api-key: YOUR_API_KEY'

[
  {
    "id": 1,
    "title": "nmol/L",
    "display_title": null,
    "aliases": ["nmol/l"],
    "unit_type": "physical"
  },
  {
    "id": 2,
    "title": "mmol/L",
    "display_title": null,
    "aliases": ["mmol/l", "millimol/L"],
    "unit_type": "physical"
  },
  {
    "id": 47,
    "title": "ug/dL",
    "display_title": "µg/dL",
    "aliases": ["µg/dL", "mcg/dL"],
    "unit_type": "physical"
  }
]

List Panels

List Locations

curl --url 'https://anivahealth.com/api/v1/units' \
  --header 'x-api-key: YOUR_API_KEY'

[
  {
    "id": 1,
    "title": "nmol/L",
    "display_title": null,
    "aliases": ["nmol/l"],
    "unit_type": "physical"
  },
  {
    "id": 2,
    "title": "mmol/L",
    "display_title": null,
    "aliases": ["mmol/l", "millimol/L"],
    "unit_type": "physical"
  },
  {
    "id": 47,
    "title": "ug/dL",
    "display_title": "µg/dL",
    "aliases": ["µg/dL", "mcg/dL"],
    "unit_type": "physical"
  }
]

Health

Profiles

Appointments

Home Kit Orders

Biomarkers

Panels

Units

Locations

Documents

Shipments

Response

Error responses

​Response

​Error responses

Response

Error responses