# Get Fax Line

GET https://api.hellosign.com/v3/fax_line

Returns the properties and settings of a Fax Line.

Reference: https://developer.hellosign.com/api/fax-line/get

## OpenAPI Specification

```yaml
openapi: 3.1.1
info:
  title: Get Fax Line
  version: endpoint_faxLine.get
paths:
  /fax_line:
    get:
      operationId: get
      summary: Get Fax Line
      description: Returns the properties and settings of a Fax Line.
      tags:
        - - subpackage_faxLine
      parameters:
        - name: number
          in: query
          description: The Fax Line number
          required: true
          schema:
            type: string
        - 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/FaxLineResponse'
        '400':
          description: failed_operation
          content: {}
components:
  schemas:
    AccountResponseQuotas:
      type: object
      properties:
        api_signature_requests_left:
          type:
            - integer
            - 'null'
          description: API signature requests remaining.
        documents_left:
          type:
            - integer
            - 'null'
          description: Signature requests remaining.
        templates_total:
          type:
            - integer
            - 'null'
          description: Total API templates allowed.
        templates_left:
          type:
            - integer
            - 'null'
          description: API templates remaining.
        sms_verifications_left:
          type:
            - integer
            - 'null'
          description: SMS verifications remaining.
        num_fax_pages_left:
          type:
            - integer
            - 'null'
          description: Number of fax pages left
    AccountResponseUsage:
      type: object
      properties:
        fax_pages_sent:
          type:
            - integer
            - 'null'
          description: Number of fax pages sent
    AccountResponse:
      type: object
      properties:
        account_id:
          type: string
          description: The ID of the Account
        email_address:
          type: string
          description: The email address associated with the Account.
        is_locked:
          type: boolean
          description: >-
            Returns `true` if the user has been locked out of their account by a
            team admin.
        is_paid_hs:
          type: boolean
          description: Returns `true` if the user has a paid Dropbox Sign account.
        is_paid_hf:
          type: boolean
          description: Returns `true` if the user has a paid HelloFax account.
        quotas:
          $ref: '#/components/schemas/AccountResponseQuotas'
        callback_url:
          type:
            - string
            - 'null'
          description: The URL that Dropbox Sign events will `POST` to.
        role_code:
          type:
            - string
            - 'null'
          description: The membership role for the team.
        team_id:
          type:
            - string
            - 'null'
          description: The id of the team account belongs to.
        locale:
          type:
            - string
            - 'null'
          description: >-
            The locale used in this Account. Check out the list of [supported
            locales](/api/reference/constants/#supported-locales) to learn more
            about the possible values.
        usage:
          $ref: '#/components/schemas/AccountResponseUsage'
    FaxLineResponseFaxLine:
      type: object
      properties:
        number:
          type: string
          description: Number
        created_at:
          type: integer
          description: Created at
        updated_at:
          type: integer
          description: Updated at
        accounts:
          type: array
          items:
            $ref: '#/components/schemas/AccountResponse'
    WarningResponse:
      type: object
      properties:
        warning_msg:
          type: string
          description: Warning message
        warning_name:
          type: string
          description: Warning name
      required:
        - warning_msg
        - warning_name
    FaxLineResponse:
      type: object
      properties:
        fax_line:
          $ref: '#/components/schemas/FaxLineResponseFaxLine'
        warnings:
          $ref: '#/components/schemas/WarningResponse'
      required:
        - fax_line

```

## 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\FaxLineApi(config: $config))->faxLineGet(
        number: "123-123-1234",
    );

    print_r($response);
} catch (Dropbox\Sign\ApiException $e) {
    echo "Exception when calling FaxLineApi#faxLineGet: {$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 FaxLineGetExample
{
    public static void Run()
    {
        var config = new Configuration();
        config.Username = "YOUR_API_KEY";

        try
        {
            var response = new FaxLineApi(config).FaxLineGet(
                number: "123-123-1234"
            );

            Console.WriteLine(response);
        }
        catch (ApiException e)
        {
            Console.WriteLine("Exception when calling FaxLineApi#FaxLineGet: " + 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.FaxLineApi();
apiCaller.username = "YOUR_API_KEY";

apiCaller.faxLineGet(
  "123-123-1234", // number
).then(response => {
  console.log(response.body);
}).catch(error => {
  console.log("Exception when calling FaxLineApi#faxLineGet:");
  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 FaxLineGetExample
{
    public static void main(String[] args)
    {
        var config = Configuration.getDefaultApiClient();
        ((HttpBasicAuth) config.getAuthentication("api_key")).setUsername("YOUR_API_KEY");

        try
        {
            var response = new FaxLineApi(config).faxLineGet(
                "123-123-1234" // number
            );

            System.out.println(response);
        } catch (ApiException e) {
            System.err.println("Exception when calling FaxLineApi#faxLineGet");
            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::FaxLineApi.new.fax_line_get(
        "123-123-1234", # number
    )

    p response
rescue Dropbox::Sign::ApiError => e
    puts "Exception when calling FaxLineApi#fax_line_get: #{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.FaxLineApi(api_client).fax_line_get(
            number="123-123-1234",
        )

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

```

```go Sample Fax Line Response
package main

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

func main() {

	url := "https://api.hellosign.com/v3/fax_line?number=123-123-1234"

	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 Sample Fax Line Response
import Foundation

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

let request = NSMutableURLRequest(url: NSURL(string: "https://api.hellosign.com/v3/fax_line?number=123-123-1234")! 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()
```