Get structure metadata

Returns the core metadata for a structure: its name, type, status, creator and timestamps. Use this instead of the full structure endpoint when you do not need ancestors or field values. Pass field_mask to restrict which metadata fields are populated.

Use this endpoint when you are checking whether a structure exists, confirming its name, or reading status in bulk. The response carries the structure's name, type, status, creator, and timestamps. It does not resolve ancestors or its field values. If you need the full profile, use the Get a structure endpoint.

Pass field_mask to restrict which metadata attributes are populated in the response. Omit it to receive all of them.

Requirements

Path Params
string
required

Required. The unique identifier of the structure.

Query Params
string

Optional. Controls which fields of the StructureMetadata are populated in the response.

Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json