Searching names

List all name usages

Changed on

Lists all name usages across all checklists.

get/v1/species

Request

Query parameters

datasetKeystring[]

A UUID of a checklist dataset.

sourceIdstring

Filters by the source identifier.

namestring

A name without authorship, to match exactly.

offsetinteger
limitinteger

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' | ''

Language for vernacular names, given as an ISO 639-1 two-letter code from our vocabulary.

Response

Name usages found

offsetinteger

The offset of the results within all the search results.

Subsequent pages can be retrieved by using offset + count as the new offset.

limitinteger

The limit used. Note the limit returned may be lower than the limit requested.

endOfRecordsboolean

True if this page of search results is the final page.

countinteger

The total number of records returned by the search.

Changes

    • breaking

      added the new required query request parameter arg3

    • breaking

      the response property // became optional for the status (media type: application/json)

    • breaking

      the response property // became optional for the status (media type: application/x-javascript)

    • breaking

      the response property // became optional for the status (media type: application/json)

    • breaking

      the response property // became optional for the status (media type: application/x-javascript)

    • breaking

      the response property // became optional for the status (media type: application/json)

    • breaking

      the response property // became optional for the status (media type: application/x-javascript)

    • breaking

      the response property // became optional for the status (media type: application/json)

    • breaking

      the response property // became optional for the status (media type: application/x-javascript)

    • breaking

      the response property // became optional for the status (media type: application/json)

    • breaking

      the response property // became optional for the status (media type: application/x-javascript)

    • warning

      deleted the query request parameter page