Skip to main content
images/intakeq.svg

Parameters

Action
Parameters
{
  "$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"
  }
}
{
  "$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 a result object key to be specified which will nest the action’s result data inside the downstream data context in the Workflow. Here we demonstrate how to refer to this data using the prefix $result_object_key.
Note
Fetch Action Response Object