Returns every metaobject belonging to one definition, identified by its type slug - for example all size_guide records.
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 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
totalItems
integer
-
search
object
-
Show search fields
Property
Type
Required
Description
@type
string
-
template
string
-
variableRepresentation
string
-
mapping
object[]
-
Show mapping fields
Property
Type
Required
Description
@type
string
-
variable
string
-
property
string | null
-
required
boolean
-
view
object
-
Show view fields
Property
Type
Required
Description
@id
string
-
@type
string
-
first
string | null
-
last
string | null
-
previous
string | null
-
next
string | null
-
member
Metaobject[]
required
Show 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.
No properties.
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.