API ReferenceFax (HIPAA only)

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.

Authentication

PINNACLE-API-KEYstring
API Key authentication via header

Query parameters

limitintegerOptional1-100Defaults to 25
Maximum logical faxes to return. Defaults to 25.
offsetintegerOptional0-100000Defaults to 0

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

directionenumOptional
Return only inbound or outbound logical faxes.
Allowed values:

Response

Fax history.
datalist of objects
nextOffsetinteger or null>=0
Offset for the next page, or null when no more records exist.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
500
Internal Server Error
503
Service Unavailable Error