Skip to content

List metaobjects

View as Markdown
get /rest/api/metaobjects

Retrieves the collection of Metaobject resources.

Returns a paginated collection of metaobjects across all types in the current organization. To list only the records of one type, use List metaobjects by type.

Headers

NameTypeRequiredDescription
X-Flowkiwi-Organization-IdstringrequiredThe organization the request acts as. Determines the identity, permissions and ownership applied when reading or modifying data on the instance.

Query parameters

NameTypeRequiredDescription
pageinteger-The collection page number
itemsPerPageinteger-The number of items per page
definitionstring-
definition[]string[]-
statusstring-
status[]string[]-
handlestring-
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

PropertyTypeRequiredDescription
hydra:totalItemsinteger-
hydra:searchobject-
Show hydra:search fields
PropertyTypeRequiredDescription
@typestring-
hydra:templatestring-
hydra:variableRepresentationstring-
hydra:mappingobject[]-
Show hydra:mapping fields
PropertyTypeRequiredDescription
@typestring-
variablestring-
propertystring | null-
requiredboolean-
hydra:viewobject-
Show hydra:view fields
PropertyTypeRequiredDescription
@idstring-
@typestring-
hydra:firststring-
hydra:laststring-
hydra:previousstring-
hydra:nextstring-
hydra:memberMetaobject[]required
Show hydra:member fields
PropertyTypeRequiredDescription
@contextobject-
@idstringrequired
@typestringrequired
idstring-The resource's unique identifier (UUID).
definitionstring-The MetaobjectDefinition (IRI) this metaobject is a record of.
handlestring-The metaobject's unique slug within its definition type.
status"DRAFT" | "ACTIVE"-The publication status of the metaobject.
displayNamestring | 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

PropertyTypeRequiredDescription
@contextobject-
@idstringrequired
@typestringrequired
typestring-
titlestring-
statusinteger-
detailstring-
missingPermissionsstring[]-Identity permissions that the caller is missing for this operation. Present only when the 403 is caused by a denied identity:* permission.