List metaobject entries
const url = 'https://apibase.ecomweb.app/api/v1/stores/example/metaobjects/example/entries?status=active';const options = {method: 'GET', headers: {'x-api-key': '<x-api-key>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url 'https://apibase.ecomweb.app/api/v1/stores/example/metaobjects/example/entries?status=active' \ --header 'x-api-key: <x-api-key>'Returns a page of entries of one type, most recently updated first. Filter with search, status and equality filters filter[key]=value on the definition’s filter keys. Pages are cursor-based: pass the previous response’s next_cursor as cursor until it is null. limit is at most 100 and defaults to 50.
Required scopes: read:metaobjects
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”The metaobject definition’s type handle.
The store’s ref, as returned by GET /stores.
Query Parameters
Section titled “Query Parameters”Only entries whose display name or handle contains this text, ignoring case. Up to 255 characters.
Equality filters, sent as filter[key]=value. Only keys in the definition’s filter keys are accepted; a boolean is true or false, an integer a whole number and a date YYYY-MM-DD.
object
Only entries with this status.
The next_cursor of the previous page. Up to 512 characters.
Number of entries per page, from 1 to 100. Defaults to 50.
Responses
Section titled “Responses”object
The entries on this page, most recently updated first.
object
Entry ID, as a string.
ID of the metaobject definition the entry belongs to.
Active or draft. Always active when the definition has no status.
The field values, keyed by field key. Fields without a value are left out.
object
ID of the user who created the entry, or null.
ID of the user who last updated the entry, or null.
When the entry was created, as an ISO 8601 timestamp.
When the entry was last updated, as an ISO 8601 timestamp.
The entry’s handle, unique within its type. Generated from the display name when not given on create.
The text that names the entry: the display-name field’s value, or the handle.
The type handle of the entry’s definition.
Pass as the cursor query parameter to get the next page, or null on the last page.
Example
{ "items": [ { "status": "active" } ]}The request is malformed or failed validation.
object
The HTTP status code.
What went wrong; validation failures list one message per problem.
The HTTP status text, such as Bad Request.
object
A stable, machine-readable error code.
A human-readable explanation.
Extra context about the error, when there is any.
object
When the error happened, as an ISO 8601 timestamp.
Example generated
{ "statusCode": 1, "message": [ "example" ], "error": "example"}The key is missing, invalid, revoked or expired.
object
The HTTP status code.
What went wrong; validation failures list one message per problem.
The HTTP status text, such as Bad Request.
object
A stable, machine-readable error code.
A human-readable explanation.
Extra context about the error, when there is any.
object
When the error happened, as an ISO 8601 timestamp.
Example generated
{ "statusCode": 1, "message": [ "example" ], "error": "example"}The key may not do this: a missing scope, a readonly key, a publishable key on a Store API route, or a disallowed origin.
object
The HTTP status code.
What went wrong; validation failures list one message per problem.
The HTTP status text, such as Bad Request.
object
A stable, machine-readable error code.
A human-readable explanation.
Extra context about the error, when there is any.
object
When the error happened, as an ISO 8601 timestamp.
Example generated
{ "statusCode": 1, "message": [ "example" ], "error": "example"}The resource does not exist in this store.
object
The HTTP status code.
What went wrong; validation failures list one message per problem.
The HTTP status text, such as Bad Request.
object
A stable, machine-readable error code.
A human-readable explanation.
Extra context about the error, when there is any.
object
When the error happened, as an ISO 8601 timestamp.
Example generated
{ "statusCode": 1, "message": [ "example" ], "error": "example"}