Skip to main content
GET
/
environment
/
fax-settings
Get Default Fax Settings
curl --request GET \
  --url https://api.mintfax.com/v1/environment/fax-settings \
  --header 'Authorization: Bearer <token>'
{
  "webhook_url": "<string>",
  "max_attempts": 123,
  "csid": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://mintfax.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

API key as Bearer token. Use an account key (mfx_acct_...) for /account/* endpoints, and an environment key (mfx_test_... for sandbox, mfx_live_... for live) for /environment/*, /faxes, /webhooks, and /events.

Response

FaxSettingsResource

​
webhook_url
string<uri> | null
required

Default per-fax webhook URL override.

​
max_attempts
integer
required

Default attempt cap for faxes (1-5). See ADR-021.

Example:

3

​
csid
string | null
required

Default CSID for outbound faxes (max 20 chars).

​
page_size
enum<string> | null
required

Default page size for rendered content. PDF inputs pass through unchanged.

Available options:
letter,
legal,
a4,
b4
​
resolution
enum<string> | null
required

Default T.30 transmission resolution.

Available options:
standard,
fine
​
optimize_for
enum<string> | null
required

Default rasterizer optimization hint for non-PDF inputs.

Available options:
text,
photo
Last modified on May 21, 2026