5. get

Last updated: Sep 8, 2025
DEVELOPER
IMPLEMENTATION
HEALTH TECH VENDOR

Definition

In a config modifier schema, use get to retrieve a value at a given path.

To retrieve a nested property value, use dot.notation; a prefix . isn’t required. Additionally, we support an array[index] notation (e.g., get: someArray[0].someProperty).

This value can either be simply returned or used as a starting point for other keywords at the same level or nested below.

Nesting level

This keyword executes at the following nesting level:

  1. omit
  2. constant
  3. references
  4. use
  5. get
  6. properties or if or concat or switch or pipe or merge
  7. default
  8. plugin

Example

You could indicate which value in an array to return.

Example: Get input from initial payload
json
1
{
2
"favorites": {
3
"dessert": "Cheesecake"
4
"appetizer": "Buffalo wings"
5
}
6
}
Example: Config modifier with get keyword
yaml
1
use: initialPayload
2
get: favorites.dessert
Example: Get output
json
1
"Cheesecake"