Sign in

v1

latestOpenAPI 3.0.3Apache 2.02026-07-138386226.8 KB
Plant concepts

Get all plant concepts

Retrieve a paginated and sorted collection of plant concepts representing all concepts stored in VegBank, or a subset thereof based on a specified search query.

get/plant-concepts

Query parameters

searchstring

Search term used for full-text record retrieval

status'any' | 'current' | 'accepted' | 'current_accepted'

Status criterion for returned plant concepts and their children:

  • any: Returns matching concepts regardless of status
  • current: Only returns concepts that don't have (past) status stop dates
  • accepted: Only returns concepts that have an accepted status
  • current_accepted: Only returns concepts that are both current and accepted
with_nestedboolean

Whether to include nested fields in the response

sort'default' | '+default' | '-default' | 'plant_name' | '+plant_name' | '-plant_name' | 'obs_count' | '+obs_count' | '-obs_count'

Sort order for results. Prefix with - for descending order or + for ascending order. Ascending order is the default if no prefix is provided.

Available sort fields:

  • default - Default sort order
  • plant_name - Sort by plant name
  • obs_count - Sort by observation count

Examples:

  • sort=plant_name - Sort by plant name ascending
  • sort=-obs_count - Sort by observation count descending
  • sort=+plant_name - Sort by plant name ascending (explicit)
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 plant concept(s), with fields based on parameters:

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

Example response

{
  "count": 115000,
  "data": [
    {
      "pc_code": "pc.1",
      "plant_name": "Acer rubrum",
      "plant_code": "ACRU",
      "plant_description": "Named for the Cahaba River",
      "concept_rf_code": "rf.1",
      "concept_rf_label": "USDA Plants 2002",
      "status_rf_code": "rf.1",
      "status_rf_label": "USDA Plants 2002",
      "obs_count": 17,
      "plant_level": "Genus",
      "status": "accepted",
      "start_date": "2006-05-30",
      "stop_date": "2006-05-30",
      "current_accepted": true,
      "py_code": "py.1",
      "party_label": "USDA-NRCS-PLANTS (organization)",
      "plant_party_comments": "present at plants.usda.gov as a higher level taxon",
      "parent_pc_code": "pc.1",
      "parent_name": "Acer"
    }
  ]
}