Skip to main content

List Organisms (v1)

Method & Path

GET /api/v1/workspace/:workspaceId/labs/organisms

Actual backend path: /v1/workspace/:workspaceId/labs/organisms

Description

Get all organisms in a workspace. Organisms are microorganisms or pathogens that can be identified in lab tests.

Authentication

Required: JWT token in Authorization header

Required Permissions:

  • labs.view

Headers

HeaderTypeRequiredDescription
AuthorizationstringYesBearer token: Bearer <token>

Path Parameters

ParameterTypeRequiredDescription
workspaceIdstringYesWorkspace identifier (MongoDB ObjectId)

Query Parameters

ParameterTypeRequiredDescription
includeDeletedbooleanNoInclude deleted organisms (default: false)

Response 200 OK

{
"organisms": [
{
"id": "507f1f77bcf86cd799439011",
"workspaceId": "507f1f77bcf86cd799439012",
"organismTitle": "Escherichia coli",
"organismAbbr": "E. coli",
"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