Choose a version:

metaobjectByHandle

query

Requires read_metaobjects access scope.

Retrieves a metaobject by handle.

Arguments

Anchor to handlehandle • MetaobjectHandleInput!required: The identifier of the metaobject to return.

Was this section helpful?

Metaobject

•

Provides an object instance represented by a MetaobjectDefinition.

capabilities• MetaobjectCapabilityData! non-null: Metaobject capabilities for this Metaobject.
createdBy• App! non-null: The app used to create the object.
createdByApp• App! non-null: The app used to create the object.
createdByStaff• StaffMember: The staff member who created the metaobject.
definition• MetaobjectDefinition! non-null: The MetaobjectDefinition that models this object type.
displayName• String! non-null: The preferred display name field value of the metaobject.
field• MetaobjectField: The field for an object key, or null if the key has no field definition.
fields• [MetaobjectField!]! non-null: All ordered fields of the metaobject with their definitions and values.
handle• String! non-null: The unique handle of the object, useful as a custom ID.
id• ID! non-null: A globally-unique ID.
referencedBy • MetafieldRelationConnection! non-null: List of back references metafields that belong to the resource.
thumbnailField• MetaobjectField: The recommended field to visually represent this metaobject. May be a file reference or color field.
type• String! non-null: The type of the metaobject.
updatedAt• DateTime! non-null: When the object was last updated.
staffMember• StaffMember: The staff member who created the metaobject.

Was this section helpful?