For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Log inSign up
Support
  • Core
    • Overview
    • Authorization
    • Base URL
    • Data formats
    • Paging
    • Error codes
    • Permissions
  • Calling
  • Datasphere
  • Logs
      • GETGet fax log
      • GETList fax logs
  • Messaging
  • Phone Number Management
  • Platform
  • Resource Management
LogoLogoSignalWire Docs
Log inSign up
Support
LogsFax Logs

List fax logs

|View as Markdown|Open in Claude|
GET
https://{your_space_name}.signalwire.com/api/fax/logs
GET
/api/fax/logs
$curl https://{your_space_name}.signalwire.com/api/fax/logs \
>     -u "<project_id>:<api_token>"
1{
2  "links": {
3    "self": "https://example.signalwire.com/api/fax/logs?page_number=0&page_size=50",
4    "first": "https://example.signalwire.com/api/fax/logs?page_size=50",
5    "next": "https://example.signalwire.com/api/fax/logs?page_number=1&page_size=50&page_token=PAbff61159-faab-48b3-959a-3021a8f5beca",
6    "prev": "https://example.signalwire.com/api/fax/logs?page_number=0&page_size=50&page_token=PBbff61159-faab-48b3-959a-3021a8f5beca"
7  },
8  "data": [
9    {
10      "id": "b7182dc2-00f3-40e4-a5ce-20f164b329df",
11      "from": "+12065551212",
12      "to": "+12065553434",
13      "status": "completed",
14      "direction": "inbound",
15      "source": "laml",
16      "type": "laml_call",
17      "url": "https://example.signalwire.com/api/laml/2010-04-01/Accounts/b7182dc2-00f3-40e4-a5ce-20f164b329df/Faxes/c9a1d3e4-56f7-89ab-cdef-0123456789ab",
18      "remote_station": null,
19      "charge": 0.01,
20      "number_of_pages": 2,
21      "quality": "fine",
22      "charge_details": [],
23      "created_at": "2024-05-06T12:20:00Z",
24      "error_code": "34004",
25      "error_message": "The call dropped prematurely"
26    }
27  ]
28}

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.

Was this page helpful?
Previous

Get message log

Next
Built with

Authentication

AuthorizationBasic
SignalWire Basic Authentication using Project ID and API Token. The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password. Example: ``` Authorization: Basic base64(project_id:token) ```

Query parameters

include_deletedbooleanOptionalDefaults to false
Include logs for deleted activity.
created_beforestringOptional
Return logs for activity prior to this date.
created_onstringOptional
Return logs for activity on this date.
created_afterstringOptional
Return logs for activity after this date.
page_sizeintegerOptional1-1000Defaults to 50

Specify the number of results to return on a single page. The default page size is 50 and the maximum is 1000.

page_numberintegerOptional>=0Defaults to 0

Page number to retrieve. Requires page_token when greater than 0.

page_tokenstringOptional

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.
linksobject
Object containing pagination links
datalist of objects
Array of log data

Errors

400
Bad Request Error
401
Unauthorized Error
422
Unprocessable Entity Error
500
Internal Server Error

SignalWire Basic Authentication using Project ID and API Token.

The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password.

Example:

Authorization: Basic base64(project_id:token)