ID lookup services

ID join lookup service

A lookup service, largely intended for debug purposes, to enable view which external IDS are joined to a name usage in the main index.

get/v2/species/match/joins/{identifier}

Request

Base URL
https://api.gbif.org
Auth
none declared
TypeScript
https://skmtc.dev/gbif/apis/species-api/docs/v2/species/match/joins/:identifier/get.ts
A function with typed inputs. Its response is checked against the schema.

identifierstring required

Name usage suggestions found

idstring

The external identifier that may or may not have been associated with the main index

mainIndexIDstring

The main index identifier that the external identifier was matched to

datasetKeystring

The gbif key of the dataset containing the joined external ID

clbDatasetKeystring

The checklistbank dataset key of the joined external ID

datasetTitlestring

The dataset title of the joined external ID

parentIDstring

The parent ID of the external identifier

scientificNamestring

The scientific name associated with the external identifier

acceptedTaxonIDstring

The accepted taxon ID of the external identifier

rankstring

The rank of the external identifier

statusstring

The status of the external identifier

recognizedVariantsstring[]

Recognized variants of this ID

Nov 10, 2026340d13cde148 Revision changes
- warning
  removed the optional property / from the response with the status
- info
  added the optional property / to the response with the status
Aug 6, 2026156fd5bac927 Revision changes
- info
  added the optional property / to the response with the status