faxes

List Faxes

List your team's fax history, newest first.

HIPAA only: this endpoint exists only in Pinnacle's HIPAA cell and is unavailable at https://api.pinnacle.sh.

Results contain complete faxes only. Use nextOffset until it is null. The maximum page size is 100 records and the maximum offset is 100,000.

get/fax

Request

  • Base URL: https://api.pinnacle.sh
  • URL: https://api.pinnacle.sh/fax
  • Auth: API key in header PINNACLE-API-KEY

Query parameters

limitinteger

Maximum logical faxes to return. Defaults to 25.

offsetinteger

Zero-based number of logical faxes to skip. Defaults to 0.

direction'INBOUND' | 'OUTBOUND'

OUTBOUND for faxes sent by your team or INBOUND for faxes received by your team.

Return only inbound or outbound logical faxes.

Response

Fax history.

nextOffsetinteger nullable required

Offset for the next page, or null when no more records exist.

Changes

No recorded changes to this operation across all 1 revision of this API.