Biomarkers

List biomarkers

Get a paginated list of biomarkers with optional filtering

get/api/v1/biomarkers

Request

  • Base URL: https://www.vitalsvault.com
  • URL: https://www.vitalsvault.com/api/v1/biomarkers
  • Auth: none declared

Query parameters

pageinteger

Page number for pagination

pageSizeinteger

Number of items per page

limitinteger

Alias for pageSize (cursor-friendly clients)

cursorstring

Opaque cursor from a previous next_cursor; takes precedence over page

sortBystring

Field to sort by

sortOrder'asc' | 'desc'

Sort order

searchstring

Search query

fieldsstring

Comma-separated list of fields to return, or 'minimal'/'card' for predefined sets

categorystring

Filter by category slug

gender'male' | 'female'

Filter by applicable gender

hasJunctionMappingboolean

Filter biomarkers with Junction Health integration

inPackagesstring

Comma-separated list of package slugs

Response

Successfully retrieved biomarkers

successboolean required

Indicates if the request was successful

Example response

{
  "data": {
    "data": [
      {
        "slug": "vitamin-d",
        "name": "Vitamin D (25-OH)",
        "loincCode": "25873-0",
        "unit": "ng/mL"
      }
    ]
  },
  "error": {
    "code": "NOT_FOUND",
    "message": "Resource not found"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.