metaobjectByHandle - admin-graphql - QUERY

Version: 2024-07

Description:

Retrieves a metaobject by handle.

Access Scopes

`read_metaobjects` access scope.

Arguments

• handle: MetaobjectHandleInput! - The identifier of the metaobject to return.

Returns

• capabilities: MetaobjectCapabilityData! Metaobject capabilities for this Metaobject.
• createdBy: App! The app used to create the object.
• createdByApp: App! The app used to create the object.
• createdByStaff: StaffMember The staff member who created the metaobject.
• definition: MetaobjectDefinition! The MetaobjectDefinition that models this object type.
• displayName: String! 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! All ordered fields of the metaobject with their definitions and values.
• handle: String! The unique handle of the object, useful as a custom ID.
• id: ID! A globally-unique ID.
• staffMember: StaffMember The staff member who created the metaobject.
• thumbnailField: MetaobjectField The recommended field to visually represent this metaobject. May be a file reference or color field.
• type: String! The type of the metaobject.
• updatedAt: DateTime! When the object was last updated.

Examples