v46

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-011274550.0 KB

Fax Management

Search Faxes

Search faxes with optional filtering and pagination.

get/v1/fax

pageinteger

pageSizeinteger

idstring

Filter by exact document ID (_id)

faxIdstring

Filter by exact fax ID

tostring

Filter by exact recipient fax number

status'received' | 'queued' | 'processing' | 'completed' | 'error'

Filter by fax processing status

brandIdstring

Filter by exact brand ID

idContainsstring

Filter by document ID containing this value (case-insensitive)

faxIdContainsstring

Filter by fax ID containing this value (case-insensitive)

toContainsstring

Filter by recipient fax number containing this value (case-insensitive)

brandIdContainsstring

Filter by brand ID containing this value (case-insensitive)

brandIdIsNullboolean

Filter for faxes where brandId is null or not set

sincestring date-time

Filter faxes received after this time

untilstring date-time

Filter faxes received before this time

Default Response