# List fax logs

GET https://%7BYour_Space_Name%7D.signalwire.com/api/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](/docs/platform/your-signalwire-api-space).

Reference: https://signalwire.com/docs/apis/rest/fax-logs/list-fax-logs

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: signalwire-rest
  version: 1.0.0
paths:
  /api/fax/logs:
    get:
      operationId: list-fax-logs
      summary: List fax logs
      description: >-
        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](/docs/platform/your-signalwire-api-space).
      tags:
        - subpackage_faxLogs
      parameters:
        - name: include_deleted
          in: query
          description: Include logs for deleted activity.
          required: false
          schema:
            type: boolean
            default: false
        - name: created_before
          in: query
          description: Return logs for activity prior to this date.
          required: false
          schema:
            type: string
        - name: created_on
          in: query
          description: Return logs for activity on this date.
          required: false
          schema:
            type: string
        - name: created_after
          in: query
          description: Return logs for activity after this date.
          required: false
          schema:
            type: string
        - name: page_size
          in: query
          description: >-
            Specify the number of results to return on a single page. The
            default page size is `50` and the maximum is `1000`.
          required: false
          schema:
            type: integer
            default: 50
        - name: page_number
          in: query
          description: >-
            Page number to retrieve. Requires `page_token` when greater than
            `0`.
          required: false
          schema:
            type: integer
            default: 0
        - name: page_token
          in: query
          description: >-
            Token for cursor-based pagination. Required when `page_number` is
            greater than `0`. The token is returned in pagination links.
          required: false
          schema:
            type: string
        - name: Authorization
          in: header
          description: >-
            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)

            ```
          required: true
          schema:
            type: string
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Fax.LogListResponse'
        '400':
          description: The request is invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.StatusCode400'
        '401':
          description: Access is unauthorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.StatusCode401'
        '422':
          description: The request contains invalid parameters. See errors for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Fax.FaxLogsListStatusCode422'
        '500':
          description: An internal server error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.StatusCode500'
servers:
  - url: https://%7BYour_Space_Name%7D.signalwire.com
components:
  schemas:
    Fax.LogPaginationResponse:
      type: object
      properties:
        self:
          type: string
          description: URL for the current page of results.
        first:
          type: string
          description: URL for the first page of results.
        next:
          type: string
          description: >-
            URL for the next page of results. Only present when more results are
            available.
        prev:
          type: string
          description: >-
            URL for the previous page of results. Only present when on page 1 or
            later.
      required:
        - self
        - first
      title: Fax.LogPaginationResponse
    uuid:
      type: string
      format: uuid
      description: Universal Unique Identifier.
      title: uuid
    FaxFaxLogStatus:
      type: string
      enum:
        - queued
        - initiated
        - ringing
        - in-progress
        - busy
        - failed
        - no-answer
        - canceled
        - completed
      description: The status of this fax call.
      title: FaxFaxLogStatus
    FaxFaxLogDirection:
      type: string
      enum:
        - inbound
        - outbound-api
        - outbound-dial
      description: The direction of this fax call.
      title: FaxFaxLogDirection
    FaxFaxLogSource:
      type: string
      enum:
        - laml
      description: Source of this log entry.
      title: FaxFaxLogSource
    FaxFaxLogType:
      type: string
      enum:
        - laml_call
      description: Type of this log entry.
      title: FaxFaxLogType
    FaxFaxLogQuality:
      type: string
      enum:
        - fine
        - standard
        - superfine
      description: The quality that was set when the fax document was sent.
      title: FaxFaxLogQuality
    Fax.ChargeDetail:
      type: object
      properties:
        description:
          type: string
          description: Description for this charge.
        charge:
          type: number
          format: double
          description: Charged amount.
      required:
        - description
        - charge
      title: Fax.ChargeDetail
    Fax.FaxLog:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/uuid'
          description: A unique identifier for the log
        from:
          type:
            - string
            - 'null'
          description: The origin phone number in E.164 format.
        to:
          type:
            - string
            - 'null'
          description: The destination phone number in E.164 format.
        status:
          $ref: '#/components/schemas/FaxFaxLogStatus'
          description: The status of this fax call.
        direction:
          oneOf:
            - $ref: '#/components/schemas/FaxFaxLogDirection'
            - type: 'null'
          description: The direction of this fax call.
        source:
          $ref: '#/components/schemas/FaxFaxLogSource'
          description: Source of this log entry.
        type:
          $ref: '#/components/schemas/FaxFaxLogType'
          description: Type of this log entry.
        url:
          type: string
          format: uri
          description: URL for the associated fax resource with this log entry.
        remote_station:
          type:
            - string
            - 'null'
          description: Represents a customer hosted Fax server.
        charge:
          type: number
          format: double
          description: The amount charged for this fax request.
        number_of_pages:
          type:
            - integer
            - 'null'
          description: The number of pages the fax document contained.
        quality:
          oneOf:
            - $ref: '#/components/schemas/FaxFaxLogQuality'
            - type: 'null'
          description: The quality that was set when the fax document was sent.
        charge_details:
          type: array
          items:
            $ref: '#/components/schemas/Fax.ChargeDetail'
          description: Details on charges associated with this log.
        created_at:
          type: string
          format: date-time
          description: Date and time when the fax was created.
        error_code:
          type:
            - string
            - 'null'
          description: Error code for this resource (if available).
        error_message:
          type:
            - string
            - 'null'
          description: The description of this error (if available).
      required:
        - id
        - from
        - to
        - status
        - direction
        - source
        - type
        - url
        - remote_station
        - charge
        - number_of_pages
        - quality
        - charge_details
        - created_at
        - error_code
        - error_message
      title: Fax.FaxLog
    Fax.LogListResponse:
      type: object
      properties:
        links:
          $ref: '#/components/schemas/Fax.LogPaginationResponse'
          description: Object containing pagination links
        data:
          type: array
          items:
            $ref: '#/components/schemas/Fax.FaxLog'
          description: Array of log data
      required:
        - links
        - data
      title: Fax.LogListResponse
    TypesStatusCodesStatusCode400Error:
      type: string
      enum:
        - Bad Request
      title: TypesStatusCodesStatusCode400Error
    Types.StatusCodes.StatusCode400:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/TypesStatusCodesStatusCode400Error'
      required:
        - error
      description: The request is invalid.
      title: Types.StatusCodes.StatusCode400
    TypesStatusCodesStatusCode401Error:
      type: string
      enum:
        - Unauthorized
      title: TypesStatusCodesStatusCode401Error
    Types.StatusCodes.StatusCode401:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/TypesStatusCodesStatusCode401Error'
      required:
        - error
      description: Access is unauthorized.
      title: Types.StatusCodes.StatusCode401
    Types.StatusCodes.RestApiErrorItem:
      type: object
      properties:
        type:
          type: string
          description: The category of error.
        code:
          type: string
          description: A specific error code.
        message:
          type: string
          description: A description of what caused the error.
        attribute:
          type:
            - string
            - 'null'
          description: The request parameter that caused the error, if applicable.
        url:
          type: string
          description: A link to documentation about this error.
      required:
        - type
        - code
        - message
        - url
      description: Details about a specific error.
      title: Types.StatusCodes.RestApiErrorItem
    Fax.FaxLogsListStatusCode422:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Types.StatusCodes.RestApiErrorItem'
          description: List of validation errors.
      required:
        - errors
      description: The request contains invalid parameters. See errors for details.
      title: Fax.FaxLogsListStatusCode422
    TypesStatusCodesStatusCode500Error:
      type: string
      enum:
        - Internal Server Error
      title: TypesStatusCodesStatusCode500Error
    Types.StatusCodes.StatusCode500:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/TypesStatusCodesStatusCode500Error'
      required:
        - error
      description: An internal server error occurred.
      title: Types.StatusCodes.StatusCode500
  securitySchemes:
    SignalWireBasicAuth:
      type: http
      scheme: basic
      description: >-
        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)

        ```

```

## SDK Code Examples

```python
import requests
import base64

url = "https://{your_space_name}.signalwire.com/api/fax/logs"

credentials = base64.b64encode(f"<project_id>:<api_token>".encode()).decode()

headers = {"Authorization": f"Basic {credentials}"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://{your_space_name}.signalwire.com/api/fax/logs';
const credentials = btoa("<project_id>:<api_token>");

const options = {method: 'GET', headers: {Authorization: `Basic ${credentials}`}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{your_space_name}.signalwire.com/api/fax/logs"

	req, _ := http.NewRequest("GET", url, nil)

	req.SetBasicAuth("<project_id>", "<api_token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'base64'
require 'net/http'

url = URI("https://{your_space_name}.signalwire.com/api/fax/logs")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = "Basic #{Base64.strict_encode64("<project_id>:<api_token>")}"

response = http.request(request)
puts response.read_body
```

```java
import java.util.Base64;
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://{your_space_name}.signalwire.com/api/fax/logs")
  .header("Authorization", "Basic " + Base64.getEncoder().encodeToString("<project_id>:<api_token>".getBytes()))
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://{your_space_name}.signalwire.com/api/fax/logs', [
  'headers' => [
    'Authorization' => 'Basic ' . base64_encode('<project_id>:<api_token>'),
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;
using System;
using System.Text;

var client = new RestClient("https://{your_space_name}.signalwire.com/api/fax/logs");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Basic " + Convert.ToBase64String(Encoding.UTF8.GetBytes("<project_id>:<api_token>")));
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let credentials = Data("<project_id>:<api_token>".utf8).base64EncodedString()

let headers = ["Authorization": "Basic \(credentials)"]

let request = NSMutableURLRequest(url: NSURL(string: "https://{your_space_name}.signalwire.com/api/fax/logs")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```