Skip to content

Retrieve a metafield definition constraint type

View as Markdown
get /rest/api/metafield_definition_constraint_types/{id}

Retrieves a MetafieldDefinitionConstraintType resource.

Returns a single metafield definition constraint type by id.

Headers

NameTypeRequiredDescription
X-Flowkiwi-Organization-IdstringrequiredThe organization the request acts as. Determines the identity, permissions and ownership applied when reading or modifying data on the instance.

Path parameters

NameTypeRequiredDescription
idstringrequiredMetafieldDefinitionConstraintType identifier

Response

200 - MetafieldDefinitionConstraintType resource

PropertyTypeRequiredDescription
@contextobject-
@idstringrequired
@typestringrequired
idstring-The constraint type identifier (e.g. category).
descriptionstring-A human-readable description of the constraint type.

Errors

404 - Not found

PropertyTypeRequiredDescription
@contextobject-
@idstringrequired
@typestringrequired
titlestring | null-A short, human-readable summary of the problem.
detailstring | null-A human-readable explanation specific to this occurrence of the problem.
statusnumber | null-
instancestring | null-A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
typestring-A URI reference that identifies the problem type