> ## Documentation Index
> Fetch the complete documentation index at: https://docs.morf.health/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Onboarding Flow

> Documentation for the Get Onboarding Flow action for Healthie

![images/healthie.svg](https://mintcdn.com/morfhealth/EU2WCxuXGIUQcziR/images/healthie.svg?fit=max\&auto=format\&n=EU2WCxuXGIUQcziR\&q=85\&s=d168a24dbae69f2202ca63dd7aa2e1f3)

# Parameters

**Action** `Parameters`

**parameters**

**Custom Module Form ID** `string (Custom Module Form)` *required*

`ID`
This field maps to the destination API `id` field.

```json Result Object Example theme={null}
{
  "$result_object_key": {
    "has_forms_after_welcome": true,
    "id": "567890",
    "name": "New Patient Onboarding",
    "onboarding_items": [
      {
        "completed_form_id": "123456",
        "completed_onboarding_item": {
          "id": "123456",
          "item_id": "789012",
          "item_type": "CustomModuleForm",
          "onboarding_item": null,
          "skipped": false,
          "user_id": "345678"
        },
        "display_name": "Complete Initial Assessment",
        "id": "456789",
        "incomplete_custom_module_form_id": "234567",
        "is_last_item": false,
        "item_id": "345678"
      }
    ],
    "organization_has_multiple_providers": true
  }
}
```

```json Result Object Description theme={null}
{
  "$result_object_key": {
    "has_forms_after_welcome": "Indicates if there are forms to complete after the welcome screen",
    "id": "Unique identifier for the onboarding flow",
    "name": "Name of the onboarding flow",
    "onboarding_items": {
      "completed_form_id": "ID of the form used for completion",
      "completed_onboarding_item": {
        "id": "Unique identifier for the completed onboarding item",
        "item_id": "ID of the associated onboarding item",
        "item_type": "The type of item that was completed",
        "onboarding_item": null,
        "skipped": "Set to true if the user skipped this item",
        "user_id": "The ID of the completer (client)"
      },
      "display_name": "Display name of the onboarding item",
      "id": "Unique identifier for the onboarding item",
      "incomplete_custom_module_form_id": "ID of the custom module form that needs to be completed",
      "is_last_item": "Indicates if this is the last item in the onboarding flow",
      "item_id": "Secondary identifier for the onboarding item"
    },
    "organization_has_multiple_providers": "Indicates if the organization has multiple providers"
  }
}
```

### Result Object Field Details

You can use the result of the action's data as inputs to downstream workflow actions.

Each fetch action requires an object name, which nests the action's result data inside the downstream data context in the workflow. See [Passing Data Between Actions](https://docs.morf.health/docs/knowledge_base/passing_data_between_actions.md) for how to set it and reference the result from downstream nodes.

Here we demonstrate how to refer to this data using the prefix `$result_object_key`.

**OnboardingFlow** `Fetch Action Response Object`

**fields**

**id** `string` *required*

Unique identifier for the onboarding flow

```json CEL theme={null}
$result_object_key.id
```

```json Example theme={null}
"567890"
```

**name** `string`

Name of the onboarding flow

```json CEL theme={null}
$result_object_key.name
```

```json Example theme={null}
"New Patient Onboarding"
```

**organization\_has\_multiple\_providers** `bool` *required*

Indicates if the organization has multiple providers

```json CEL theme={null}
$result_object_key.organization_has_multiple_providers
```

```json Example theme={null}
true
```

**has\_forms\_after\_welcome** `bool` *required*

Indicates if there are forms to complete after the welcome screen

```json CEL theme={null}
$result_object_key.has_forms_after_welcome
```

```json Example theme={null}
true
```

**onboarding\_items** `[]object` *required*

List of onboarding items in this flow

```json CEL theme={null}
$result_object_key.onboarding_items
```

```json Example theme={null}
[
{
"completed_form_id": "123456",
"completed_onboarding_item": {
"id": "123456",
"item_id": "789012",
"item_type": "CustomModuleForm",
"onboarding_item": null,
"skipped": false,
"user_id": "345678"
},
"display_name": "Complete Initial Assessment",
"id": "456789",
"incomplete_custom_module_form_id": "234567",
"is_last_item": false,
"item_id": "345678"
}
]
```

**onboarding\_items.map(x, x.id)** `[]string` *required*

Mapped array of: Unique identifier for the onboarding item

```json CEL theme={null}
$result_object_key.onboarding_items.map(x, x.id)
```

```json Example theme={null}
[
"456789"
]
```

**onboarding\_items.map(x, x.item\_id)** `[]string` *required*

Mapped array of: Secondary identifier for the onboarding item

```json CEL theme={null}
$result_object_key.onboarding_items.map(x, x.item_id)
```

```json Example theme={null}
[
"345678"
]
```

**onboarding\_items.map(x, x.display\_name)** `[]string` *required*

Mapped array of: Display name of the onboarding item

```json CEL theme={null}
$result_object_key.onboarding_items.map(x, x.display_name)
```

```json Example theme={null}
[
"Complete Initial Assessment"
]
```

**onboarding\_items.map(x, x.incomplete\_custom\_module\_form\_id)** `[]string` *required*

Mapped array of: ID of the custom module form that needs to be completed

```json CEL theme={null}
$result_object_key.onboarding_items.map(x, x.incomplete_custom_module_form_id)
```

```json Example theme={null}
[
"234567"
]
```

**onboarding\_items.map(x, x.is\_last\_item)** `[]bool` *required*

Mapped array of: Indicates if this is the last item in the onboarding flow

```json CEL theme={null}
$result_object_key.onboarding_items.map(x, x.is_last_item)
```

```json Example theme={null}
[
false
]
```

**onboarding\_items.map(x, x.completed\_onboarding\_item)** `[]bool` *required*

Mapped array of: Information about the completion status of this item

```json CEL theme={null}
$result_object_key.onboarding_items.map(x, x.completed_onboarding_item)
```

```json Example theme={null}
[
{
"id": "123456",
"item_id": "789012",
"item_type": "CustomModuleForm",
"onboarding_item": {
"completed_form_id": "123456",
"completed_onboarding_item": null,
"display_name": "Complete Initial Assessment",
"id": "456789",
"incomplete_custom_module_form_id": "234567",
"is_last_item": false,
"item_id": "345678"
},
"skipped": false,
"user_id": "345678"
}
]
```

**onboarding\_items.map(x, x.completed\_form\_id)** `[]string` *required*

Mapped array of: ID of the form used for completion

```json CEL theme={null}
$result_object_key.onboarding_items.map(x, x.completed_form_id)
```

```json Example theme={null}
[
"123456"
]
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.