API ReferenceapiclinicalGET /v1/lab-catalog/availability

GET /v1/lab-catalog/availability

Service: clinical · operationId: (none)

(marker, state) status lookup for the DIY panel builder.

Required scopes

(no scope declared — review service config)

Query parameters

  • state (string) required
  • marker_ids (string) required

Responses

200 Availability entries (one per requested marker)

{
  "type": "object",
  "properties": {
    "state": {
      "type": "string"
    },
    "entries": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "marker_id": {
            "type": "string"
          },
          "status": {
            "type": "string",
            "enum": [
              "available",
              "requires_byop",
              "available_via_byop",
              "unavailable"
            ]
          },
          "source_lab_id": {
            "type": [
              "string",
              "null"
            ]
          },
          "note": {
            "type": [
              "string",
              "null"
            ]
          }
        },
        "required": [
          "marker_id",
          "status",
          "source_lab_id",
          "note"
        ]
      }
    }
  },
  "required": [
    "state",
    "entries"
  ]
}

400 Validation error

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string"
    },
    "message": {
      "type": "string"
    }
  },
  "required": [
    "error",
    "message"
  ]
}

Example

curl -X GET https://clinical.platform.loop.health/v1/lab-catalog/availability \
  -H "Authorization: Bearer $ACCESS_TOKEN"