Skip to content

Get a metaobject entry

GET
/stores/{storeRef}/metaobjects/{type}/entries/{id}
curl --request GET \
--url https://apibase.ecomweb.app/api/v1/stores/example/metaobjects/example/entries/example \
--header 'x-api-key: <x-api-key>'

Returns one entry with references, which says what each ID in its reference fields points to, so a client can show names and images without further requests.

Required scopes: read:metaobjects

type
required
string

The metaobject definition’s type handle.

id
required
string

The entry ID.

storeRef
required
string

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

Media typeapplication/json
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
references
required

For each reference field key, what each referenced ID points to, keyed by ID. Empty objects for other fields.

object
key
additional properties
object
key
additional properties
object
image_url
required

Its image, when it has one.

string
nullable
id
required

ID of the referenced record.

string
label
required

Its name or title. Falls back to the ID when the record is missing.

string
missing
required

True when the referenced record no longer exists.

boolean
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

Example

{
"status": "active"
}

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"
}