---
title: "Document Metadata Get"
canonical: "https://support.appfire.com/space/CDMC/2192838382/Document%20Metadata%20Get"
format: markdown
---
> Macro (aura-html)

## Overview

The **Document Metadata Get** macro displays metadata, workflow parameters, and page parameters directly on a Confluence page or blog post, making important document information easily accessible and visible.

It retrieves metadata values defined on a page, including those set using the [Document Metadata Set](https://appfire.atlassian.net/wiki/spaces/CDMC/pages/2510750404) and [Document Metadata List](https://appfire.atlassian.net/wiki/spaces/CDMC/pages/2513797193) macros, as well as those set by the [set-metadata trigger action](https://appfire.atlassian.net/wiki/spaces/CDMC/pages/2193723026). The retrieved values can be displayed on the page, referenced from other pages, or accessed in workflow definitions.

**When to use this macro:** 

Use Document Metadata Get to display a single metadata value inline on a page. 

To display all metadata on a page, refer to the [Document Metadata Values](https://appfire.atlassian.net/wiki/spaces/CDMC/pages/2513862720) page.  

To learn more about how to pull metadata from another page, refer to [Document Metadata From](https://appfire.atlassian.net/wiki/spaces/CDMC/pages/2513600585).

### Migration compatibility

The following metadata migrated from the hosted app can also be retrieved using this macro:

- Metadata set with the [metadata macro](https://appfire.atlassian.net/wiki/spaces/COMALACM/pages/655988203) and [metadata-list macro](https://appfire.atlassian.net/wiki/spaces/COMALACM/pages/655758458) of the [Comala Metadata app](https://marketplace.atlassian.com/apps/5295/comala-metadata?hosting=datacenter&tab=overview)
- Metadata set with Comala Document Management Data Center [set-metadata macro](https://appfire.atlassian.net/wiki/spaces/CDML/pages/650251172)
- Page-level workflow parameters

## Parameters

| **Parameter** | **Required** | **Description** |
| --- | --- | --- |
| Metadata Name | Yes | The name (key) of the metadata value to retrieve. Must match a metadata name that has been set on the page. |

## Add the macro

To add the Document Metadata Get macro:

1. On a draft page, type `/document metadata get`.
  
2. Choose the **Document Metadata Get** macro. Click to edit and enter the **Metadata Name**.
  

> ℹ️ Make sure to enter a valid metadata name. The metadata name must exactly match a name set on the page. If the name does not match any existing metadata, the macro will not display a value.

3. **Publish** the page to retrieve and render the metadata value.

For example,

If a page has metadata set with the name `approver` and the value `John Smith`:

- **In the editor,** the macro appears as a placeholder block displaying the metadata name.
- **On the published page,** the macro renders the value **John Smith** inline where the macro was placed.

> ℹ️ - The metadata name is case-sensitive. It must exactly match the name used in the Document Metadata Set or the workflow definition.
> ℹ️ 
> ℹ️ - The macro only renders values on a published page. If you’ve added or updated metadata, publish the page to see the result.
> ℹ️ 
> ℹ️ - If the metadata name doesn’t match any existing metadata on the page, the macro will not display a value.
> ℹ️ 
> ℹ️ - When working with migrated metadata from the hosted app, verify that the original metadata key name carried over correctly.

**Related macros**

- [Document Metadata Set](https://appfire.atlassian.net/wiki/spaces/CDMC/pages/2510750404)
- [Document Metadata List](https://appfire.atlassian.net/wiki/spaces/CDMC/pages/2513797193)
- [Document Metadata Values](https://appfire.atlassian.net/wiki/spaces/CDMC/pages/2513862720)
- [Document Metadata From](https://appfire.atlassian.net/wiki/spaces/CDMC/pages/2513600585)
- [Document Metadata Report](https://appfire.atlassian.net/wiki/spaces/CDMC/pages/2508096484)