List Test Samples (v1)

Method & Path

GET /api/v1/workspace/:workspaceId/labs/test-samples

Actual backend path: /v1/workspace/:workspaceId/labs/test-samples

Description

Get all test samples in a workspace. Test samples are sample types used for lab tests (e.g., Blood, Urine, Stool).

Authentication

Required: JWT token in Authorization header

Required Permissions:

• labs.view

Headers

Header	Type	Required	Description
Authorization	string	Yes	Bearer token: Bearer <token>

Path Parameters

Parameter	Type	Required	Description
workspaceId	string	Yes	Workspace identifier (MongoDB ObjectId)

Query Parameters

Parameter	Type	Required	Description
includeDeleted	boolean	No	Include deleted test samples (default: false)

Response 200 OK

{
  "testSamples": [
    {
      "id": "507f1f77bcf86cd799439011",
      "workspaceId": "507f1f77bcf86cd799439012",
      "sampleTypeTitle": "Blood",
      "createdAt": "2025-01-15T10:00:00.000Z",
      "updatedAt": "2025-01-15T10:00:00.000Z",
      "deletedAt": null
    }
  ]
}

Common Errors

401 Unauthorized: Missing or invalid authentication token

403 Forbidden: Insufficient permissions (labs.view required)

404 Not Found: Workspace not found

422 Validation Error: Invalid workspace ID format