List Faxes API Reference

Serverhttps://api.pinnacle.sh/

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.

Authorization

Pinnacle API key

PINNACLE-API-KEY<token>

In: header

Query Parameters

limitintegerOptional

Maximum logical faxes to return. Defaults to 25.

Range

1 <= value <= 100

Default

offsetintegerOptional

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

Range

0 <= value <= 100000

Default

directionstringOptional

Return only inbound or outbound logical faxes.

Allowed values

"INBOUND""OUTBOUND"

Response Body

`application/json`

Pinnacle client libraries

import { PinnacleClient } from "rcs-js";

const client = new PinnacleClient({
  apiKey: process.env.PINNACLE_API_KEY!,
  baseUrl: process.env.PINNACLE_HIPAA_API_URL!,
});

await client.faxes.list();

Responses

{  "data": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "direction": "INBOUND",      "from": "string",      "to": "string",      "status": "PREPARING",      "pages": 0,      "durationSeconds": 0,      "partialContent": true,      "failureReason": "MEDIA_PREPARATION_FAILED",      "cost": 0,      "reservedCost": 0,      "billingStatus": "PENDING",      "hasMedia": true,      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    }  ],  "nextOffset": 0}

List Faxes

AuthorizationCopy Anchor Link

Query ParametersCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

400application/json

401application/json

403application/json

500application/json

503application/json

Authorization

Query Parameters

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`