BLbluehive-health
Fax Management

Search Faxes

Changed on

Search faxes with optional filtering and pagination.

get/v1/fax

Request

Query parameters

pageinteger
pageSizeinteger
idstring

Filter by exact document ID (_id)

faxIdstring

Filter by exact fax ID

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)

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

Response

Default Response

Changes

  • a8bcbdf02e33Revision changes
    • warning

      deleted the query request parameter to

    • warning

      deleted the query request parameter toContains

  • 4957c5539c5eRevision changes
    • info

      added the new optional query request parameter to

    • info

      added the new optional query request parameter toContains