> ## 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.

# Search Users

> Documentation for the Search Users 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**

**Keywords** `string` *required*

This field maps to the destination API `keywords` field.

**Active Status** `string`

This field maps to the destination API `active_status` field.

**Order By** `string`

This field maps to the destination API `order_by` field.

```json Result Object Example theme={null}
{
  "$result_object_key": [
    {
      "appointments": [
        {
          "appointment_datetime": "2024-08-17T10:30:00-04:00",
          "appointment_id": "604821",
          "created_at": "2024-08-15T10:31:01-04:00",
          "provider_id": "224404",
          "provider_name": "Dr. John Doe",
          "updated_at": "2024-08-15T10:31:01-04:00"
        }
      ],
      "date_of_birth": "1950-08-04",
      "email_address": "john.doe@example.com",
      "first_name": "John",
      "id": "131391",
      "last_name": "Doe",
      "record_identifier": "8e11f3ba-3167-4f47-a549-f43dc19df353"
    }
  ]
}
```

```json Result Object Description theme={null}
{
  "$result_object_key": [
    {
      "appointments": {
        "appointment_datetime": "Date and time of the Appointment",
        "appointment_id": "ID for the Appointment",
        "created_at": "Time the appointment was created",
        "provider_id": "ID of the Provider on the Appointment",
        "provider_name": "Name of the Provider on the Appointment",
        "updated_at": "Time the appointment was last updated"
      },
      "date_of_birth": "Date of birth of the User",
      "email_address": "Email address of the User",
      "first_name": "First name of the User",
      "id": "ID for the User",
      "last_name": "Last name of the User",
      "record_identifier": "Record identifier for the User (external unique patient ID reference)"
    }
  ]
}
```

### 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`.

**\[]UserSummary** `Fetch Action Response Object`

**fields**

**id** `string` *required*

`ID` ID for the User

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

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

**first\_name** `string`

`PII` First name of the User

```json CEL theme={null}
$result_object_key[*].first_name
```

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

**last\_name** `string`

`PII` Last name of the User

```json CEL theme={null}
$result_object_key[*].last_name
```

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

**email\_address** `string`

`PII` Email address of the User

```json CEL theme={null}
$result_object_key[*].email_address
```

```json Example theme={null}
"john.doe@example.com"
```

**record\_identifier** `string`

`ID` Record identifier for the User (external unique patient ID reference)

```json CEL theme={null}
$result_object_key[*].record_identifier
```

```json Example theme={null}
"8e11f3ba-3167-4f47-a549-f43dc19df353"
```

**date\_of\_birth** `values.v1.Date`

`PII` Date of birth of the User

```json CEL theme={null}
$result_object_key[*].date_of_birth
```

```json Example theme={null}
"1950-08-04"
```

**appointments** `[]object` *required*

List of appointments for the User

```json CEL theme={null}
$result_object_key[*].appointments
```

```json Example theme={null}
[
{
"appointment_datetime": "2024-08-17T10:30:00-04:00",
"appointment_id": "604821",
"created_at": "2024-08-15T10:31:01-04:00",
"provider_id": "224404",
"provider_name": "Dr. John Doe",
"updated_at": "2024-08-15T10:31:01-04:00"
}
]
```

**appointments.map(x, x.appointment\_id)** `[]string` *required*

Mapped array of: ID for the Appointment

```json CEL theme={null}
$result_object_key[*].appointments.map(x, x.appointment_id)
```

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

**appointments.map(x, x.appointment\_datetime)** `[]timing.v1.Timestamp` *required*

Mapped array of: Date and time of the Appointment

```json CEL theme={null}
$result_object_key[*].appointments.map(x, x.appointment_datetime)
```

```json Example theme={null}
[
"2024-08-17T10:30:00-04:00"
]
```

**appointments.map(x, x.provider\_id)** `[]string` *required*

Mapped array of: ID of the Provider on the Appointment

```json CEL theme={null}
$result_object_key[*].appointments.map(x, x.provider_id)
```

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

**appointments.map(x, x.provider\_name)** `[]string` *required*

Mapped array of: Name of the Provider on the Appointment

```json CEL theme={null}
$result_object_key[*].appointments.map(x, x.provider_name)
```

```json Example theme={null}
[
"Dr. John Doe"
]
```

**appointments.map(x, x.created\_at)** `[]timing.v1.Timestamp` *required*

Mapped array of: Time the appointment was created

```json CEL theme={null}
$result_object_key[*].appointments.map(x, x.created_at)
```

```json Example theme={null}
[
"2024-08-15T10:31:01-04:00"
]
```

**appointments.map(x, x.updated\_at)** `[]timing.v1.Timestamp` *required*

Mapped array of: Time the appointment was last updated

```json CEL theme={null}
$result_object_key[*].appointments.map(x, x.updated_at)
```

```json Example theme={null}
[
"2024-08-15T10:31:01-04:00"
]
```


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