Skip to main content
GET
List Plots

Authorizations

Authorization
string
header
required

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

Query Parameters

limit
integer
default:100

Maximum number of plots to return. Default 100, maximum 1000 — a larger value is rejected with 400.

Required range: 1 <= x <= 1000
offset
integer
default:0

Number of plots to skip for pagination.

Required range: x >= 0

Response

List of plots

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