v52

OpenAPI 3.1.0raw.githubusercontent.com2026-07-311,1941,9384.1 MB

Programmable Fax Commands

View a list of faxes

get/faxes

Query parameters

Consolidated filter parameter (deepObject style). Originally: filter[created_at][gte], filter[created_at][gt], filter[created_at][lte], filter[created_at][lt], filter[direction][eq], filter[from][eq], filter[to][eq]

{
  "created_at": {
    "gt": "2020-02-02T22:25:27.521992Z",
    "gte": "2020-02-02T22:25:27.521992Z",
    "lt": "2020-02-02T22:25:27.521992Z",
    "lte": "2020-02-02T22:25:27.521992Z"
  },
  "direction": {
    "eq": "inbound"
  },
  "from": {
    "eq": "+13127367276"
  },
  "to": {
    "eq": "+13127367276"
  }
}

numberinteger

Number of the page to be retrieved

sizeinteger

Number of fax resources for the single page returned

Consolidated pagination parameter (deepObject style). Originally: page[size], page[number]

{
  "number": 2,
  "size": 2
}

Response

List faxes response

Example response

{
  "data": [
    {
      "client_state": "aGF2ZSBhIG5pY2UgZGF5ID1d",
      "connection_id": "c-1",
      "created_at": "2020-05-05T09:59:12Z",
      "direction": "outbound",
      "failure_reason": null,
      "from": "+123",
      "id": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0",
      "internal_failure_reason": null,
      "media_url": "http://www.example.com/fax.pdf",
      "preview_url": "https://s3.amazonaws.com/faxes-dev/user-1/cf4a6b52-bf8e-4945-9f49-611d0d2b083b_preview.tiff?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=xxxxxxxxxx%2F20200505%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20200505T095917Z&X-Amz-Expires=7200&X-Amz-SignedHeaders=host&X-Amz-Signature=fac2af40464fcc77673ad762db86e34f9c1b91a82699b5578c5327f53874df51",
      "quality": "high",
      "record_type": "fax",
      "status": "queued",
      "store_media": true,
      "stored_media_url": "https://s3.amazonaws.com/faxes-dev/user-1/cf4a6b52-bf8e-4945-9f49-611d0d2b083b.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=xxxxxxxxxx%2F20200505%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20200505T095917Z&X-Amz-Expires=7200&X-Amz-SignedHeaders=host&X-Amz-Signature=fac2af40464fcc77673ad762db86e34f9c1b91a82699b5578c5327f53874df51",
      "to": "+456",
      "updated_at": "2020-05-05T09:59:12Z",
      "webhook_failover_url": "",
      "webhook_url": "http://www.example.com/webhooks"
    }
  ],
  "meta": {
    "page_number": 2,
    "page_size": 25,
    "total_pages": 3,
    "total_results": 55
  }
}