# List Fax Inbox

> Perform List Fax Inbox through NikoHealth.

Source: [https://genhealth.ai/docs/workflows/integrations/nikohealth/nikohealth_list_fax_inbox](https://genhealth.ai/docs/workflows/integrations/nikohealth/nikohealth_list_fax_inbox)

Integration: [NikoHealth](https://genhealth.ai/docs/workflows/integrations/nikohealth.md)

- Handler: `nikohealth_list_fax_inbox`

- Connection type: `nikohealth`

## Inputs

- `page_size` — Page Size (number)
  Optional numeric value.
  Default: `100`
- `max_pages` — Max Pages (number)
  Optional numeric value.
  Default: `50`
- `date_from` — Date From (date)
  Optional date in YYYY-MM-DD format.
- `date_to` — Date To (date)
  Optional date in YYYY-MM-DD format.
- `status` — Status (text)
  Optional text value.
- `sort_expression` — Sort Expression (text)
  Optional text value.
  Default: `"ReceivedDate DESC"`
- `require_complete` — Require Complete (boolean)
  Optional true-or-false value.
  Default: `false`

## Outputs

- `success` — Success
- `faxes` — Faxes
- `count` — Count
- `pages_fetched` — Pages Fetched
- `truncated` — Truncated
- `error` — Error

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

```json
{
  "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

```json
{
  "type": "object",
  "properties": {
    "count": {},
    "error": {},
    "faxes": {},
    "success": {},
    "truncated": {},
    "pages_fetched": {}
  },
  "additionalProperties": true
}
```