Skip to documentation
NikoHealth integration

List Fax Inbox

Perform List Fax Inbox through NikoHealth.

View as Markdown
nikohealth_list_fax_inbox
readnikohealth

Inputs

  • page_size
    number
    Page Size

    Optional numeric value.

    Default: 100

  • max_pages
    number
    Max Pages

    Optional numeric value.

    Default: 50

  • date_from
    date
    Date From

    Optional date in YYYY-MM-DD format.

  • date_to
    date
    Date To

    Optional date in YYYY-MM-DD format.

  • status
    text
    Status

    Optional text value.

  • sort_expression
    text
    Sort Expression

    Optional text value.

    Default: "ReceivedDate DESC"

  • require_complete
    boolean
    Require Complete

    Optional true-or-false value.

    Default: false

Outputs

  • successSuccess
  • faxesFaxes
  • countCount
  • pages_fetchedPages Fetched
  • truncatedTruncated
  • errorError

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": {
    "status": {
      "type": "string",
      "description": "Optional text value.",
      "x-workflow-field-type": "text"
    },
    "date_to": {
      "type": "string",
      "format": "date",
      "description": "Optional date in YYYY-MM-DD format.",
      "x-workflow-field-type": "date"
    },
    "date_from": {
      "type": "string",
      "format": "date",
      "description": "Optional date in YYYY-MM-DD format.",
      "x-workflow-field-type": "date"
    },
    "max_pages": {
      "type": "number",
      "default": 50,
      "description": "Optional numeric value.",
      "x-workflow-field-type": "number"
    },
    "page_size": {
      "type": "number",
      "default": 100,
      "description": "Optional numeric value.",
      "x-workflow-field-type": "number"
    },
    "sort_expression": {
      "type": "string",
      "default": "ReceivedDate DESC",
      "description": "Optional text value.",
      "x-workflow-field-type": "text"
    },
    "require_complete": {
      "type": "boolean",
      "default": false,
      "description": "Optional true-or-false value.",
      "x-workflow-field-type": "boolean"
    }
  },
  "additionalProperties": false
}
Output schema
{
  "type": "object",
  "properties": {
    "count": {},
    "error": {},
    "faxes": {},
    "success": {},
    "truncated": {},
    "pages_fetched": {}
  },
  "additionalProperties": true
}
View all NikoHealth actions