Skip to navigation
APIsSpecies Resources

Retrieve a species

Retrieves the details of an existing species.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

speciesIdstringRequiredformat: "^spc_[A-Za-z0-9]+$"
The unique identifier of the species.

Headers

X-Studies-Api-VersionstringOptional

Response headers

X-RateLimit-LimitintegerOptional
The number of requests permitted in the current rate limit window.
X-RateLimit-RemainingintegerOptional

The number of requests still available in the current rate limit window. When several limits apply, this reflects the per-API-key limit, so a request can be rejected while this value is above zero.

X-RateLimit-ResetintegerOptional
The number of seconds until the current rate limit window resets.

Response

The requested species.
idstringformat: "^spc_[A-Za-z0-9]+$"
The stable external identifier of a species.
namestring<=255 characters
The name of the species.
activeboolean
Whether the species is active.
created_atdatetime

UTC timestamp with microsecond precision, always suffixed with Z, in the form yyyy-MM-ddTHH:mm:ss.SSSSSSZ.

updated_atdatetime

UTC timestamp with microsecond precision, always suffixed with Z, in the form yyyy-MM-ddTHH:mm:ss.SSSSSSZ.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error