Fax Logs
List fax logs
List the available logs.
Permissions
The API token used to authenticate must have the following scope(s) enabled to make a successful request: Fax.
Learn more about API scopes.
get/api/fax/logs
Query parameters
include_deletedboolean
Include logs for deleted activity.
created_beforestring
Return logs for activity prior to this date.
created_onstring
Return logs for activity on this date.
created_afterstring
Return logs for activity after this date.
page_sizeinteger
Specify the number of results to return on a single page. The default page size is 50 and the maximum is 1000.
page_numberinteger
Page number to retrieve. Requires page_token when greater than 0.
page_tokenstring
Token for cursor-based pagination. Required when page_number is greater than 0. The token is returned in pagination links.
Response
The request has succeeded.
Example response
{
"links": {
"self": "https://example.signalwire.com/api/fax/logs?page_number=0&page_size=50",
"first": "https://example.signalwire.com/api/fax/logs?page_size=50",
"next": "https://example.signalwire.com/api/fax/logs?page_number=1&page_size=50&page_token=PAbff61159-faab-48b3-959a-3021a8f5beca",
"prev": "https://example.signalwire.com/api/fax/logs?page_number=0&page_size=50&page_token=PBbff61159-faab-48b3-959a-3021a8f5beca"
},
"data": [
{
"from": "+12065551212",
"to": "+12065553434",
"status": "completed",
"direction": "inbound",
"source": "laml",
"type": "laml_call",
"url": "https://example.signalwire.com/api/laml/2010-04-01/Accounts/b7182dc2-00f3-40e4-a5ce-20f164b329df/Faxes/c9a1d3e4-56f7-89ab-cdef-0123456789ab",
"charge": 0.01,
"number_of_pages": 2,
"quality": "fine",
"charge_details": [],
"created_at": "2024-05-06T12:20:00Z",
"error_code": "34004",
"error_message": "The call dropped prematurely"
}
]
}