Sign in

v1

latestOpenAPI 3.0.3Apache 2.02026-07-138386226.8 KB
Community classifications

Get all community classifications

Retrieve a paginated collection of all community classifications recorded in VegBank.

get/community-classifications

Query parameters

detail'minimal' | 'full'

Level of detail for the response:

  • minimal: Returns basic fields only
  • full: Returns more fields
with_nestedboolean

Whether to include nested fields in the response

limitinteger

Maximum number of records to return

offsetinteger

Number of records to skip before starting to return records

create_parquetboolean

If true, return data payload in binary Parquet format

Response

Matching community classification(s), with fields based on parameters:

  • detail=minimal&with_nested=false: Basic fields only
  • detail=minimal&with_nested=true: Basic fields + nested array fields
  • detail=full&with_nested=false: Extended fields, no nested array fields
  • detail=full&with_nested=true: Extended fields + nested array fields
OR
OR
OR

Example response

{
  "count": 115000,
  "data": [
    {
      "cl_code": "cl.1",
      "ob_code": "ob.1",
      "class_start_date": "2006-05-30",
      "class_stop_date": "2006-05-30",
      "expert_system": "DCA, UPGMA",
      "class_publication_rf_code": "rf.1",
      "class_publication_rf_label": "NVC 2004",
      "class_notes": "Abies Grandis Alliance"
    }
  ]
}