List Fax Inbox
Perform List Fax Inbox through NikoHealth.
nikohealth_list_fax_inboxreadnikohealth
Inputs
- Page Size
page_sizenumberOptional numeric value.
Default:
100 - Max Pages
max_pagesnumberOptional numeric value.
Default:
50 - Date From
date_fromdateOptional date in YYYY-MM-DD format.
- Date To
date_todateOptional date in YYYY-MM-DD format.
- Status
statustextOptional text value.
- Sort Expression
sort_expressiontextOptional text value.
Default:
"ReceivedDate DESC" - Require Complete
require_completebooleanOptional true-or-false value.
Default:
false
Outputs
successSuccessfaxesFaxescountCountpages_fetchedPages FetchedtruncatedTruncatederrorError
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
}