Choose a version:

metaobjectDefinitionByType

query

Requires read_metaobject_definitions access scope.

Finds a metaobject definition by type.

Arguments

Anchor to typetype • String!required: The type of the metaobject definition to return.

Was this section helpful?

MetaobjectDefinition

•

Provides the definition of a generic object structure composed of metafields.

access• MetaobjectAccess! non-null: Access configuration for the metaobject definition.
capabilities• MetaobjectCapabilities! non-null: The capabilities of the metaobject definition.
createdByApp• App! non-null: The app used to create the metaobject definition.
createdByStaff• StaffMember: The staff member who created the metaobject definition.
description• String: The administrative description.
displayNameKey• String: The key of a field to reference as the display name for each object.
fieldDefinitions• [MetaobjectFieldDefinition!]! non-null: The fields defined for this object type.
hasThumbnailField• Boolean! non-null: Whether this metaobject definition has field whose type can visually represent a metaobject with the thumbnailField.
id• ID! non-null: A globally-unique ID.
metaobjects • MetaobjectConnection! non-null: A paginated connection to the metaobjects associated with the definition.
metaobjectsCount• Int! non-null: The count of metaobjects created for the definition.
name• String! non-null: The human-readable name.
type• String! non-null: The type of the object definition. Defines the namespace of associated metafields.

Was this section helpful?