Skip to main content
GET
Get Plot by ID

Authorizations

Authorization
string
header
required

API key generated in Settings > API Keys. Include as Authorization: Bearer <key>.

Path Parameters

id
string<uuid>
required

Response

Plot details

A single plot as returned to an API key. The full analysis payload (analysisResult) and the image-space fields (pixelCoords, imageWidth, imageHeight) are not part of the API response.

id
string<uuid>
companyId
string<uuid>
createdByUserId
string<uuid>
name
string
country
string

Country of production (ISO 3166-1 alpha-2, e.g. BR).

size
number

Area in hectares. 0 when no size is stored.

requiresAreaPlausibilityReview
boolean

The declared size and the geometry do not fit together and need a manual review.

species
object[]
commodityGroup
enum<string>

EUDR-regulated commodity groups. non_relevant = article is not covered by EUDR.

Available options:
cattle,
cocoa,
coffee,
oil_palm,
rubber,
soya,
wood,
non_relevant
producerName
string
productionDateFrom
string<date-time>
productionDateTo
string<date-time>
analysisStatus
enum<string>

State of the geospatial deforestation analysis. A new plot starts at pending; the analysis runs asynchronously.

Available options:
pending,
in_progress,
completed,
failed,
exempt,
skipped
deforestationRiskResult
enum<integer> | null

Analysis result: 0 = low, 1 = high, 2 = moderate risk. null while no result is available.

Available options:
0,
1,
2,
null
forestPercentage
number
isDegraded
boolean | null
createdAt
string<date-time> | null
updatedAt
string<date-time> | null
geojson
object

The plot geometry as GeoJSON (a Feature or a bare Geometry, WGS84 longitude/latitude).

supplierArticleIds
string<uuid>[]

Supplier articles (supplier ↔ article links) this plot is linked to.

importSourceFormat
string

Source format when the plot came from a file import.

importPrecisionClass
string

Coordinate-precision class determined at import.

importPrecisionDigits
number

Decimal digits of the imported coordinates.

importPrecisionAcceptedAt
string<date-time>

When a low import precision was accepted.

importPrecisionAcceptedBy
string<uuid>

User who accepted a low import precision.

importPrecisionAcceptedByName
string

Name of that user.

importOriginalCentroidLng
number

Centroid longitude of the geometry as imported.

importOriginalCentroidLat
number

Centroid latitude of the geometry as imported.