1. faxes
AFAX-v4
  • AFAX API V4
    • Documents
    • oauth
      • /oauth/token
    • faxes
      • /faxes
        POST
      • /faxes/binary
        POST
      • /faxes/{rfid}/cancel
        POST
      • /faxes
        GET
      • /faxes/{rfid}
        GET
      • /faxes/{rfid}/media
        GET
      • /faxes/{rfid}
        DELETE
    • webhooks
      • /webhooks
      • /webhooks
      • /webhooks/signing-secret
      • /webhooks/signing-secret
      • /webhooks/signing-secret/rotate
      • /webhooks/{id}
      • /webhooks/{id}
      • /webhooks/{id}/deliveries
      • /webhooks/{id}/rotate-secret
    • system
      • /system/health
    • Schemas
      • Webhook.WriteRequest
      • Webhook.Created
      • Webhook.AFAXWebhook
      • Webhook.SecretCreated
      • Webhook.SecretStatus
      • Webhook.Delivery
      • FaxSubmission.CreateFaxRequest
      • FaxSubmission.FaxSender
      • FaxSubmission.FaxRecipient
      • FaxSubmission.FaxDocumentSource
      • FaxSubmission.FaxCoverPage
      • FaxSubmission.CreateFaxResponse
      • FaxSubmission.FaxResourceLinks
      • FaxResult.FaxResult
      • FaxResult.FaxDocumentTotals
      • FaxResult.FaxOutcome
      • FaxResult.FaxResultPage
      • FaxResult.FaxLifecycleResponse
      • Auth.TokenResponse
  1. faxes

/faxes

GET
/faxes

Request

Query Params

Responses

🟢200
application/json
Successful response
Bodyapplication/json

Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://api.faxlink.ca/afx/v4//faxes?page=&pageSize=&status='
Response Response Example
{
    "items": [
        {
            "rfid": "string",
            "status": "string",
            "contentStatus": "string",
            "clientReference": "string",
            "fromFaxNumber": "string",
            "toFaxNumbers": [
                "string"
            ],
            "documents": {
                "count": 0,
                "pages": 0,
                "totalSizeBytes": 0
            },
            "retryCount": 0,
            "durationSeconds": 0,
            "queuedAt": "string",
            "sendFaxAtDateTime": "string",
            "startedAt": "string",
            "completedAt": "string",
            "farEndId": "string",
            "result": {
                "code": "string",
                "reason": "string"
            }
        }
    ],
    "page": 0,
    "pageSize": 0,
    "total": 0
}
Modified at 2026-09-15 22:26:45
Previous
/faxes/{rfid}/cancel
Next
/faxes/{rfid}
Built with