Skip to navigation
APIsSample Resources

List all samples

Returns a paginated list of samples in your facility.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Headers

X-Studies-Api-VersionstringOptional

Query parameters

perPageintegerOptional1-100Defaults to 10
The number of results to return per page, up to a maximum of 100.
pageintegerOptional>=1Defaults to 1
The page of results to return. The first page is 1.
sortenumOptional

The attribute to sort samples by. Sorting is unspecified when omitted; pair with order to control the direction.

orderenumOptional

The direction to sort samples in. Has no effect unless sort is also given.

Allowed values:
animal_idstringOptionalformat: "^aml_[a-zA-Z0-9]{10,22}$"
Filter samples to those collected from this animal.
study_idstringOptionalformat: "^sdy_[a-zA-Z0-9]{10,22}$"
Filter results to resources associated with this study.
sample_definition_idlist of stringsOptional
Filter samples to those created from any of these sample definitions.
metadatastringOptional

Filter results by metadata value, matching against any metadata key. To filter on a specific key instead, pass the metadata slug itself as a query parameter, e.g. ?study-internal-id=STUDY-1234. Those slug parameters vary by team glossary and so cannot be enumerated here.

typestringOptional

Filter samples to return by type, matching case-insensitively on any part of the type. Types are free-form text drawn from your team’s configuration rather than a fixed set of values. Applying this filter also excludes samples that have no type.

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

A page of samples across studies you can read.
datalist of objects
The samples on this page of results.
metaobject
Pagination counters describing the returned page of results.

Errors

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