--- title: "Root name usages of a dataset" method: GET path: "/v1/species/root/{datasetKey}" tags: ["Species"] --- # Root name usages of a dataset `GET /v1/species/root/{datasetKey}` Retrieves root name usages for a checklist dataset. ## Path parameters - `datasetKey` string, uuid, required ## Query parameters - `limit` integer - `offset` integer ## Headers - `Accept-Language` 'abk' | 'aar' | 'afr' | 'aka' | 'sqi' | 'amh' | 'ara' | 'arg' | 'hye' | 'asm' | 'ava' | 'ave' | 'aym' | 'aze' | 'bam' | 'bak' | 'eus' | 'bel' | 'ben' | 'bih' | 'bis' | 'bos' | 'bre' | 'bul' | 'mya' | 'cat' | 'cha' | 'che' | 'zho' | 'chu' | 'chv' | 'cor' | 'cos' | 'cre' | 'hrv' | 'ces' | 'dan' | 'div' | 'nld' | 'dzo' | 'eng' | 'epo' | 'est' | 'ewe' | 'fao' | 'fij' | 'fin' | 'fra' | 'fry' | 'ful' | 'glg' | 'lug' | 'kat' | 'deu' | 'ell' | 'kal' | 'grn' | 'guj' | 'hat' | 'hau' | 'heb' | 'her' | 'hin' | 'hmo' | 'hun' | 'isl' | 'ido' | 'ibo' | 'ind' | 'ina' | 'ile' | 'iku' | 'ipk' | 'gle' | 'ita' | 'jpn' | 'jav' | 'kan' | 'kau' | 'kas' | 'kaz' | 'khm' | 'kik' | 'kin' | 'kir' | 'kom' | 'kon' | 'kor' | 'kur' | 'kua' | 'lao' | 'lat' | 'lav' | 'lim' | 'lin' | 'lit' | 'lub' | 'ltz' | 'mkd' | 'mlg' | 'msa' | 'mal' | 'mlt' | 'glv' | 'mri' | 'mar' | 'mah' | 'mol' | 'mon' | 'nau' | 'nav' | 'ndo' | 'nep' | 'nde' | 'sme' | 'nob' | 'nno' | 'nor' | 'nya' | 'oci' | 'oji' | 'ori' | 'orm' | 'oss' | 'pli' | 'pan' | 'fas' | 'pol' | 'por' | 'pus' | 'que' | 'roh' | 'ron' | 'run' | 'rus' | 'smo' | 'sag' | 'san' | 'srd' | 'gla' | 'srp' | 'sna' | 'iii' | 'snd' | 'sin' | 'slk' | 'slv' | 'som' | 'nbl' | 'sot' | 'spa' | 'sun' | 'swa' | 'ssw' | 'swe' | 'tgl' | 'tah' | 'tgk' | 'tam' | 'tat' | 'tel' | 'tha' | 'bod' | 'tir' | 'ton' | 'tso' | 'tsn' | 'tur' | 'tuk' | 'twi' | 'uig' | 'ukr' | 'urd' | 'uzb' | 'ven' | 'vie' | 'vol' | 'wln' | 'cym' | 'wol' | 'xho' | 'yid' | 'yor' | 'zha' | 'zul' | '' ## Response `200` Root name usages found - PagingResponseNameUsage - `offset` integer — The offset of the results within all the search results. Subsequent pages can be retrieved by using `offset + count` as the new offset. - `limit` integer — The limit used. Note the limit returned may be lower than the limit requested. - `endOfRecords` boolean — True if this page of search results is the final page. - `count` integer — The total number of records returned by the search. - `results` NameUsage[] — Search results. - `key` integer, required — The name usage key that uniquely identifies this name usage. - `nubKey` integer — The taxon key of the matching backbone name usage. If this is equal to `key`, this name usage is a backbone name usage. - `nameKey` integer — The key for retrieving a parsed name object. *You are more likely to need the `key` or `nubKey` properties* - `taxonID` string — The original taxonID of the name usage as found in the source. For backbone taxa and name usages with an origin different to SOURCE this is null. - `sourceTaxonKey` integer — The key of the name usage from which this backbone taxon derives. For backbone taxa the source taxon key refers to the original name usage that was used during backbone building and is the primary reason that this taxon exists in the backbone. All backbone name usages are built from several underlying checklist usages, but these are sorted by priority and the usage key for the highest priority one becomes the sourceTaxonKey for a backbone usage. Some backbone usages do not have any source record at all; for example if there is a subspecies found, but no matching parent species, the missing species will be created nevertheless and has no primary source. - `kingdom` string — Kingdom. - `phylum` string — Phylum. - `order` string — Order. - `family` string — Family. - `genus` string — Genus. - `subgenus` string — Subgenus. - `species` string — Species. - `kingdomKey` integer — Name usage key of the kingdom. - `phylumKey` integer — Name usage key of the phylum. - `classKey` integer — Name usage key of the class. - `orderKey` integer — Name usage key of the order. - `familyKey` integer — Name usage key of the family. - `genusKey` integer — Name usage key of the genus. - `subgenusKey` integer — Name usage key of the subgenus. - `speciesKey` integer — Name usage key of the species. - `datasetKey` string, uuid, required — The checklist that “hosts” this name usage. For a backbone name usage, this will be `d7dddbf4-2cf0-4f39-9b2a-bb099caae36c`. - `constituentKey` string, uuid — The optional sub-dataset key for this usage. - `parentKey` integer — The name usage key of the immediate parent. Null for the highest taxonomic level. - `parent` string — The scientific name of the parent. - `proParteKey` integer — The primary name usage key for a *pro parte* synonym. Synonyms with multiple accepted names are grouped by a single, primary name usage key. - `acceptedKey` integer — The name usage key of the accepted name. - `accepted` string — The scientific name of the accepted name. - `basionymKey` integer — The name usage key of the basionym. - `basionym` string — The scientific name of the basionym. - `scientificName` string, required — The scientific name, with date and authorship information if available. Examples: *Coleoptera* (order), *Vespertilionidae* (family), *Manis* (genus), *Ctenomys sociabilis* (genus + specificEpithet), *Ambystoma tigrinum diaboli* (zoology, genus + specific name + infraspecific name) *Quercus agrifolia* var. *oxyadenia* (Torr.) (botany, genus + specific epithet + infraspecific epithet + authorship) - `canonicalName` string — The canonical name; the name without authorship or references. - `vernacularName` string — A common or vernacular name for this usage. - `authorship` string — The authorship for the scientific name. - `nameType` 'SCIENTIFIC' | 'VIRUS' | 'HYBRID' | 'INFORMAL' | 'CULTIVAR' | 'CANDIDATUS' | 'OTU' | 'DOUBTFUL' | 'PLACEHOLDER' | 'NO_NAME' | 'BLACKLISTED' — The type of name string classified by Checklistbank. - `rank` 'DOMAIN' | 'SUPERKINGDOM' | 'KINGDOM' | 'SUBKINGDOM' | 'INFRAKINGDOM' | 'SUPERPHYLUM' | 'PHYLUM' | 'SUBPHYLUM' | 'INFRAPHYLUM' | 'SUPERCLASS' | 'CLASS' | 'SUBCLASS' | 'INFRACLASS' | 'PARVCLASS' | 'SUPERLEGION' | 'LEGION' | 'SUBLEGION' | 'INFRALEGION' | 'SUPERCOHORT' | 'COHORT' | 'SUBCOHORT' | 'INFRACOHORT' | 'MAGNORDER' | 'SUPERORDER' | 'GRANDORDER' | 'ORDER' | 'SUBORDER' | 'INFRAORDER' | 'PARVORDER' | 'SUPERFAMILY' | 'FAMILY' | 'SUBFAMILY' | 'INFRAFAMILY' | 'SUPERTRIBE' | 'TRIBE' | 'SUBTRIBE' | 'INFRATRIBE' | 'SUPRAGENERIC_NAME' | 'GENUS' | 'SUBGENUS' | 'INFRAGENUS' | 'SECTION' | 'SUBSECTION' | 'SERIES' | 'SUBSERIES' | 'INFRAGENERIC_NAME' | 'SPECIES_AGGREGATE' | 'SPECIES' | 'INFRASPECIFIC_NAME' | 'GREX' | 'SUBSPECIES' | 'CULTIVAR_GROUP' | 'CONVARIETY' | 'INFRASUBSPECIFIC_NAME' | 'PROLES' | 'RACE' | 'NATIO' | 'ABERRATION' | 'MORPH' | 'VARIETY' | 'SUBVARIETY' | 'FORM' | 'SUBFORM' | 'PATHOVAR' | 'BIOVAR' | 'CHEMOVAR' | 'MORPHOVAR' | 'PHAGOVAR' | 'SEROVAR' | 'CHEMOFORM' | 'FORMA_SPECIALIS' | 'CULTIVAR' | 'STRAIN' | 'OTHER' | 'UNRANKED' — The rank for this usage. - `origin` 'SOURCE' | 'DENORMED_CLASSIFICATION' | 'VERBATIM_PARENT' | 'VERBATIM_ACCEPTED' | 'VERBATIM_BASIONYM' | 'PROPARTE' | 'AUTONYM' | 'IMPLICIT_NAME' | 'MISSING_ACCEPTED' | 'BASIONYM_PLACEHOLDER' | 'EX_AUTHOR_SYNONYM' | 'OTHER', required — The name usage origin. The origin of this name usage record, the reason it exists. In most cases this is because the record existed explicitly in the checklist sources, but some usages are created *de novo* because the exist implicitly in the data. - `taxonomicStatus` 'ACCEPTED' | 'DOUBTFUL' | 'SYNONYM' | 'HETEROTYPIC_SYNONYM' | 'HOMOTYPIC_SYNONYM' | 'PROPARTE_SYNONYM' | 'MISAPPLIED' — The taxonomic status of the name usage. Can be null, but for all synonyms with an accepted name usage it is guaranteed to exist. - `nomenclaturalStatus` string[] — The nomenclatural statuses of this name usage. - `remarks` string — Remarks on the name usage. - `publishedIn` string — Original publication for this name usage. - `accordingTo` string — The taxon concept reference. This is usually a reference to some publication or an author and year. The Darwin Core `taxonAccordingTo` reference is usually appended to the scientific name to further qualify the concept with “sensu” or “sec.” being used for concatenation; for example “_Acer nigrum_ sec. Gleason Cronquist 1991”. In the case of backbone taxa, this refers to the primary checklist in which the name was found. - `numDescendants` integer — A total count of all accepted taxonomic elements under this usage. - `references` string, uri — A URI link or reference to the source of the record, the record's “homepage”. - `modified` string, date-time — The interpreted dc:modified from the verbatim source data, ideally indicating when a record was last modified in the source. - `deleted` string, date-time — The date this record was deleted. *Only backbone name usages are soft-deleted.* - `lastCrawled` string, date-time — The date this record was last crawled (downloaded from the source) during Checklistbank indexing. - `lastInterpreted` string, date-time — The date this record was last interpreted during indexing. This includes matching to the backbone. - `issues` string[], required — Data quality issues found during Checklistbank interpretation. - `class` string — Class. ## Other responses - `400` — Invalid query - `404` — Name usage not found --- [API](https://skmtc.net/gbif/apis/species-api.md) · [All operations](https://skmtc.net/gbif/apis/species-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/gbif/species-api/versions/156fd5bac927/schema)