Get all community concepts

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

get/community-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 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
comm_name - Sort by community name
obs_count - Sort by observation count

Examples:

sort=comm_name - Sort by community name ascending
sort=-obs_count - Sort by observation count descending
sort=+comm_name - Sort by community 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 community 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

Example response

{
  "count": 115000,
  "data": [
    {
      "cc_code": "cc.1",
      "comm_name": "Muhlenbergia rigens Wet Meadow",
      "comm_code": "CEGL005306",
      "comm_description": "This herbaceous bunchgrass association has been documented in...",
      "concept_rf_code": "rf.1",
      "concept_rf_label": "NatureServe Biotics 2019",
      "status_rf_code": "rf.1",
      "status_rf_label": "NatureServe Biotics 2019",
      "obs_count": 17,
      "comm_level": "Association",
      "status": "accepted",
      "start_date": "2006-05-30",
      "stop_date": "2006-05-30",
      "current_accepted": true,
      "py_code": "py.1",
      "party_label": "NatureServe (organization)",
      "comm_party_comments": "This association is the result of...",
      "parent_cc_code": "cc.1",
      "parent_name": "Leymus cinereus - Leymus triticoides Alkaline Wet Meadow Alliance"
    }
  ]
}

Changes

Changed in 6 of the 50 revisions of this API.5911

Mar 3, 20263f5b0d28b2961See the full diff
- ○
  added the new optional query request parameter status
  new-optional-request-parameter
Mar 2, 20268abfd084d7aa1See the full diff
- ●
  deleted the query request parameter status
  request-parameter-removed
Feb 27, 20260a8e7ce6b0e71See the full diff
- ○
  added the new optional query request parameter status
  new-optional-request-parameter
Jan 18, 20262e123831df6e488See the full diff
- ▲
  for the query request parameter limit, default value 1000 was added
  request-parameter-default-value-added
- ▲
  for the query request parameter offset, default value 0 was added
  request-parameter-default-value-added
- ▲
  added comm_concept_full comm_concept_full_nested to the response body oneOf list for the response status 200
  response-body-one-of-added
- ▲
  the response's body type/format changed from object/ to / for status 200
  response-body-type-changed
- ●
  for the query request parameter limit, the min was set to 0.00
  request-parameter-min-set
- ●
  for the query request parameter offset, the min was set to 0.00
  request-parameter-min-set
- ●
  deleted the query request parameter detail
  request-parameter-removed
- ●
  removed the optional property accession_code from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property community_name from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property description from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property name from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property reference from the response with the 200 status
  response-optional-property-removed
- ○
  api operation id get-cc was added
  api-operation-id-added
- ○
  api tag Community concepts added
  api-tag-added
- ○
  added the new optional query request parameter create_parquet
  new-optional-request-parameter
- ○
  added the new optional query request parameter search
  new-optional-request-parameter
- ○
  added the new optional query request parameter sort
  new-optional-request-parameter
- ○
  added the new optional query request parameter with_nested
  new-optional-request-parameter
- ○
  added the media type application/vnd.apache.parquet for the response with the status 200
  response-media-type-added
- ○
  added the non-success response with the status 400
  response-non-success-status-added
This revision also has 10 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
May 24, 202516a2946a00d01See the full diff
- ○
  endpoint added
  endpoint-added
Apr 29, 2025c9e23cb778c91See the full diff
- ▲
  api path removed without deprecation
  api-path-removed-without-deprecation
This revision also has 83 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Of the 50 revisions, 1 has no diff computed.

Full history