List metaobjects by type

get /api/metaobject_definitions/{type}/metaobjects

Retrieves the collection of Metaobject resources.

Returns every metaobject belonging to one definition, identified by its type slug - for example all size_guide records.

Headers

Name	Type	Required	Description
Flowkiwi-Locale	string	-	Specifies the locale for properties that support localization. If not provided, the default locale will be used.

Path parameters

Name	Type	Required	Description
type	string	required	The metaobject definition type slug whose metaobject records to list.

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.
definition	string	-	Filter by the related "definition", given as an IRI or as an identifier.
definition[]	string[]	-	Filter by the related "definition", given as an IRI or as an identifier.
status	string	-	Metaobject status
status[]	string[]	-	Metaobject status
handle	string	-	Metaobject handle
handle[]	string[]	-	Metaobject handle
fields	object	-	Filter entries by field value. Pairs are combined with AND; exact match against the translated value for the locale provided in Flowkiwi-Locale. The filter is silently skipped when the header is missing. Example: ?fields[name]=Jane%20Doe. For list-typed fields, pass the JSON-encoded array.

Response

200 - Metaobject 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	Metaobject[]	required
Show member fields Property Type Required Description @context string | object - @id string required @type string required definition string | null - The MetaobjectDefinition (IRI) this metaobject is a record of. Requires the metaobjects:read scope. Returned null when the scope is missing. displayName string | null - The human-readable label, derived from the field named by the definition's displayNameField. handle string - The metaobject's unique slug within its definition type. id string - The resource's unique identifier (UUID). status "DRAFT" | "ACTIVE" - The publication status of the metaobject.

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	-