# List all Faxes

GET https://YOUR_SPACE.signalwire.com/api/laml/2010-04-01/Accounts/{AccountSid}/Faxes

List all faxes.

#### 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/compatibility-api/rest/faxes/list-all-faxes

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: compatibility
  version: 1.0.0
paths:
  /Accounts/{AccountSid}/Faxes:
    get:
      operationId: list-all-faxes
      summary: List all Faxes
      description: >-
        List all faxes.


        #### 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_faxes
      parameters:
        - name: AccountSid
          in: path
          description: The Project ID that uniquely identifies the Account.
          required: true
          schema:
            type: string
            format: uuid
        - name: Page
          in: query
          description: The page index to retrieve. Zero-indexed.
          required: false
          schema:
            type: integer
            default: 0
        - name: PageSize
          in: query
          description: The number of results per page. Default is 50, maximum is 1000.
          required: false
          schema:
            type: integer
            default: 50
        - name: PageToken
          in: query
          description: Token for cursor-based pagination. Required when Page > 0.
          required: false
          schema:
            type: string
        - name: DateCreatedAfter
          in: query
          description: The date, in ISO 8601 format, after which the fax was sent.
          required: false
          schema:
            type: string
        - name: DateCreatedOnOrBefore
          in: query
          description: The date, in ISO 8601 format, on or before which the fax was sent.
          required: false
          schema:
            type: string
        - name: From
          in: query
          description: The phone number, in E.164 format, the fax was sent from.
          required: false
          schema:
            type: string
        - name: To
          in: query
          description: The phone number, in E.164 format, the fax was sent to.
          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/FaxListResponse'
        '400':
          description: >-
            The request was invalid or cannot be processed. Check the error
            details for more information.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompatibilityErrorResponse'
        '401':
          description: Authentication failed. Please verify your credentials and try again.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompatibilityErrorResponse'
        '422':
          description: >-
            The request could not be processed due to validation errors. Check
            the error details for more information.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompatibilityErrorResponse'
servers:
  - url: https://YOUR_SPACE.signalwire.com/api/laml/2010-04-01
components:
  schemas:
    FaxDirection:
      type: string
      enum:
        - inbound
        - outbound
      description: Fax direction.
      title: FaxDirection
    FaxQuality:
      type: string
      enum:
        - standard
        - fine
        - superfine
      description: Fax quality.
      title: FaxQuality
    FaxStatus:
      type: string
      enum:
        - queued
        - processing
        - sending
        - delivered
        - receiving
        - received
        - no-answer
        - busy
        - failed
        - canceled
      description: Fax status.
      title: FaxStatus
    FaxLinks:
      type: object
      properties:
        media:
          type: string
          description: Media associated with this fax.
      required:
        - media
      description: Fax links.
      title: FaxLinks
    Fax:
      type: object
      properties:
        account_sid:
          type: string
          description: The unique identifier for the account this fax is associated with.
        api_version:
          type: string
          description: The version of the SignalWire API.
        date_created:
          type: string
          description: The date and time, in ISO 8601 format, the fax was created.
        date_updated:
          type: string
          description: The date and time, in ISO 8601 format, the fax was updated.
        direction:
          $ref: '#/components/schemas/FaxDirection'
          description: The direction of the fax.
        from:
          type: string
          description: The phone number, in E.164 format, the fax was sent from.
        media_url:
          type:
            - string
            - 'null'
          description: The URL hosting the received media, or null if not available.
        media_sid:
          type: string
          description: >-
            The unique identifier for the media instance associated with the fax
            instance.
        num_pages:
          type:
            - string
            - 'null'
          description: >-
            The number of pages in the fax document, or null if not yet
            determined.
        price:
          type:
            - string
            - 'null'
          description: The cost of the fax, or null if not yet calculated.
        price_unit:
          type: string
          description: The currency, in ISO 4217 format, of the price.
        quality:
          $ref: '#/components/schemas/FaxQuality'
          description: The quality of the fax.
        sid:
          type: string
          description: The unique identifier of the fax.
        status:
          $ref: '#/components/schemas/FaxStatus'
          description: The status of the fax.
        to:
          type: string
          description: The phone number, in E.164 format, the fax was sent to.
        duration:
          type: integer
          description: The time, in seconds, it took to deliver a fax.
        links:
          $ref: '#/components/schemas/FaxLinks'
          description: The URL links for resources associated with the fax.
        url:
          type: string
          description: The URL of this resource.
        error_code:
          type:
            - string
            - 'null'
          description: Error code for this resource, or null if no error.
        error_message:
          type:
            - string
            - 'null'
          description: The description of this error, or null if no error.
      required:
        - account_sid
        - api_version
        - date_created
        - date_updated
        - direction
        - from
        - media_url
        - media_sid
        - num_pages
        - price
        - price_unit
        - quality
        - sid
        - status
        - to
        - duration
        - links
        - url
        - error_code
        - error_message
      description: Fax model.
      title: Fax
    FaxListResponse:
      type: object
      properties:
        uri:
          type: string
          description: The URI of the current page.
        first_page_uri:
          type: string
          description: The URI of the first page.
        next_page_uri:
          type:
            - string
            - 'null'
          description: The URI of the next page, or null if there are no more pages.
        previous_page_uri:
          type:
            - string
            - 'null'
          description: The URI of the previous page, or null if this is the first page.
        page:
          type: integer
          description: The current page number.
        page_size:
          type: integer
          description: The number of items per page.
        faxes:
          type: array
          items:
            $ref: '#/components/schemas/Fax'
          description: List of faxes.
      required:
        - uri
        - first_page_uri
        - next_page_uri
        - previous_page_uri
        - page
        - page_size
        - faxes
      description: Response containing a list of faxes.
      title: FaxListResponse
    CompatibilityErrorResponse:
      type: object
      properties:
        code:
          type: integer
          description: Error code.
        message:
          type: string
          description: Error message.
        more_info:
          type: string
          description: URL for more information about the error.
        status:
          type: integer
          description: HTTP status code.
      required:
        - code
        - message
        - more_info
        - status
      description: Error response model.
      title: CompatibilityErrorResponse
  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

url = "https://your_space.signalwire.com/api/laml/2010-04-01/Accounts/AccountSid/Faxes"

headers = {"Authorization": "Basic <project_id>:<api_token>"}

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

print(response.json())
```

```javascript
const url = 'https://your_space.signalwire.com/api/laml/2010-04-01/Accounts/AccountSid/Faxes';
const options = {method: 'GET', headers: {Authorization: 'Basic <project_id>:<api_token>'}};

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.signalwire.com/api/laml/2010-04-01/Accounts/AccountSid/Faxes"

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

	req.Header.Add("Authorization", "Basic <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 'net/http'

url = URI("https://your_space.signalwire.com/api/laml/2010-04-01/Accounts/AccountSid/Faxes")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <project_id>:<api_token>'

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

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

HttpResponse<String> response = Unirest.get("https://your_space.signalwire.com/api/laml/2010-04-01/Accounts/AccountSid/Faxes")
  .header("Authorization", "Basic <project_id>:<api_token>")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://your_space.signalwire.com/api/laml/2010-04-01/Accounts/AccountSid/Faxes', [
  'headers' => [
    'Authorization' => 'Basic <project_id>:<api_token>',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://your_space.signalwire.com/api/laml/2010-04-01/Accounts/AccountSid/Faxes");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Basic <project_id>:<api_token>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "Basic <project_id>:<api_token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://your_space.signalwire.com/api/laml/2010-04-01/Accounts/AccountSid/Faxes")! 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()
```