Skip to navigation
APIsMetadata ResourcesMetadata Option

List all metadata options

Returns a list of your metadata options.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

metadataIdstringRequiredformat: "^mgl_[a-zA-Z0-9]{10,22}$"
The unique identifier of the metadata.

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.
querystringOptional
Filter metadata options by value.

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 metadata options.
datalist of objects
The metadata options 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
404
Not Found Error
429
Too Many Requests Error