Get Default Fax Settings

cURL

curl https://api.mintfax.com/v1/account/fax-settings \
  -H "Authorization: Bearer fx_test_abc123..."

{
  "retries": 3,
  "webhook_url": null
}

GET

account

fax-settings

cURL

curl https://api.mintfax.com/v1/account/fax-settings \
  -H "Authorization: Bearer fx_test_abc123..."

{
  "retries": 3,
  "webhook_url": null
}

Authorization

string

header

required

API key as Bearer token. Sandbox keys (fx_test_...) route to the sandbox environment. Live keys (fx_live_...) route to production.

200 - application/json

Current fax settings

Default fax submission settings (overridable per fax)

retries

integer

Default retry attempts for failed faxes

Required range: 0 <= x <= 10

Example:

3

webhook_url

string<uri> | null

Default per-fax webhook URL override

Example:

null

⌘I

Documentation Index