Skip to content

List metaobject entries

GET
/stores/{storeRef}/metaobjects/{type}/entries
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

type
required
string

The metaobject definition’s type handle.

storeRef
required
string

The store’s ref, as returned by GET /stores.

search
string
<= 255 characters /^[^\u0000]*$/

Only entries whose display name or handle contains this text, ignoring case. Up to 255 characters.

filter

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
key
additional properties
string
status
string
Allowed values: active draft

Only entries with this status.

cursor
string
<= 512 characters

The next_cursor of the previous page. Up to 512 characters.

limit
number
>= 1 <= 100

Number of entries per page, from 1 to 100. Defaults to 50.

Media typeapplication/json
object
items
required

The entries on this page, most recently updated first.

Array<object>
object
id
required

Entry ID, as a string.

string
definition_id
required

ID of the metaobject definition the entry belongs to.

string
status
required

Active or draft. Always active when the definition has no status.

string
Allowed values: active draft
fields
required

The field values, keyed by field key. Fields without a value are left out.

object
key
additional properties
any
created_by
required

ID of the user who created the entry, or null.

string
nullable
updated_by
required

ID of the user who last updated the entry, or null.

string
nullable
created_at
required

When the entry was created, as an ISO 8601 timestamp.

string format: date-time
updated_at
required

When the entry was last updated, as an ISO 8601 timestamp.

string format: date-time
handle
required

The entry’s handle, unique within its type. Generated from the display name when not given on create.

string
display_name
required

The text that names the entry: the display-name field’s value, or the handle.

string
type
required

The type handle of the entry’s definition.

string
next_cursor
required

Pass as the cursor query parameter to get the next page, or null on the last page.

string
nullable

Example

{
"items": [
{
"status": "active"
}
]
}

The request is malformed or failed validation.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}

The key is missing, invalid, revoked or expired.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

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.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}

The resource does not exist in this store.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}