List metafield definitions

get /api/metafield_definitions

Retrieves the collection of MetafieldDefinition resources.

Returns a paginated collection of metafield definitions in the current organization. Filter by ownerType to see the custom fields defined for a given resource.

Query parameters

Name	Type	Required	Description
page	integer	-	The collection page number
itemsPerPage	integer	-	The number of items per page
ownerType	string	-
ownerType[]	string[]	-
type	string	-
type[]	string[]	-
name	string	-
order[name]	string	-
order[createdAt]	string	-
order[updatedAt]	string	-

Response

200 - MetafieldDefinition collection

Property	Type	Required	Description
totalItems	integer	-
search	object	-
Show search fields Property Type Required Description @type string - template string - variableRepresentation string - mapping object[] - Show mapping fields Property Type Required Description @type string - variable string - property string | null - required boolean -
view	object	-
Show view fields Property Type Required Description @id string - @type string - first string | null - last string | null - previous string | null - next string | null -
member	MetafieldDefinition[]	required
Show member fields Property Type Required Description @context object - @id string required @type string required id string - The resource's unique identifier (UUID). name string - The human-readable name of the metafield definition. description string | null - The description of the metafield definition. namespace string - The container for a group of metafields that the metafield definition is associated with. key string - The unique identifier for the metafield definition within its namespace. ownerType string required The resource type that the metafield definition is attached to. type string required The type of data that each of the metafields that belong to the metafield definition will store. createdAt string - The date and time when the resource was created (ISO 8601 format). updatedAt string - The date and time when the resource was last modified (ISO 8601 format). validations EmbeddedMetafieldDefinitionValidationResource[] - The validation rules applied to the values of metafields using this definition. Show validations fields Property Type Required Description name string required The type of validation rule value string required The validation parameter value. Format depends on the validation type. constraints EmbeddedMetafieldDefinitionConstraintResource[] - The constraint rules scoping where this metafield definition applies (e.g. by category or channel). Show constraints fields Property Type Required Description key string required The type of constraint rule values string[] required Array of constraint values. Format depends on the constraint type. metafieldsCount integer - The count of the metafields that belong to the metafield definition.

Errors

403 - Access denied. The caller is missing one or more identity permissions required for this operation.

Content-Type: application/problem+json

Property	Type	Required	Description
@context	object	-
@id	string	required
@type	string	required
type	string	-
title	string	-
status	integer	-
detail	string	-
missingPermissions	string[]	-	Identity permissions that the caller is missing for this operation. Present only when the 403 is caused by a denied identity:* permission.