Quick reference

List of endpoints and parameters!

GET DATA (downloads)

Shared get-parameters

All endpoints share these GET parameters:

  • id return only the specified resource. May be number or a comma delimited list, such as api/v0/locations?id=1,50,124
  • limit: the number of items that should be returned (must be greater than 0). Example: api/v0/taxons?limit=10
  • offset: the initial record to extract, to be used with limit when trying to download a large amount of data. Example: api/v0/taxons?offset=10000&limit=10000 returns 10K records starting from the 10K position of the current query.
  • fields: the field or fields that should be returned. Each endpoint has its own fields but there are two special words, simple (default) and all, which return different collection of fields. fields=all may return sub-objects for each object. fields ='raw' will return the raw table, speeding up the search, although values may be more difficult to understand. Example: api/v0/taxons?fields=id,scientificName,valid
  • save_job: for large data retrieval, if you add save_job=1 to the params list a job will be created for your search, and the data can then be obtained using the userjobs api.

Endpoint parameters

EndpointDescriptionPossible parameters
/Tests your accessnone
bibreferencesLists of bibliographic referencesid, bibkey
biocollectionsList of Biocollections and other vouchers Repositoriesid
datasetsLists registered datasets or downloand the files of dataset versionsid, list_versions, file_name
individualsLists registered individualsid, location, location_root,taxon, taxon_root, tag,project, dataset
individual-locationsLists occurrences for individualsindividual_id, location, location_root,taxon, taxon_root, dataset
languagesLists registered languages
measurementsLists Measurementsid, taxon,taxon_root,dataset,trait,individual,voucher,location,location_root
mediaLists Media Metadataid, taxon,taxon_root,dataset,individual,voucher,location,location_root
locationsLists locationsroot, id, parent_id,adm_level, name, limit, querytype, lat, long,project,dataset
personsLists registered peopleid, search, name, abbrev, email
projectsLists registered projectsid only
taxonsLists taxonomic namesroot, id, name,level, valid, external, project,dataset
traitsLists variables (traits) listid, name
vernacularLists vernacularsid, individual,taxon,taxon_root
vouchersLists registered voucher specimensid, number, individual, location, collector, location_root,taxon, taxon_root, project, dataset
userjobsLists user Jobsid, status,get_file

POST DATA (imports)

EndpointDescriptionPOST Fields
bibreferencesImport BibReferencesdoi or bibtex
biocollectionsImport BioCollectionsname, acronym
individualsImport individualscollector, tag, dataset, date, (location or latitude + longitude)**, altitude, location_notes, location_date_time, x, y, distance , angle , notes , taxon , identifier , identification_date , modifier, identification_notes , identification_based_on_biocollection, identification_based_on_biocollection_id , identification_individual
individual-locationsImport IndividualLocationsindividual, (location or latitude + longitude), altitude, location_notes, location_date_time, x, y, distance, angle
locationsImport locationsname, adm_level, (geom or lat+long)** , parent, altitude, datum, x, y , startx, starty, notes, ismarine
measurementsImport Measurements to Datasetsdataset, date, object_type, object_id, person, trait_id, value**, link_id, bibreference, notes, duplicated,location, parent_measurement
mediaImport Mediaa zip file containing media and an attribute table see details here
personsImports a list of peoplefull_name**, abbreviation, email, institution, biocollection
traitsImport traitsexport_name, type, objects, name, description**, units, range_min, range_max, categories, wavenumber_min and wavenumber_max, value_length, link_type, bibreference, tags
taxonsImports taxonomic namesname**, level, parent, bibreference, author, author_id or person, valid, mobot, ipni, mycobank, zoobank, gbif
vouchersImports voucher specimensindividual, biocollection, biocollection_type, biocollection_number, number, collector, date, dataset, notes
vernacularImports Vernacularsname, language,taxons,individuals,citations,parent,type

PUT DATA (updates)

EndpointDescriptionPUT Fields
individualsUpdate Individuals(id or individual_id),collector, tag, dataset, date, notes , taxon , identifier , identification_date , modifier, identification_notes , identification_based_on_biocollection, identification_based_on_biocollection_id , identification_individual
individual-locationsUpdate Individual Locations(id or individual_location_id), individual, (location or latitude + longitude), altitude, location_notes, location_date_time, x, y, distance, angle
locationsUpdate Locations(id or location_id), name, adm_level, (geom or lat+long) , parent, altitude, datum, x, y , startx, starty, notes, ismarine
measurementsUpdate Measurements(id or measurement_id), dataset, date, object_type, object_type, person, trait_id, value, link_id, bibreference, notes, duplicated,location, parent_measurement
mediaUpdate Media Metadata(media_id ou media_uuid), collector,tags, date, title_en, title_pt, license, dataset, project, notes, (location ou longitude + latitude)
personsUpdate Persons(id or person_id),full_name, abbreviation, email, institution, biocollection
vouchersUpdate Vouchers(id or voucher_id),individual, biocollection, biocollection_type, biocollection_number, number, collector, date, dataset, notes

Nomenclature types

Nomenclature types numeric codes
NotType : 0Isosyntype : 8
Type : 1Neotype : 9
Holotype : 2Epitype : 10
Isotype : 3Isoepitype : 11
Paratype : 4Cultivartype : 12
Lectotype : 5Clonotype : 13
Isolectotype : 6Topotype : 14
Syntype : 7Phototype : 15

Taxon Level (Rank)

LevelLevelLevelLevel
-100 clade60 cl., class120 fam., family210 section, sp., spec., species
0 kingdom70 subcl., subclass130 subfam., subfamily220 subsp., subspecies
10 subkingd.80 superord., superorder150 tr., tribe240 var., variety
30 div., phyl., phylum, division90 ord., order180 gen., genus270 f., fo., form
40 subdiv.100 subord.190 subg., subgenus, sect.