Skip to navigation
APIsTeam Glossary ResourcesSample Glossary

Retrieve a team sample glossary item

Retrieves a sample type from your team's glossary. Returns 404 when the entry does not exist or is not a sample type.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

teamGlossaryIdstringRequiredformat: "^tgy_[a-zA-Z0-9]{10,22}$"
The unique identifier of the team glossary.

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 sample type.
idstringformat: "^tgy_[a-zA-Z0-9]{10,22}$"
Unique identifier for an entry in your team's own glossary.
titlestring<=255 characters
The title of the sample type.
labelstring or null<=20 characters
A short label for the sample type.
descriptionstring or null
A longer description of the sample type.
statusenum
Whether a team glossary entry is available for use or archived.
Allowed values:
detailslist of strings or null

The details to record when a sample of this type is collected. Null when none are configured. Entries created through this API are always one of weight, volume, width, length or depth, but entries configured in the In Vivo app are not restricted to those values.

Errors

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