curl -X GET 'https://<tenant>.product-management.flowkiwi.net/rest/api/metaobject_definitions/{type}/metaobjects' \ -H 'Authorization: Bearer {token}' \ -H 'X-Flowkiwi-Organization-Id: <org_id>' \ -H 'Accept: application/ld+json'

{ "@context": "/contexts/Metaobject", "@id": "/rest/api/metaobject_definitions/size_guide/metaobjects", "@type": "hydra:Collection", "hydra:totalItems": 1, "hydra:member": [ { "@context": "/contexts/Metaobject", "@id": "/rest/api/metaobjects/019afc10-4d5e-7f60-9b71-3c4d5e6f7081", "@type": "Metaobject", "id": "019afc10-4d5e-7f60-9b71-3c4d5e6f7081", "definition": "/rest/api/metaobject_definitions/019afc01-1a2b-7c3d-8e4f-0a1b2c3d4e5f", "handle": "mens-shoes-eu", "status": "ACTIVE", "displayName": "EU men's shoes", "fields": [ { "key": "title", "value": "EU men's shoes", "type": "/rest/api/metafield_definition_types/single_line_text_field", "metaobject": [] }, { "key": "body", "value": "EU 40 = 25.5 cm, EU 41 = 26.2 cm, EU 42 = 27 cm", "type": "/rest/api/metafield_definition_types/multi_line_text_field", "metaobject": [] } ], "createdAt": "2026-01-15T09:30:00+00:00", "updatedAt": "2026-02-03T14:45:12+00:00" } ] }

List metaobjects by type

View as Markdown

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

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
`definition`	`string`	-
`definition[]`	`string[]`	-
`status`	`string`	-
`status[]`	`string[]`	-
`handle`	`string`	-
`handle[]`	`string[]`	-
`fields[<key>]`	`object`	-	Filter entries by field value. Pairs are combined with AND; exact match against the translated value for the locale provided in `X-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

Format

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
`@type`	`string`	-
`variable`	`string`	-
`property`	`string \| null`	-
`required`	`boolean`	-

hydra:view object -

Show hydra:view fields

Property	Type	Required
`@id`	`string`	-
`@type`	`string`	-
`hydra:first`	`string`	-
`hydra:last`	`string`	-
`hydra:previous`	`string`	-
`hydra:next`	`string`	-

hydra:member Metaobject[] 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).
`definition`	`string`	-	The `MetaobjectDefinition` (IRI) this metaobject is a record of.
`handle`	`string`	-	The metaobject's unique slug within its definition type.
`status`	`"DRAFT" \| "ACTIVE"`	-	The publication status of the metaobject.
`displayName`	`string \| null`	-	The human-readable label, derived from the field named by the definition's displayNameField.

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.