Skip to content
Dharini
Search
Ctrl
K
Cancel
GitHub
Select theme
Dark
Light
Auto
Introduction
User Guide
Overview
Getting Started
Team Admin Guide
Field Collector Guide
Lab Technician Guide
Dashboards & Analysis
GeoLens
SNP Analysis
Troubleshooting Guide
Administrator Guide
Administrator Guide
Database Setup
Environment Variables
CI/CD with GitHub Actions
Mobile App
Nginx Configuration
Production Setup
Troubleshooting
Reference
Reference
Platform Architecture
Data Standards & Ontology Reference
Product Requirements & Specifications
Software Requirements & Specifications
API Reference
Overview
Health
Health check endpoint for uptime monitoring
Auth
AuthController_loginUnified
AuthController_login
AuthController_loginWithPhone
AuthController_verify
AuthController_resendEmailOtp
AuthController_resendPhoneOtp
AuthController_signup
AuthController_verifySignup
User
UserController_profile
UserController_updateProfile
UserController_lookup
UserController_findSuperAdmins
UserController_createSuperAdmin
UserController_removeSuperAdmin
UserController_updateSuperAdmin
UserController_findAll
UserController_create
UserController_findOne
UserController_remove
UserController_update
Projects
ProjectsController_findAll
ProjectsController_create
ProjectsController_statistics
ProjectsController_exportProjects
ProjectsController_getProjectDetails
ProjectsController_getProjectTeamProgress
ProjectsController_getProjectTeamActivityProgress
ProjectsController_getProjectTeamMemberActivity
ProjectsController_getProjectTeamMemberActivityExport
ProjectsController_getProjectTeamMemberProgress
ProjectsController_getProjectTeamMemberProgressExport
ProjectsController_findAllSites
ProjectsController_getSitesStatisticsByStatus
ProjectsController_getMembers
ProjectsController_getProjectTeamUsers
ProjectsController_getProjectTeamUserRoles
ProjectsController_updateProjectTeamUserRole
ProjectsController_findOne
ProjectsController_update
ProjectsController_findSites
Create Site
ProjectsController_getNearbyLocations
ProjectsController_findSite
ProjectsController_updateSite
Visit Summary for Site
ProjectsController_findById
ProjectsController_updateVisit
ProjectsController_getVisits
ProjectsController_createVisit
ProjectsController_rescheduleVisit
ProjectsController_submitVisit
ProjectsController_findAllSamples
Create Sample
Validate Barcode
ProjectsController_getLabTests
ProjectsController_createLabTest
ProjectsController_updateLabTest
ProjectsController_getLabTest
ProjectsController_getMaxRound
ProjectsController_getLabTestStats
Get samples that can be pooled with the given sample
Edit collected sample details
Edit sample details for a lab workflow stage
ProjectsController_findOneSample
ProjectsController_updateSample
Create Team Member
ProjectsController_findAllTeams
Create Team
ProjectsController_addMembersList
ProjectsController_removeMembersList
ProjectsController_getTeamRoles
ProjectsController_getTeamMembers
ProjectsController_findTeam
ProjectsController_updateTeam
ProjectsController_removeMember
ProjectsController_updateMember
ProjectsController_getTeamMembersFieldView
ProjectsController_getTeamActivityOverview
ProjectsController_getTeamMembersVisitActivity
ProjectsController_uploadSampleDataScript
Sites
SitesController_findAll
Disease
DiseaseController_findAll
DiseaseController_create
DiseaseController_findOne
DiseaseController_update
Invites
InvitesController_inviteToWorkspace
InvitesController_inviteAccept
InvitesController_getInviteByToken
InvitesController_getInvites
Roles
RolesController_findAll
Access
AccessController_findOne
AccessController_update
SurveillanceType
SurveillanceTypeController_findAll
SurveillanceTypeController_create
SurveillanceTypeController_findOne
SurveillanceTypeController_update
Location
LocationController_findAll
LocationController_create
LocationController_findOne
LocationController_update
LocationController_uploadExcelFile
species
Get all active species
Create a new species
Get a species by id
Delete a species
Update a species
SampleType
SampleTypeController_findAll
SampleTypeController_create
SampleTypeController_findOne
SampleTypeController_update
samples
List all animals recorded at a site
Region
RegionController_findAll
RegionController_create
RegionController_findAllRegionsForInProject
RegionController_findOne
RegionController_update
RegionController_uploadExcelFileDistrict
RegionController_uploadExcelFileState
Media
MediaController_uploadImages
MediaController_getSignedUrl
Statistics
StatisticsController_getSiteOnDisease
StatisticsController_getSampleStatLogistics
StatisticsController_sieWiseSampleBreakDown
StatisticsController_exploreSites
StatisticsController_getMostPositive
StatisticsController_getDiseaseWiseSample
StatisticsController_exportSieWiseSampleBreakDown
StatisticsController_getProjectStats
StatisticsController_getMonitorDashboardStats
StatisticsController_getSiteWiseAnalysis
StatisticsController_getDiseaseWiseAnalysis
StatisticsController_getSampleWiseAnalysis
StatisticsController_getHomeLast30Days
StatisticsController_getProjectSampleTypes
StatisticsController_getProjectComparison
StatisticsController_getSiteComparison
StatisticsController_getSampleTypeComparison
Kit
KitController_findAll
KitController_create
KitController_findOne
KitController_update
Search
SearchController_globalSearch
GeoLens
Get all unique wetland states
Get wetlands filtered by state/district
Get wetlands in CSV-compatible format (for frontend)
Get poultry farms, optionally by state
Get all poultry farms in CSV-compatible format
Get cattle markets, optionally by state
Get water boundaries as GeoJSON (optionally filtered by bbox)
Get simplified water boundaries (ST_Simplify) for faster map rendering
Get sites the caller can see, with locations
Get all diseases
Get eBird observations from backend proxy
Get current weather from backend proxy
Get historical weather from backend proxy
ML predictions
Whether ML predictions are enabled, and which models are loaded
Bird migration predictions (species, maps, seasons)
Livestock disease models available (LSD today)
One disease model
Disease risk at up to 50 locations on a date
Sequencing
SequencingController_presignUpload
SequencingController_searchLabSamples
SequencingController_getNcbiPreview
SequencingController_getPipelines
SequencingController_getQueue
SequencingController_submitJob
SequencingController_getAllJobs
SequencingController_getArtifactUrl
SequencingController_retryJob
SequencingController_getJobProgress
SequencingController_getJobVariants
SequencingController_getJobArtifacts
SequencingController_getJob
SequencingController_getAllSubmissions
SequencingController_getSubmission
PipelineWebhook
PipelineWebhookController_handleWebhook
Purge
Purge a sample and all its cascading dependencies
Purge a visit and all its cascading dependencies
Purge a site and all its cascading dependencies
Purge a project and all its cascading dependencies
Workspaces
WorkspacesController_findMine
WorkspacesController_create
WorkspacesController_findOne
WorkspacesController_update
WorkspacesController_findProjects
WorkspacesController_createProject
WorkspacesController_findMembers
WorkspacesController_addMember
WorkspacesController_removeMember
WorkspacesController_updateMember
DataImport
DataImportController_downloadTemplate
DataImportController_uploadCollection
DataImportController_uploadLab
GitHub
Select theme
Dark
Light
Auto
WorkspacesController_findMine
GET
/workspaces
Authorizations
Section titled “Authorizations ”
bearer
Responses
Section titled “ Responses ”
200
Section titled “200 ”
Select media type
application/json
object