Retrieve a metaobject by handle

get /api/metaobjects/{type}/{handle}

Retrieves a Metaobject resource.

Returns a single metaobject by its definition type and its handle - the friendly slug lookup. Use this when you reference records by a stable, readable key rather than by id.

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 the metaobject belongs to.
handle	string	required	The metaobject's unique slug within its type.

Query parameters

Name	Type	Required	Description
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}

Response

200 - Metaobject resource

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	-

404 - Not found

Property	Type	Required	Description
@context	string | object	-
@id	string	required
@type	string	required
code	string	-	Stable identifier of the error in the error code catalogue (see /api/error-codes). Present on catalogued errors only.
description	string | null	-
detail	string | null	-	A human-readable explanation specific to this occurrence of the problem.
instance	string | null	-	A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
message	string	-	End-user message localized in the request locale, with this occurrence's values substituted. Present on catalogued errors only.
slug	string	-	Stable, readable key of the error in the error code catalogue. Present on catalogued errors only.
status	integer | null	-
title	string | null	-	A short, human-readable summary of the problem. For a catalogued error it repeats the slug.
type	string	-	A URI reference that identifies the problem type. For a catalogued error it is the error code resource, /api/error-codes/{code}.