List metaobject definitions

get /api/metaobject_definitions

Retrieves the collection of MetaobjectDefinition resources.

Returns a paginated collection of metaobject definitions - the custom object types defined in the current organization.

Query parameters

Name	Type	Required	Description
page	integer	-	The collection page number
itemsPerPage	integer	-	The number of items per page
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}
id[]	string[]	-	Only the items with one of these ids, each a UUID or the item IRI.

Response

200 - MetaobjectDefinition collection

Property	Type	Required	Description
search	object	-
Show search fields Property Type Required Description @type string - mapping object[] - Show mapping fields Property Type Required Description @type string - property string | null - required boolean - variable string - template string - variableRepresentation string -
totalItems	integer	-
view	object	-
Show view fields Property Type Required Description @id string - @type string - first string | null - last string | null - next string | null - previous string | null -
member	MetaobjectDefinition[]	required
Show member fields Property Type Required Description @context string | object - @id string required @type string required createdAt string - The date and time when the resource was created (ISO 8601 format). description string | null - The description of the metaobject definition. displayNameField string | null - The key of the field definition used as the display name for records of this type. Optional - when omitted it is null and records have no derived display name. When set, it must match the key of one of this definition's fieldDefinitions, otherwise the request is rejected with 422. fieldDefinitions EmbeddedMetaobjectFieldDefinitionResource[] - The field definitions that make up this metaobject definition. Show fieldDefinitions fields Property Type Required Description description string | null - An optional description of the field. id string - The resource's unique identifier (UUID). key string required The field key, unique within the definition (referenced by metaobject fields). name string required The human-readable name of the field. required boolean - Whether a value for this field is required on metaobjects of the definition. type "/api/metafield_definition_types/single_line_text_field" | "/api/metafield_definition_types/multi_line_text_field" | "/api/metafield_definition_types/number_integer" | "/api/metafield_definition_types/number_decimal" | "/api/metafield_definition_types/json" | "/api/metafield_definition_types/list__single_line_text_field" | "/api/metafield_definition_types/list__number_integer" | "/api/metafield_definition_types/list__number_decimal" | "/api/metafield_definition_types/list__product_reference" | "/api/metafield_definition_types/list__media_reference" | "/api/metafield_definition_types/product_reference" | "/api/metafield_definition_types/media_reference" | "/api/metafield_definition_types/metaobject_reference" | "/api/metafield_definition_types/list__metaobject_reference" required The field data type, as an IRI to the field-type resource. Immutable once the field definition exists: a PATCH changing it is rejected with a 422. Delete the field and add the key back to use another type. validations EmbeddedMetafieldDefinitionValidationResource[] - The validation rules applied to values of this field. id string - The resource's unique identifier (UUID). name string required The human-readable name of the metaobject definition. type string required The unique slug identifier for this metaobject definition. updatedAt string - The date and time when the resource was last modified (ISO 8601 format).

Errors

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

Content-Type: application/problem+json

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