Retrieve a metafield definition type

get /api/metafield_definition_types/{id}

Retrieves a MetafieldDefinitionType resource.

Returns a single metafield definition type by id, including its allowedValidations.

Path parameters

Name	Type	Required	Description
id	string	required	MetafieldDefinitionType identifier

Query parameters

Name	Type	Required	Description
properties[]	string[]	-	Allows you to reduce the response to contain only the properties you need. If your desired property is nested, you can address it using nested arrays. Example: properties[]={propertyName}&properties[]={anotherPropertyName}&properties[{nestedPropertyParent}][]={nestedProperty}

Response

200 - MetafieldDefinitionType resource

Property	Type	Required	Description
@context	string | object	-
@id	string	required
@type	string	required
allowedValidations	string[]	-	The validation types that can be applied to a metafield definition of this type. Submitting any other validation is rejected. Types that allow none return an empty array.
description	string	-	A human-readable description of the metafield definition type.
example	string | number | array	-	An example value for a metafield of this type: a string, an integer or a decimal number for single-value types, an array of strings for list types.
id	string	-	The metafield definition type identifier (e.g. number_decimal).

Errors

404 - Not found

Property	Type	Required	Description
@context	string | object	-
@id	string	required
@type	string	required
code	string	-	Stable identifier of the error in the error code catalogue (see /api/error-codes). Present on catalogued errors only.
description	string | null	-
detail	string | null	-	A human-readable explanation specific to this occurrence of the problem.
instance	string | null	-	A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
message	string	-	End-user message localized in the request locale, with this occurrence's values substituted. Present on catalogued errors only.
slug	string	-	Stable, readable key of the error in the error code catalogue. Present on catalogued errors only.
status	integer | null	-
title	string | null	-	A short, human-readable summary of the problem. For a catalogued error it repeats the slug.
type	string	-	A URI reference that identifies the problem type. For a catalogued error it is the error code resource, /api/error-codes/{code}.