Skip to content

Retrieve a metaobject by handle

View as Markdown
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.

Path parameters

NameTypeRequiredDescription
typestringrequiredThe metaobject definition type slug the metaobject belongs to.
handlestringrequiredThe metaobject's unique slug within its type.

Response

200 - Metaobject resource

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.

404 - Not found

PropertyTypeRequiredDescription
@contextobject-
@idstringrequired
@typestringrequired
titlestring | null-A short, human-readable summary of the problem.
detailstring | null-A human-readable explanation specific to this occurrence of the problem.
statusinteger | null-
instancestring | null-A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
typestring-A URI reference that identifies the problem type
descriptionstring | null-