Sign in

v1

latestOpenAPI 3.0.12026-08-063340143.9 KB
Species

Name usage references by id

Retrieves all references for a name usage.

get/v1/species/{usageKey}/references

Path parameters

usageKeyinteger required

Name usage key.

Query parameters

limitinteger

Controls the number of results in the page. Using too high a value will be overwritten with the default maximum threshold, depending on the service. Sensible defaults are used so this may be omitted.

offsetinteger

Determines the offset for the search results. A limit of 20 and offset of 40 will get the third page of 20 results. Some services have a maximum offset.

Response

Name usage references 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.

Example response

{
  "results": [
    {
      "doi": "10.1038/ng0609-637"
    }
  ]
}