ProjectsController_getNearbyLocations

GET

/projects/{projectId}/sites/nearby

Authorizations

• bearer

Parameters

Path Parameters

projectId

required

string

Project UUID

Query Parameters

lat

required

number

lon

required

number

radius

required

number

Example

1000

Radius in meters to search for nearby sites

assignedTo

boolean

Example

true

farmType

Array<string>

Example

[
  "poultry farm",
  "cattle farm"
]

Filter sites by farm type

filterBy

string

Example

newest

Filter the sites by newest or status

Responses

200

object

success

required

boolean

message

required

string

data

required

Array<object>

object

collectionDayOfWeek

Array<string>

nullable

Allowed values: Sunday Monday Tuesday Wednesday Thursday Friday Saturday

collectionStartDate

The date when collection visits should start

string format: date-time

nullable

Example

2026-01-16

farmType

Type of farm/site based on the disease (e.g. Poultry Farm, Wetland, Cattle Farm)

string

nullable

Example

poultry_farm

siteSubType

Sub-type of the farm/site (e.g. Broiler, Breeder, Layer, Backyard)

string

nullable

Example

broiler

siteType

string

Allowed values: private government corporate

id

required

string

name

required

string

siteCode

string

nullable

collectionConsent

string

nullable

collectionFrequencyInterval

number

nullable

collectionFrequency

number

nullable

collectionTime

string

nullable

collectionLastScheduleDate

string format: date-time

nullable

collectionDuration

number

nullable

collectionExpiryDate

string format: date-time

photos

Array<string>

nullable

siteOwnerName

string

nullable

siteOwnerNumber

string

nullable

workerNumber

number

nullable

address

string

nullable

pinCode

number

nullable

comment

string

nullable

createdAt

required

string format: date-time

diseases

required

Array<object>

object

id

required

string

code

required

string

name

required

string

shortName

required

string

index

required

number

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

status

string

nullable

Allowed values: active inactive deleted

collectionCollector

object

firstName

string

nullable

Example

John

id

required

string

lastName

string

nullable

profilePicture

string

nullable

designation

string

nullable

contactNumber

required

string

nullable

address

string

nullable

email

string

nullable

createdBy

object

firstName

string

nullable

Example

John

id

required

string

lastName

string

nullable

profilePicture

string

nullable

designation

string

nullable

contactNumber

required

string

nullable

address

string

nullable

email

string

nullable

team

object

id

required

string

teamName

string

nullable

address

string

nullable

logo

string

nullable

location

object

id

required

string

coordinates

object

coordinates

required

Array<number>

type

required

string

region

object

id

required

string

regionType

required

string

Allowed values: country state district subdistrict city

lgdCode

string

nullable

localName

required

string

name

required

string

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

parentRegion

object

id

required

string

regionType

required

string

Allowed values: country state district subdistrict city

lgdCode

string

nullable

localName

required

string

name

required

string

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

distance

required

number