Skip to main content

Get Lab Visit (v1)

Method & Path

GET /api/v1/workspace/:workspaceId/labs/visits/:labVisitId

Actual backend path: /v1/workspace/:workspaceId/labs/visits/:labVisitId

Description

Get a single lab visit by its ID.

Authentication

Required: JWT token in Authorization header

Persona Access:

  • Admin: Not applicable (workspace-scoped endpoint)
  • Workspace Owner: Allowed
  • Staff: Allowed (role-based)
  • Customer: Not allowed

Required Permissions:

  • labs.view

Headers

HeaderTypeRequiredDescription
AuthorizationstringYesBearer token: Bearer <token>

Path Parameters

ParameterTypeRequiredDescription
workspaceIdstringYesWorkspace identifier (MongoDB ObjectId)
labVisitIdstringYesLab visit identifier (MongoDB ObjectId)

Response 200 OK

{
"labVisit": {
"id": "507f1f77bcf86cd799439011",
"workspaceId": "507f1f77bcf86cd799439012",
"clientId": "507f1f77bcf86cd799439013",
"labVisitType": "at-home",
"labVisitStatus": "ready",
"labTestIds": [101],
"labTestSnapshots": [
{
"test": {
"testId": 101,
"testTitle": "CBC"
},
"designTest": {
"id": "507f1f77bcf86cd799439099",
"workspaceId": "507f1f77bcf86cd799439012",
"testId": 101,
"sections": [],
"commentRules": [],
"calculationsRules": [],
"deletedAt": null,
"createdAt": "2026-01-10T12:00:00.000Z",
"updatedAt": "2026-01-10T12:00:00.000Z"
}
}
],
"labTestResults": [],
"labVisitDate": "2026-01-10T12:00:00.000Z",
"labVisitNotes": "Take sample before breakfast",
"labVisitPricing": {
"labVisitSubtotal": 30,
"labCouponId": "507f1f77bcf86cd799439055",
"labCouponCode": "WINTER10",
"labVisitDiscountAmount": 3,
"labVisitTotal": 27
},
"deletedAt": null,
"createdAt": "2026-01-10T12:00:00.000Z",
"updatedAt": "2026-01-11T08:00:00.000Z"
}
}

Common Errors

401 Unauthorized: Missing or invalid authentication token

403 Forbidden: Insufficient permissions (labs.view required)

404 Not Found: Workspace or lab visit not found

422 Validation Error: Invalid workspace/lab visit ID format