Get taxon observation

Changed on Mar 16, 2026

Retrieve a single taxon observation using its to_code.

get/taxon-observations/{to_code}

Request

Base URL
https://api.vegbank.org
Auth
none required
TypeScript
https://skmtc.dev/nceas/apis/vegbankapi/docs/taxon-observations/:to_code/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

to_codestring required

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

create_parquetboolean

If true, return data payload in binary Parquet format

Response

Matching taxon observation(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

Example response

{
  "count": 115000,
  "data": [
    {
      "to_code": "to.1",
      "ob_code": "ob.1",
      "int_curr_pc_code": "pc.1",
      "int_orig_pc_code": "pc.1",
      "taxon_inference_area": 405,
      "rf_code": "rf.1"
    }
  ]
}

Changes

Mar 16, 2026c37c8d7a84c5 Revision changes
- breaking
  added to the response body oneOf list for the response status
- warning
  removed the optional property /////////// from the response with the status
- warning
  removed the optional property /////////// from the response with the status
- warning
  removed the optional property /////////// from the response with the status
- warning
  removed the optional property /////////// from the response with the status
- warning
  removed the optional property /////////// from the response with the status
- warning
  removed the optional property /////////// from the response with the status
- warning
  removed the optional property /////////// from the response with the status
- warning
  removed the optional property /////////// from the response with the status
- warning
  removed the optional property /////////// from the response with the status
- warning
  removed the optional property /////////// from the response with the status
- warning
  removed the optional property /////////// from the response with the status
- warning
  removed the optional property /////////// from the response with the status
- info
  added the new optional query request parameter detail
- info
  added the optional property /////////// to the response with the status
- info
  added the optional property /////////// to the response with the status
- info
  added to the ////// response property allOf list for the response status
- info
  added to the ////// response property allOf list for the response status
- info
  removed from the ////// response property allOf list for the response status
Apr 29, 2025c9e23cb778c9 Revision changes
- breaking
  api path removed without deprecation

Operation history