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

> Documentation for the Get Note action for Intakeq

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

# Parameters

**Action** `Parameters`

**parameters**

**Note ID** `string` *required*

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

```json Result Object Example theme={null}
{
  "$result_object_key": {
    "appointment_id": "54683513554",
    "client_email": "john.doe@example.com",
    "client_id": 12345,
    "client_name": "John Doe",
    "id": "note123",
    "last_modified_at": "2023-01-15T14:30:00Z",
    "note_name": "Initial Assessment",
    "practitioner_email": "doctor@example.com",
    "practitioner_id": "pract456",
    "practitioner_name": "Dr. Jane Smith",
    "questions": [
      {
        "answer": "Back pain",
        "attachments": [
          {
            "content_type": "application/pdf",
            "file_name": "medical_report.pdf",
            "id": "12342",
            "url": "https://example.com/attachment.pdf"
          }
        ],
        "client_profile_field_id": "primary_concern",
        "column_names": [
          "Symptom",
          "Severity"
        ],
        "id": "12342",
        "office_note": "Patient reported severe pain",
        "office_use": false,
        "question_type": "text",
        "rows": [
          {
            "answers": [
              "Back pain",
              "Severe"
            ],
            "text": "Back pain"
          }
        ],
        "text": "What is your primary concern?"
      }
    ],
    "status": "locked or unlocked",
    "timestamp": "2023-01-15T14:30:00Z"
  }
}
```

```json Result Object Description theme={null}
{
  "$result_object_key": {
    "appointment_id": "Identifier of the associated appointment",
    "client_email": "Email address of the client",
    "client_id": "Unique identifier for the client",
    "client_name": "Name of the client",
    "id": "Unique identifier for the note",
    "last_modified_at": "Timestamp when the note was last modified",
    "note_name": "Name of the note",
    "practitioner_email": "Email of the practitioner",
    "practitioner_id": "Unique identifier for the practitioner",
    "practitioner_name": "Name of the practitioner",
    "questions": {
      "answer": "Answer to the question",
      "attachments": {
        "content_type": "Content type of the attachment",
        "file_name": "Name of the attached file",
        "id": "Unique identifier for the attachment",
        "url": "URL of the attachment"
      },
      "client_profile_field_id": "ID of the client profile field this question maps to",
      "column_names": "Column names for table/grid questions",
      "id": "Unique identifier for the question",
      "office_note": "Office note for the question",
      "office_use": "Whether the question is for office use only",
      "question_type": "Type of the question",
      "rows": {
        "answers": "Answers for each column in the row",
        "text": "Text for the row"
      },
      "text": "Text of the question"
    },
    "status": "Status of the note",
    "timestamp": "Timestamp when the note was created (called `Date` in the IntakeQ API)"
  }
}
```

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

**Note** `Fetch Action Response Object`

**fields**

**id** `string` *required*

Unique identifier for the note

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

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

**client\_name** `string`

Name of the client

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

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

**client\_email** `string`

Email address of the client

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

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

**client\_id** `int64` *required*

Unique identifier for the client

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

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

**status** `string` *required*

Status of the note

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

```json Example theme={null}
"locked or unlocked"
```

**timestamp** `timing.v1.Timestamp` *required*

Timestamp when the note was created (called `Date` in the IntakeQ API)

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

```json Example theme={null}
"2023-01-15T14:30:00Z"
```

**note\_name** `string`

Name of the note

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

```json Example theme={null}
"Initial Assessment"
```

**practitioner\_email** `string`

Email of the practitioner

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

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

**practitioner\_name** `string`

Name of the practitioner

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

```json Example theme={null}
"Dr. Jane Smith"
```

**practitioner\_id** `string`

Unique identifier for the practitioner

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

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

**questions** `[]object` *required*

Questions included in the note

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

```json Example theme={null}
[
{
"answer": "Back pain",
"attachments": [
{
  "content_type": "application/pdf",
  "file_name": "medical_report.pdf",
  "id": "12342",
  "url": "https://example.com/attachment.pdf"
}
],
"client_profile_field_id": "primary_concern",
"column_names": [
"Symptom",
"Severity"
],
"id": "12342",
"office_note": "Patient reported severe pain",
"office_use": false,
"question_type": "text",
"rows": [
{
  "answers": [
    "Back pain",
    "Severe"
  ],
  "text": "Back pain"
}
],
"text": "What is your primary concern?"
}
]
```

**questions.map(x, x.id)** `[]string` *required*

Mapped array of: Unique identifier for the question

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

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

**questions.map(x, x.text)** `[]string` *required*

Mapped array of: Text of the question

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

```json Example theme={null}
[
"What is your primary concern?"
]
```

**questions.map(x, x.answer)** `[]string` *required*

`HI` Mapped array of: Answer to the question

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

```json Example theme={null}
[
"Back pain"
]
```

**questions.map(x, x.question\_type)** `[]string` *required*

Mapped array of: Type of the question

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

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

**questions.map(x, x.rows)** `[]bool` *required*

`HI` Mapped array of: Rows for table/grid questions

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

```json Example theme={null}
[
[
{
"answers": [
  "Back pain",
  "Severe"
],
"text": "Back pain"
}
]
]
```

**questions.map(x, x.column\_names)** `[]bool` *required*

Mapped array of: Column names for table/grid questions

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

```json Example theme={null}
[
[
"Symptom",
"Severity"
]
]
```

**questions.map(x, x.office\_use)** `[]bool` *required*

Mapped array of: Whether the question is for office use only

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

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

**questions.map(x, x.office\_note)** `[]string` *required*

Mapped array of: Office note for the question

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

```json Example theme={null}
[
"Patient reported severe pain"
]
```

**questions.map(x, x.client\_profile\_field\_id)** `[]string` *required*

Mapped array of: ID of the client profile field this question maps to

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

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

**questions.map(x, x.attachments)** `[]bool` *required*

`HI` Mapped array of: Attachments associated with the question

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

```json Example theme={null}
[
[
{
"content_type": "application/pdf",
"file_name": "medical_report.pdf",
"id": "12342",
"url": "https://example.com/attachment.pdf"
}
]
]
```

**appointment\_id** `string`

Identifier of the associated appointment

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

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

**last\_modified\_at** `timing.v1.Timestamp` *required*

Timestamp when the note was last modified

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

```json Example theme={null}
"2023-01-15T14:30:00Z"
```


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