Dropbox Sign (HelloSign) Fax Line API
{'$ref': './markdown/en/tags/fax-lines-tag-description.md'}
OpenAPI Specification
openapi: 3.0.3
info:
title: Dropbox Sign Account Fax Line API
description: Dropbox Sign v3 API
termsOfService: https://www.hellosign.com/terms
contact:
email: apisupport@hellosign.com
license:
name: MIT
url: https://opensource.org/licenses/MIT
version: 3.0.0
servers:
- url: https://api.hellosign.com/v3
security:
- api_key: []
- oauth2:
- account_access
- signature_request_access
- template_access
- team_access
- api_app_access
- basic_account_info
- request_signature
tags:
- name: Fax Line
description:
$ref: ./markdown/en/tags/fax-lines-tag-description.md
paths:
/fax_line/add_user:
put:
tags:
- Fax Line
summary: Add Fax Line User
description: Grants a user access to the specified Fax Line.
operationId: faxLineAddUser
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/FaxLineAddUserRequest'
examples:
example:
$ref: '#/components/examples/FaxLineAddUserRequest'
responses:
'200':
description: successful operation
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-Ratelimit-Reset:
$ref: '#/components/headers/X-Ratelimit-Reset'
content:
application/json:
schema:
$ref: '#/components/schemas/FaxLineResponse'
examples:
example:
$ref: '#/components/examples/FaxLineResponse'
4XX:
description: failed_operation
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
400_example:
$ref: '#/components/examples/Error400Response'
401_example:
$ref: '#/components/examples/Error401Response'
402_example:
$ref: '#/components/examples/Error402Response'
403_example:
$ref: '#/components/examples/Error403Response'
429_example:
$ref: '#/components/examples/Error429Response'
404_example:
$ref: '#/components/examples/Error404Response'
4XX_example:
$ref: '#/components/examples/Error4XXResponse'
security:
- api_key: []
x-codeSamples:
- lang: PHP
label: PHP
source:
$ref: examples/FaxLineAddUserExample.php
- lang: C#
label: C#
source:
$ref: examples/FaxLineAddUserExample.cs
- lang: TypeScript
label: TypeScript
source:
$ref: examples/FaxLineAddUserExample.ts
- lang: Java
label: Java
source:
$ref: examples/FaxLineAddUserExample.java
- lang: Ruby
label: Ruby
source:
$ref: examples/FaxLineAddUserExample.rb
- lang: Python
label: Python
source:
$ref: examples/FaxLineAddUserExample.py
- lang: cURL
label: cURL
source:
$ref: examples/FaxLineAddUserExample.sh
x-meta:
seo:
title: Fax Line Add User | API Documentation | Dropbox Fax for Developers
description: The Dropbox Fax API allows you to build custom integrations. To find out how to add a user to an existing fax line, click here.
/fax_line/area_codes:
get:
tags:
- Fax Line
summary: Get Available Fax Line Area Codes
description: Returns a list of available area codes for a given state/province and city
operationId: faxLineAreaCodeGet
parameters:
- name: country
in: query
description: Filter area codes by country
required: true
schema:
type: string
enum:
- CA
- US
- UK
example: US
- name: state
in: query
description: Filter area codes by state
schema:
type: string
enum:
- AK
- AL
- AR
- AZ
- CA
- CO
- CT
- DC
- DE
- FL
- GA
- HI
- IA
- ID
- IL
- IN
- KS
- KY
- LA
- MA
- MD
- ME
- MI
- MN
- MO
- MS
- MT
- NC
- ND
- NE
- NH
- NJ
- NM
- NV
- NY
- OH
- OK
- OR
- PA
- RI
- SC
- SD
- TN
- TX
- UT
- VA
- VT
- WA
- WI
- WV
- WY
- name: province
in: query
description: Filter area codes by province
schema:
type: string
enum:
- AB
- BC
- MB
- NB
- NL
- NT
- NS
- NU
- 'ON'
- PE
- QC
- SK
- YT
- name: city
in: query
description: Filter area codes by city
schema:
type: string
responses:
'200':
description: successful operation
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-Ratelimit-Reset:
$ref: '#/components/headers/X-Ratelimit-Reset'
content:
application/json:
schema:
$ref: '#/components/schemas/FaxLineAreaCodeGetResponse'
examples:
example:
$ref: '#/components/examples/FaxLineAreaCodeGetResponse'
4XX:
description: failed_operation
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
400_example:
$ref: '#/components/examples/Error400Response'
401_example:
$ref: '#/components/examples/Error401Response'
402_example:
$ref: '#/components/examples/Error402Response'
403_example:
$ref: '#/components/examples/Error403Response'
429_example:
$ref: '#/components/examples/Error429Response'
4XX_example:
$ref: '#/components/examples/Error4XXResponse'
security:
- api_key: []
x-codeSamples:
- lang: PHP
label: PHP
source:
$ref: examples/FaxLineAreaCodeGetExample.php
- lang: C#
label: C#
source:
$ref: examples/FaxLineAreaCodeGetExample.cs
- lang: TypeScript
label: TypeScript
source:
$ref: examples/FaxLineAreaCodeGetExample.ts
- lang: Java
label: Java
source:
$ref: examples/FaxLineAreaCodeGetExample.java
- lang: Ruby
label: Ruby
source:
$ref: examples/FaxLineAreaCodeGetExample.rb
- lang: Python
label: Python
source:
$ref: examples/FaxLineAreaCodeGetExample.py
- lang: cURL
label: cURL
source:
$ref: examples/FaxLineAreaCodeGetExample.sh
x-meta:
seo:
title: Fax Line Get Area Codes | API Documentation | Dropbox Fax for Developers
description: The Dropbox Fax API allows you to build custom integrations. To find out what area codes are available, click here.
/fax_line/create:
post:
tags:
- Fax Line
summary: Purchase Fax Line
description: Purchases a new Fax Line
operationId: faxLineCreate
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/FaxLineCreateRequest'
examples:
example:
$ref: '#/components/examples/FaxLineCreateRequest'
responses:
'200':
description: successful operation
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-Ratelimit-Reset:
$ref: '#/components/headers/X-Ratelimit-Reset'
content:
application/json:
schema:
$ref: '#/components/schemas/FaxLineResponse'
examples:
example:
$ref: '#/components/examples/FaxLineResponse'
4XX:
description: failed_operation
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
400_example:
$ref: '#/components/examples/Error400Response'
401_example:
$ref: '#/components/examples/Error401Response'
402_example:
$ref: '#/components/examples/Error402Response'
403_example:
$ref: '#/components/examples/Error403Response'
429_example:
$ref: '#/components/examples/Error429Response'
404_example:
$ref: '#/components/examples/Error404Response'
4XX_example:
$ref: '#/components/examples/Error4XXResponse'
security:
- api_key: []
x-codeSamples:
- lang: PHP
label: PHP
source:
$ref: examples/FaxLineCreateExample.php
- lang: C#
label: C#
source:
$ref: examples/FaxLineCreateExample.cs
- lang: TypeScript
label: TypeScript
source:
$ref: examples/FaxLineCreateExample.ts
- lang: Java
label: Java
source:
$ref: examples/FaxLineCreateExample.java
- lang: Ruby
label: Ruby
source:
$ref: examples/FaxLineCreateExample.rb
- lang: Python
label: Python
source:
$ref: examples/FaxLineCreateExample.py
- lang: cURL
label: cURL
source:
$ref: examples/FaxLineCreateExample.sh
x-meta:
seo:
title: Purchase Fax Line | API Documentation | Dropbox Fax for Developers
description: The Dropbox Fax API allows you to build custom integrations. To find out how to purchase a new fax line, click here.
/fax_line:
get:
tags:
- Fax Line
summary: Get Fax Line
description: Returns the properties and settings of a Fax Line.
operationId: faxLineGet
parameters:
- name: number
in: query
description: The Fax Line number
required: true
schema:
type: string
example: 123-123-1234
responses:
'200':
description: successful operation
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-Ratelimit-Reset:
$ref: '#/components/headers/X-Ratelimit-Reset'
content:
application/json:
schema:
$ref: '#/components/schemas/FaxLineResponse'
examples:
example:
$ref: '#/components/examples/FaxLineResponse'
4XX:
description: failed_operation
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
400_example:
$ref: '#/components/examples/Error400Response'
401_example:
$ref: '#/components/examples/Error401Response'
402_example:
$ref: '#/components/examples/Error402Response'
403_example:
$ref: '#/components/examples/Error403Response'
429_example:
$ref: '#/components/examples/Error429Response'
404_example:
$ref: '#/components/examples/Error404Response'
4XX_example:
$ref: '#/components/examples/Error4XXResponse'
security:
- api_key: []
x-codeSamples:
- lang: PHP
label: PHP
source:
$ref: examples/FaxLineGetExample.php
- lang: C#
label: C#
source:
$ref: examples/FaxLineGetExample.cs
- lang: TypeScript
label: TypeScript
source:
$ref: examples/FaxLineGetExample.ts
- lang: Java
label: Java
source:
$ref: examples/FaxLineGetExample.java
- lang: Ruby
label: Ruby
source:
$ref: examples/FaxLineGetExample.rb
- lang: Python
label: Python
source:
$ref: examples/FaxLineGetExample.py
- lang: cURL
label: cURL
source:
$ref: examples/FaxLineGetExample.sh
x-meta:
seo:
title: Get Fax Line | API Documentation | Dropbox Fax for Developers
description: The Dropbox Fax API allows you to build custom integrations. To find out how to retrieve the properties of a fax line, click here.
delete:
tags:
- Fax Line
summary: Delete Fax Line
description: Deletes the specified Fax Line from the subscription.
operationId: faxLineDelete
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/FaxLineDeleteRequest'
examples:
example:
$ref: '#/components/examples/FaxLineDeleteRequest'
responses:
'200':
description: successful operation
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-Ratelimit-Reset:
$ref: '#/components/headers/X-Ratelimit-Reset'
content:
application/json: {}
4XX:
description: failed_operation
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
400_example:
$ref: '#/components/examples/Error400Response'
401_example:
$ref: '#/components/examples/Error401Response'
402_example:
$ref: '#/components/examples/Error402Response'
403_example:
$ref: '#/components/examples/Error403Response'
429_example:
$ref: '#/components/examples/Error429Response'
404_example:
$ref: '#/components/examples/Error404Response'
4XX_example:
$ref: '#/components/examples/Error4XXResponse'
security:
- api_key: []
x-codeSamples:
- lang: PHP
label: PHP
source:
$ref: examples/FaxLineDeleteExample.php
- lang: C#
label: C#
source:
$ref: examples/FaxLineDeleteExample.cs
- lang: TypeScript
label: TypeScript
source:
$ref: examples/FaxLineDeleteExample.ts
- lang: Java
label: Java
source:
$ref: examples/FaxLineDeleteExample.java
- lang: Ruby
label: Ruby
source:
$ref: examples/FaxLineDeleteExample.rb
- lang: Python
label: Python
source:
$ref: examples/FaxLineDeleteExample.py
- lang: cURL
label: cURL
source:
$ref: examples/FaxLineDeleteExample.sh
x-meta:
seo:
title: Delete Fax Line | API Documentation | Dropbox Fax for Developers
description: The Dropbox Fax API allows you to build custom integrations. To find out how to delete a fax line, click here.
/fax_line/list:
get:
tags:
- Fax Line
summary: List Fax Lines
description: Returns the properties and settings of multiple Fax Lines.
operationId: faxLineList
parameters:
- name: account_id
in: query
description: Account ID
schema:
type: string
example: ab55cd14a97219e36b5ff5fe23f2f9329b0c1e97
- name: page
in: query
description: Which page number of the Fax Line List to return. Defaults to `1`.
schema:
type: integer
default: 1
example: 1
- name: page_size
in: query
description: Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`.
schema:
type: integer
default: 20
example: 20
- name: show_team_lines
in: query
description: Include Fax Lines belonging to team members in the list
schema:
type: boolean
responses:
'200':
description: successful operation
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-Ratelimit-Reset:
$ref: '#/components/headers/X-Ratelimit-Reset'
content:
application/json:
schema:
$ref: '#/components/schemas/FaxLineListResponse'
examples:
example:
$ref: '#/components/examples/FaxLineListResponse'
4XX:
description: failed_operation
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
400_example:
$ref: '#/components/examples/Error400Response'
401_example:
$ref: '#/components/examples/Error401Response'
402_example:
$ref: '#/components/examples/Error402Response'
403_example:
$ref: '#/components/examples/Error403Response'
429_example:
$ref: '#/components/examples/Error429Response'
4XX_example:
$ref: '#/components/examples/Error4XXResponse'
security:
- api_key: []
x-codeSamples:
- lang: PHP
label: PHP
source:
$ref: examples/FaxLineListExample.php
- lang: C#
label: C#
source:
$ref: examples/FaxLineListExample.cs
- lang: TypeScript
label: TypeScript
source:
$ref: examples/FaxLineListExample.ts
- lang: Java
label: Java
source:
$ref: examples/FaxLineListExample.java
- lang: Ruby
label: Ruby
source:
$ref: examples/FaxLineListExample.rb
- lang: Python
label: Python
source:
$ref: examples/FaxLineListExample.py
- lang: cURL
label: cURL
source:
$ref: examples/FaxLineListExample.sh
x-meta:
seo:
title: List Fax Lines | API Documentation | Dropbox Fax for Developers
description: The Dropbox Fax API allows you to build custom integrations. To find out how to list your fax lines, click here.
/fax_line/remove_user:
put:
tags:
- Fax Line
summary: Remove Fax Line Access
description: Removes a user's access to the specified Fax Line
operationId: faxLineRemoveUser
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/FaxLineRemoveUserRequest'
examples:
example:
$ref: '#/components/examples/FaxLineRemoveUserRequest'
responses:
'200':
description: successful operation
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-Ratelimit-Reset:
$ref: '#/components/headers/X-Ratelimit-Reset'
content:
application/json:
schema:
$ref: '#/components/schemas/FaxLineResponse'
examples:
example:
$ref: '#/components/examples/FaxLineResponse'
4XX:
description: failed_operation
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
400_example:
$ref: '#/components/examples/Error400Response'
401_example:
$ref: '#/components/examples/Error401Response'
402_example:
$ref: '#/components/examples/Error402Response'
403_example:
$ref: '#/components/examples/Error403Response'
429_example:
$ref: '#/components/examples/Error429Response'
404_example:
$ref: '#/components/examples/Error404Response'
4XX_example:
$ref: '#/components/examples/Error4XXResponse'
security:
- api_key: []
x-codeSamples:
- lang: PHP
label: PHP
source:
$ref: examples/FaxLineRemoveUserExample.php
- lang: C#
label: C#
source:
$ref: examples/FaxLineRemoveUserExample.cs
- lang: TypeScript
label: TypeScript
source:
$ref: examples/FaxLineRemoveUserExample.ts
- lang: Java
label: Java
source:
$ref: examples/FaxLineRemoveUserExample.java
- lang: Ruby
label: Ruby
source:
$ref: examples/FaxLineRemoveUserExample.rb
- lang: Python
label: Python
source:
$ref: examples/FaxLineRemoveUserExample.py
- lang: cURL
label: cURL
source:
$ref: examples/FaxLineRemoveUserExample.sh
x-meta:
seo:
title: Fax Line Remove User | API Documentation | Dropbox Fax for Developers
description: The Dropbox Fax API allows you to build custom integrations. To find out how to remove a user from an existing fax line, click here.
components:
examples:
FaxLineAreaCodeGetResponse:
summary: Sample Area Code Response
value:
$ref: examples/json/FaxLineAreaCodeGetResponse.json
FaxLineAddUserRequest:
summary: Default Example
value:
$ref: examples/json/FaxLineAddUserRequest.json
Error401Response:
summary: Error 401 unauthorized
value:
$ref: examples/json/Error401Response.json
FaxLineListResponse:
summary: Sample Fax Line List Response
value:
$ref: examples/json/FaxLineListResponse.json
FaxLineResponse:
summary: Sample Fax Line Response
value:
$ref: examples/json/FaxLineResponse.json
FaxLineDeleteRequest:
summary: Default Example
value:
$ref: examples/json/FaxLineDeleteRequest.json
FaxLineCreateRequest:
summary: Default Example
value:
$ref: examples/json/FaxLineCreateRequest.json
Error400Response:
summary: Error 400 bad_request
value:
$ref: examples/json/Error400Response.json
Error402Response:
summary: Error 402 payment_required
value:
$ref: examples/json/Error402Response.json
Error4XXResponse:
summary: Error 4XX failed_operation
value:
$ref: examples/json/Error4XXResponse.json
Error404Response:
summary: Error 404 not_found
value:
$ref: examples/json/Error404Response.json
Error403Response:
summary: Error 403 forbidden
value:
$ref: examples/json/Error403Response.json
Error429Response:
summary: Error 429 exceeded_rate
value:
$ref: examples/json/Error429Response.json
FaxLineRemoveUserRequest:
summary: Default Example
value:
$ref: examples/json/FaxLineRemoveUserRequest.json
schemas:
FaxLineRemoveUserRequest:
required:
- number
properties:
number:
description: The Fax Line number
type: string
account_id:
description: Account ID of the user to remove access
type: string
example: ab55cd14a97219e36b5ff5fe23f2f9329b0c1e97
email_address:
description: Email address of the user to remove access
type: string
format: email
type: object
AccountResponseUsage:
description: Details concerning monthly usage
properties:
fax_pages_sent:
description: Number of fax pages sent
type: integer
nullable: true
type: object
x-internal-class: true
FaxLineResponse:
required:
- fax_line
properties:
fax_line:
$ref: '#/components/schemas/FaxLineResponseFaxLine'
warnings:
$ref: '#/components/schemas/WarningResponse'
type: object
x-internal-class: true
AccountResponse:
properties:
account_id:
description: The ID of the Account
type: string
email_address:
description: The email address associated with the Account.
type: string
is_locked:
description: Returns `true` if the user has been locked out of their account by a team admin.
type: boolean
is_paid_hs:
description: Returns `true` if the user has a paid Dropbox Sign account.
type: boolean
is_paid_hf:
description: Returns `true` if the user has a paid HelloFax account.
type: boolean
quotas:
$ref: '#/components/schemas/AccountResponseQuotas'
callback_url:
description: The URL that Dropbox Sign events will `POST` to.
type: string
nullable: true
role_code:
description: The membership role for the team.
type: string
nullable: true
team_id:
description: The id of the team account belongs to.
type: string
nullable: true
locale:
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.
type: string
nullable: true
usage:
$ref: '#/components/schemas/AccountResponseUsage'
settings:
$ref: '#/components/schemas/AccountResponseSettings'
type: object
x-internal-class: true
ErrorResponseError:
description: Contains information about an error that occurred.
required:
- error_msg
- error_name
properties:
error_msg:
description: Message describing an error.
type: string
error_path:
description: Path at which an error occurred.
type: string
error_name:
description: Name of the error. See the `x-error-codes` catalog in openapi file for a complete list of possible error codes with detailed information including HTTP status codes, causes, remediation steps, and retry guidance.
type: string
type: object
FaxLineDeleteRequest:
required:
- number
properties:
number:
description: The Fax Line number
type: string
type: object
FaxLineResponseFaxLine:
properties:
number:
description: Number
type: string
created_at:
description: Created at
type: integer
updated_at:
description: Updated at
type: integer
accounts:
type: array
items:
$ref: '#/components/schemas/AccountResponse'
type: object
x-internal-class: true
AccountResponseQuotas:
description: Details concerning remaining monthly quotas.
properties:
api_signature_requests_left:
description: API signature requests remaining.
type: integer
nullable: true
documents_left:
description: Signature requests remaining.
type: integer
nullable: true
templates_total:
description: Total API templates allowed.
type: integer
nullable: true
templates_left:
description: API templates remaining.
type: integer
nullable: true
sms_verifications_left:
description: SMS verifications remaining.
type: integer
nullable: true
num_fax_pages_left:
description: Number of fax pages left
type: integer
nullable: true
type: object
x-internal-class: true
FaxLineAreaCodeGetResponse:
required:
- area_codes
properties:
area_codes:
type: array
items:
type: integer
type: object
x-internal-class: true
AccountResponseSettings:
description: Subset of configured settings
properties:
signer_access_codes:
description: Returns `true` if _Custom access codes_ is enabled in Admin Console. [Read more](https://developers.hellosign.com/docs/sms-tools/walkthrough).
type: boolean
sms_delivery:
description: Returns `true` if _Text message_ is enabled in Admin Console. [Read more](https://developers.hellosign.com/docs/sms-tools/walkthrough).
type: boolean
sms_authentication:
description: Returns `true` if _Signer authentication_ is enabled in Admin Console. [Read more](https://developers.hellosign.com/docs/sms-tools/walkthrough).
type: boolean
type: object
x-internal-class: true
FaxLineAddUserRequest:
required:
- number
properties:
number:
description: The Fax Line number
type: string
account_id:
description: Account ID
type: string
example: ab55cd14a97219e36b5ff5fe23f2f9329b0c1e97
email_address:
description: Email address
type: string
format: email
type: object
FaxLineCreateRequest:
required:
- area_code
- country
properties:
area_code:
description: Area code of the new Fax Line
type: integer
country:
description: Country of the area code
type: string
enum:
- CA
- US
- UK
city:
description: City of the area code
type: string
account_id:
description: Account ID of the account that will be assigned this new Fax Line
type: string
example: ab55cd14a97219e36b5ff5fe23f2f9329b0c1e97
type: object
ErrorResponse:
required:
- error
properties:
error:
$ref: '#/components/schemas/ErrorResponseError'
type: object
WarningResponse:
description: A list of warnings.
required:
- warning_msg
- warning_name
properties:
warning_msg:
description: Warning message
type: string
warning_name:
description: Warning name
type: string
type: object
ListInfoResponse:
description: Contains pagination information about the data returned.
properties:
num_pages:
description: Total number of pages available.
type: integer
num_results:
description: Total number of objects available.
type: integer
nullable: true
page:
description: Number of the page being returned.
t
# --- truncated at 32 KB (53 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/hellosign/refs/heads/main/openapi/hellosign-fax-line-api-openapi.yml