Brightree integration

List Inbound Faxes

Perform List Inbound Faxes through Brightree.

View as Markdown

brightree_list_inbound_faxes

readbrightree

Inputs

received_date_from
date
Received Date From
Optional date in YYYY-MM-DD format.
Default: "2026-08-13"
received_date_to
date
Received Date To
Optional date in YYYY-MM-DD format.
Default: "2026-08-13"
work_status
text
Work Status
Optional text value.
show_unassigned
boolean
Show Unassigned
Optional true-or-false value.
branch_offices
multi_selectdynamic options
Branch Offices
Optional list of selected values. Retrieve allowed values from the dynamic options endpoint.
exclude_nonempty_report_type
boolean
Exclude Nonempty Report Type
Optional true-or-false value.
max_pages
number
Max Pages
Optional numeric value.
Default: 50
max_items
number
Max Items
Optional numeric value.

Outputs

faxesFaxes
countCount
total_itemsTotal Items
total_pagesTotal Pages
has_moreHas More
messageMessage

Output schema completeness: best_effort_declared

Safety

External effect: read
Confirmation recommended: No
Retry safe: Yes
Dry run supported: No

Schemas

These schemas are first-pass authoring guidance. Runtime validation remains authoritative.

Input schema

{
  "type": "object",
  "properties": {
    "max_items": {
      "type": "number",
      "description": "Optional numeric value.",
      "x-workflow-field-type": "number"
    },
    "max_pages": {
      "type": "number",
      "default": 50,
      "description": "Optional numeric value.",
      "x-workflow-field-type": "number"
    },
    "work_status": {
      "type": "string",
      "description": "Optional text value.",
      "x-workflow-field-type": "text"
    },
    "branch_offices": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Optional list of selected values. Retrieve allowed values from the dynamic options endpoint.",
      "x-dynamic-options": true,
      "x-workflow-field-type": "multi_select"
    },
    "show_unassigned": {
      "type": "boolean",
      "description": "Optional true-or-false value.",
      "x-workflow-field-type": "boolean"
    },
    "received_date_to": {
      "type": "string",
      "format": "date",
      "default": "2026-08-13",
      "description": "Optional date in YYYY-MM-DD format.",
      "x-workflow-field-type": "date"
    },
    "received_date_from": {
      "type": "string",
      "format": "date",
      "default": "2026-08-13",
      "description": "Optional date in YYYY-MM-DD format.",
      "x-workflow-field-type": "date"
    },
    "exclude_nonempty_report_type": {
      "type": "boolean",
      "description": "Optional true-or-false value.",
      "x-workflow-field-type": "boolean"
    }
  },
  "additionalProperties": false
}

Output schema

{
  "type": "object",
  "properties": {
    "count": {},
    "faxes": {},
    "message": {},
    "has_more": {},
    "total_items": {},
    "total_pages": {}
  },
  "additionalProperties": true
}

View all Brightree actions