UNunified
uc
fax

List all faxes

Changed on

Returns a list of UcFaxes. Narrow the results with the query parameters before paging, then page through them with limit and offset (the default and maximum page size depend on the integration). Use fields to return only the fields you need and reduce the response size. When the integration supports a total count, it is returned in the X-Total-Count response header. Use each item's id to retrieve, update, or delete it where those operations are supported.

get/uc/{connection_id}/fax

Request

Path parameters

connection_idstring required

ID of the connection

Query parameters

limitnumber
offsetnumber
updated_gtestring

Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

sortstring
orderstring
querystring

Query string to search. eg. email address or name

user_idstring

The user/employee ID to filter by (reference to HrisEmployee)

typestring
fieldsstring[]

Fields to return

rawstring

Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar

Response

Successful

idstring

Unique identifier for this fax object

created_atstring date-time

The date that this fax object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atstring date-time

The last date that this fax object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

type'INBOUND' | 'OUTBOUND'

Whether the fax was received (INBOUND) or sent (OUTBOUND)

status'QUEUED' | 'SENDING' | 'DELIVERED' | 'RECEIVING' | 'RECEIVED' | 'FAILED' | 'CANCELED' | 'OTHER'

The current or final status of the fax

from_telephonestring

The E.164 phone number the fax was sent from

to_telephonestring

The E.164 phone number the fax was sent to

pagesnumber

Number of pages in the fax

media_urlstring

URL of the fax document (PDF); on create, a public URL of the document to send

user_idstring

The user that sent or owns the fax (reference to HrisEmployee)

cost_amountnumber

What the integration charged for the fax

currencystring

ISO 4217 currency of cost_amount

error_messagestring

Why the fax failed

rawobject

The raw data returned by the integration for this fax

Changes