# Lists Faxes

GET https://api.hellosign.com/v3/fax/list

Returns properties of multiple Faxes

Reference: https://developer.hellosign.com/api/fax/list

## OpenAPI Specification

```yaml
openapi: 3.1.1
info:
  title: Lists Faxes
  version: endpoint_fax.list
paths:
  /fax/list:
    get:
      operationId: list
      summary: Lists Faxes
      description: Returns properties of multiple Faxes
      tags:
        - - subpackage_fax
      parameters:
        - name: page
          in: query
          description: Which page number of the Fax List to return. Defaults to `1`.
          required: false
          schema:
            type: integer
            default: 1
        - name: page_size
          in: query
          description: >-
            Number of objects to be returned per page. Must be between `1` and
            `100`. Default is `20`.
          required: false
          schema:
            type: integer
            default: 20
        - name: Authorization
          in: header
          description: Basic authentication of the form `Basic <username:password>`.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FaxListResponse'
        '400':
          description: failed_operation
          content: {}
components:
  schemas:
    FaxResponseTransmissionStatusCode:
      type: string
      enum:
        - value: success
        - value: transmitting
        - value: error_could_not_fax
        - value: error_unknown
        - value: error_busy
        - value: error_no_answer
        - value: error_disconnected
        - value: error_bad_destination
    FaxResponseTransmission:
      type: object
      properties:
        recipient:
          type: string
          description: Fax Transmission Recipient
        status_code:
          $ref: '#/components/schemas/FaxResponseTransmissionStatusCode'
          description: Fax Transmission Status Code
        sent_at:
          type: integer
          description: Fax Transmission Sent Timestamp
      required:
        - recipient
        - status_code
    FaxResponse:
      type: object
      properties:
        fax_id:
          type: string
          description: Fax ID
        title:
          type: string
          description: Fax Title
        original_title:
          type: string
          description: Fax Original Title
        subject:
          type:
            - string
            - 'null'
          description: Fax Subject
        message:
          type:
            - string
            - 'null'
          description: Fax Message
        metadata:
          type: object
          additionalProperties:
            description: Any type
          description: Fax Metadata
        created_at:
          type: integer
          description: Fax Created At Timestamp
        sender:
          type: string
          description: Fax Sender Email
        files_url:
          type: string
          description: Fax Files URL
        final_copy_uri:
          type:
            - string
            - 'null'
          description: The path where the completed document can be downloaded
        transmissions:
          type: array
          items:
            $ref: '#/components/schemas/FaxResponseTransmission'
          description: Fax Transmissions List
      required:
        - fax_id
        - title
        - original_title
        - metadata
        - created_at
        - sender
        - files_url
        - transmissions
    ListInfoResponse:
      type: object
      properties:
        num_pages:
          type: integer
          description: Total number of pages available.
        num_results:
          type:
            - integer
            - 'null'
          description: Total number of objects available.
        page:
          type: integer
          description: Number of the page being returned.
        page_size:
          type: integer
          description: Objects returned per page.
    FaxListResponse:
      type: object
      properties:
        faxes:
          type: array
          items:
            $ref: '#/components/schemas/FaxResponse'
        list_info:
          $ref: '#/components/schemas/ListInfoResponse'
      required:
        - faxes
        - list_info

```

## SDK Code Examples

```php PHP
<?php

namespace Dropbox\SignSandbox;

require_once __DIR__ . '/../vendor/autoload.php';

use SplFileObject;
use Dropbox;

$config = Dropbox\Sign\Configuration::getDefaultConfiguration();
$config->setUsername("YOUR_API_KEY");

try {
    $response = (new Dropbox\Sign\Api\FaxApi(config: $config))->faxList(
        page: 1,
        page_size: 20,
    );

    print_r($response);
} catch (Dropbox\Sign\ApiException $e) {
    echo "Exception when calling FaxApi#faxList: {$e->getMessage()}";
}

```

```csharp C#
using System;
using System.Collections.Generic;
using System.IO;
using System.Text.Json;

using Dropbox.Sign.Api;
using Dropbox.Sign.Client;
using Dropbox.Sign.Model;

namespace Dropbox.SignSandbox;

public class FaxListExample
{
    public static void Run()
    {
        var config = new Configuration();
        config.Username = "YOUR_API_KEY";

        try
        {
            var response = new FaxApi(config).FaxList(
                page: 1,
                pageSize: 20
            );

            Console.WriteLine(response);
        }
        catch (ApiException e)
        {
            Console.WriteLine("Exception when calling FaxApi#FaxList: " + e.Message);
            Console.WriteLine("Status Code: " + e.ErrorCode);
            Console.WriteLine(e.StackTrace);
        }
    }
}

```

```typescript TypeScript
import * as fs from 'fs';
import api from "@dropbox/sign"
import models from "@dropbox/sign"

const apiCaller = new api.FaxApi();
apiCaller.username = "YOUR_API_KEY";

apiCaller.faxList(
  1, // page
  20, // pageSize
).then(response => {
  console.log(response.body);
}).catch(error => {
  console.log("Exception when calling FaxApi#faxList:");
  console.log(error.body);
});

```

```java Java
package com.dropbox.sign_sandbox;

import com.dropbox.sign.ApiException;
import com.dropbox.sign.Configuration;
import com.dropbox.sign.api.*;
import com.dropbox.sign.auth.*;
import com.dropbox.sign.JSON;
import com.dropbox.sign.model.*;

import java.io.File;
import java.math.BigDecimal;
import java.time.LocalDate;
import java.time.OffsetDateTime;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;

public class FaxListExample
{
    public static void main(String[] args)
    {
        var config = Configuration.getDefaultApiClient();
        ((HttpBasicAuth) config.getAuthentication("api_key")).setUsername("YOUR_API_KEY");

        try
        {
            var response = new FaxApi(config).faxList(
                1, // page
                20 // pageSize
            );

            System.out.println(response);
        } catch (ApiException e) {
            System.err.println("Exception when calling FaxApi#faxList");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

```

```ruby Ruby
require "json"
require "dropbox-sign"

Dropbox::Sign.configure do |config|
    config.username = "YOUR_API_KEY"
end

begin
    response = Dropbox::Sign::FaxApi.new.fax_list(
        {
            page: 1,
            page_size: 20,
        },
    )

    p response
rescue Dropbox::Sign::ApiError => e
    puts "Exception when calling FaxApi#fax_list: #{e}"
end

```

```python Python
import json
from datetime import date, datetime
from pprint import pprint

from dropbox_sign import ApiClient, ApiException, Configuration, api, models

configuration = Configuration(
    username="YOUR_API_KEY",
)

with ApiClient(configuration) as api_client:
    try:
        response = api.FaxApi(api_client).fax_list(
            page=1,
            page_size=20,
        )

        pprint(response)
    except ApiException as e:
        print("Exception when calling FaxApi#fax_list: %s\n" % e)

```

```go Returns the properties and settings of multiple Faxes
package main

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

func main() {

	url := "https://api.hellosign.com/v3/fax/list?page=1&page_size=20"

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

	req.Header.Add("Authorization", "Basic <apiKey>:<password>")

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

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

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

}
```

```swift Returns the properties and settings of multiple Faxes
import Foundation

let headers = ["Authorization": "Basic <apiKey>:<password>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.hellosign.com/v3/fax/list?page=1&page_size=20")! 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()
```