List metaobject definitions

get /rest/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.

Headers

Name	Type	Required	Description
X-Flowkiwi-Organization-Id	string	required	The organization the request acts as. Determines the identity, permissions and ownership applied when reading or modifying data on the instance.

Query parameters

Name	Type	Required	Description
page	integer	-	The collection page number
itemsPerPage	integer	-	The number of items per page

Response

200 - MetaobjectDefinition collection

Property	Type	Required	Description
hydra:totalItems	integer	-
hydra:search	object	-
Show hydra:search fields Property Type Required Description @type string - hydra:template string - hydra:variableRepresentation string - hydra:mapping object[] - Show hydra:mapping fields Property Type Required Description @type string - variable string - property string | null - required boolean -
hydra:view	object	-
Show hydra:view fields Property Type Required Description @id string - @type string - hydra:first string - hydra:last string - hydra:previous string - hydra:next string -
hydra:member	MetaobjectDefinition[]	required
Show hydra:member fields Property Type Required Description @context object - @id string required @type string required id string - The resource's unique identifier (UUID). type string required The unique slug identifier for this metaobject definition. name string required The human-readable name of the metaobject definition. 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 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. description string | null - An optional description of the field. type string required The field data type, as an IRI to the field-type resource. required boolean - Whether a value for this field is required on metaobjects of the definition. validations EmbeddedMetaobjectFieldDefinitionValidationResource[] - The validation rules applied to values of this field. 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).

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.