Skip to main content
GET
/
api
/
forest
/
patrimony
curl -X GET "https://api.confor.app/api/forest/patrimony?level=2&page=1&limit=25" \
  -H "Authorization: Bearer YOUR_TOKEN"

{
  "items": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "code": "FINCA-001",
      "name": "La Esperanza",
      "type": "FINCA",
      "legalStatus": "ADQUISICION",
      "totalAreaHa": 1250.50,
      "centroidLatitude": 10.5,
      "centroidLongitude": -66.9,
      "ownerRepresentative": "Juan Pérez",
      "publicRegistryNumber": "REG-2023-001",
      "address": "Sector Rural, Municipio XYZ",
      "isActive": true,
      "organizationId": "org-uuid",
      "createdAt": "2024-01-15T10:30:00Z",
      "updatedAt": "2024-01-15T10:30:00Z"
    }
  ],
  "pagination": {
    "total": 1,
    "page": 1,
    "limit": 25,
    "totalPages": 1
  }
}

​
Overview

Level 2 represents the top-level patrimony units in the forest hierarchy. These are large land holdings such as farms, estates, or protected areas.

​
Hierarchy

Level 2 (FINCA, PREDIO, etc.)
  └─ Level 3 (Compartments, Blocks, Sections)
      └─ Level 4 (Stands, Parcels, Management Units)
          └─ Level 5 (Reference Units, Sub-parcels)

​
List Level 2 Units

​
level
string
required
Must be set to "2" to retrieve Level 2 units
​
page
number
default:"1"
Page number for pagination
​
limit
number
default:"25"
Number of items per page
​
search
string
Search by code or name (case-insensitive)

​
Response

​
items
array
​
id
string
Unique identifier (UUID)
​
code
string
Unique code for the unit (max 80 characters)
​
name
string
Name of the patrimony unit
​
type
enum
Type of patrimony unit. Possible values:
  • FINCA - Farm
  • PREDIO - Property
  • HATO - Ranch
  • FUNDO - Estate
  • HACIENDA - Hacienda
  • ABRAE - Protected Natural Area
​
legalDocumentDate
date
Date of legal documentation
​
legalStatus
enum
Legal status of the property. Possible values:
  • ADQUISICION - Acquisition
  • ARRIENDO - Lease
  • USUFRUCTO - Usufruct
  • COMODATO - Loan for use
  • DECRETO - Decree
​
totalAreaHa
number
Total area in hectares
​
centroidLatitude
number
Latitude of centroid (-90 to 90)
​
centroidLongitude
number
Longitude of centroid (-180 to 180)
​
ownerRepresentative
string
Name of owner or representative
​
publicRegistryNumber
string
Public registry number (max 120 characters)
​
publicRegistryDate
date
Date of public registry
​
address
string
Physical address (max 2000 characters)
​
lastInfoDate
date
Date of last information update
​
isActive
boolean
default:"true"
Whether the unit is active
​
organizationId
string
Organization ID (UUID)
​
createdAt
datetime
Creation timestamp
​
updatedAt
datetime
Last update timestamp
​
pagination
object
​
total
number
Total number of items
​
page
number
Current page number
​
limit
number
Items per page
​
totalPages
number
Total number of pages
curl -X GET "https://api.confor.app/api/forest/patrimony?level=2&page=1&limit=25" \
  -H "Authorization: Bearer YOUR_TOKEN"

{
  "items": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "code": "FINCA-001",
      "name": "La Esperanza",
      "type": "FINCA",
      "legalStatus": "ADQUISICION",
      "totalAreaHa": 1250.50,
      "centroidLatitude": 10.5,
      "centroidLongitude": -66.9,
      "ownerRepresentative": "Juan Pérez",
      "publicRegistryNumber": "REG-2023-001",
      "address": "Sector Rural, Municipio XYZ",
      "isActive": true,
      "organizationId": "org-uuid",
      "createdAt": "2024-01-15T10:30:00Z",
      "updatedAt": "2024-01-15T10:30:00Z"
    }
  ],
  "pagination": {
    "total": 1,
    "page": 1,
    "limit": 25,
    "totalPages": 1
  }
}

​
Create Level 2 Unit

​
Request Body

​
level
string
required
Must be set to "2" to create a Level 2 unit
​
data
object
required
​
code
string
required
Unique code (1-80 characters)
​
name
string
required
Name of the unit (2-255 characters)
​
type
enum
required
Type of patrimony unit: FINCA, PREDIO, HATO, FUNDO, HACIENDA, ABRAE
​
legalDocumentDate
date
Date of legal documentation
​
legalStatus
enum
Legal status: ADQUISICION, ARRIENDO, USUFRUCTO, COMODATO, DECRETO
​
totalAreaHa
number
required
Total area in hectares (must be non-negative)
​
centroidLatitude
number
Latitude of centroid (-90 to 90)
​
centroidLongitude
number
Longitude of centroid (-180 to 180)
​
ownerRepresentative
string
Name of owner or representative (max 255 characters)
​
publicRegistryNumber
string
Public registry number (max 120 characters)
​
publicRegistryDate
date
Date of public registry
​
address
string
Physical address (max 2000 characters)
​
lastInfoDate
date
Date of last information update
​
isActive
boolean
default:"true"
Whether the unit is active

​
Response

Returns the created Level 2 unit with status code 201. 
curl -X POST "https://api.confor.app/api/forest/patrimony" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "level": "2",
    "data": {
      "code": "FINCA-001",
      "name": "La Esperanza",
      "type": "FINCA",
      "legalStatus": "ADQUISICION",
      "totalAreaHa": 1250.50,
      "centroidLatitude": 10.5,
      "centroidLongitude": -66.9
    }
  }'

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "code": "FINCA-001",
  "name": "La Esperanza",
  "type": "FINCA",
  "legalStatus": "ADQUISICION",
  "totalAreaHa": 1250.50,
  "centroidLatitude": 10.5,
  "centroidLongitude": -66.9,
  "ownerRepresentative": null,
  "publicRegistryNumber": null,
  "publicRegistryDate": null,
  "legalDocumentDate": null,
  "address": null,
  "lastInfoDate": null,
  "isActive": true,
  "organizationId": "org-uuid",
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-01-15T10:30:00Z"
}

Build docs developers (and LLMs) love

Get started for freeTalk to us