> ## 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. # Get Default Fax Settings > Returns the current default fax submission settings for the environment. Requires an environment key (`mfx_test_...` or `mfx_live_...`). ## OpenAPI ````yaml /openapi.json get /environment/fax-settings openapi: 3.1.0 info: title: mintfax API version: '1.0' description: >- Developer-first fax API. Send faxes with a single API call. ## Authentication Most endpoints require a Bearer token in the `Authorization` header. - **Account keys** (`mfx_acct_...`) access account-level endpoints (`/account`, `/account/balance`, `/account/transactions`, `/account/keys`). - **Environment keys** (`mfx_test_...` for test, `mfx_live_...` for live) access operational endpoints (`/environment`, `/faxes`, `/webhooks`, `/events`). - Registration endpoints (`POST /account/register` and `POST /account/register/verify`) do not require authentication. ## Base URL All API requests use `https://api.mintfax.com/v1` as the base URL. contact: name: mintfax Support email: support@mintfax.com url: https://mintfax.com/docs servers: - url: https://api.mintfax.com/v1 description: Production security: - bearerAuth: [] tags: - name: Account description: >- Account-level resources: registration, account info, balances, and API keys. - name: Environment description: >- Test and live environment configuration shared across all operational requests. - name: Fax description: Send, list, retrieve, resend, and purge faxes. - name: Events description: >- Read the immutable event log for everything that has happened in the environment. - name: Webhooks description: >- Manage webhook endpoints and inspect or replay individual delivery attempts. paths: /environment/fax-settings: get: tags: - Environment summary: Get Default Fax Settings description: |- Returns the current default fax submission settings for the environment. Requires an environment key (`mfx_test_...` or `mfx_live_...`). operationId: getFaxSettings responses: '200': description: '`FaxSettingsResource`' content: application/json: schema: $ref: '#/components/schemas/FaxSettingsResource' '401': description: The provided API key is not recognised. content: application/json: schema: $ref: '#/components/schemas/Error' examples: api_key_invalid: value: error: api_key_invalid message: The provided API key is not recognised. action: check_credentials docs: https://mintfax.com/docs/errors/api-key-invalid '403': description: >- Live calls require account activation. Complete a first credit purchase to activate. content: application/json: schema: $ref: '#/components/schemas/Error' examples: account_not_activated: value: error: account_not_activated message: >- Live calls require account activation. Complete a first credit purchase to activate. action: activate_account docs: https://mintfax.com/docs/errors/account-not-activated key_not_scoped_for_operations: value: error: key_not_scoped_for_operations message: >- This API key cannot send faxes or read environment data. Use an mfx_test_ or mfx_live_ key. action: use_operational_key docs: >- https://mintfax.com/docs/errors/key-not-scoped-for-operations '500': description: >- An unexpected error occurred. Please retry; if the problem persists, contact support. content: application/json: schema: $ref: '#/components/schemas/Error' examples: internal_server_error: value: error: internal_server_error message: >- An unexpected error occurred. Please retry; if the problem persists, contact support. action: retry_or_contact_support docs: https://mintfax.com/docs/errors/internal-server-error components: schemas: FaxSettingsResource: type: object properties: webhook_url: type: - string - 'null' format: uri description: Default per-fax webhook URL override. max_attempts: type: integer description: Default attempt cap for faxes (1-5). See ADR-021. examples: - 3 csid: type: - string - 'null' description: Default CSID for outbound faxes (max 20 chars). page_size: anyOf: - $ref: '#/components/schemas/PageSize' description: >- Default page size for rendered content. PDF inputs pass through unchanged. - type: 'null' resolution: anyOf: - $ref: '#/components/schemas/FaxResolution' description: Default T.30 transmission resolution. - type: 'null' optimize_for: anyOf: - $ref: '#/components/schemas/FaxOptimization' description: Default rasterizer optimization hint for non-PDF inputs. - type: 'null' required: - webhook_url - max_attempts - csid - page_size - resolution - optimize_for title: FaxSettingsResource Error: type: object properties: error: type: string description: Machine-readable error code. example: insufficient_balance message: type: string description: Human-readable description. example: Insufficient balance for this operation. action: type: string description: Suggested next step for the caller. example: top_up_balance docs: type: string format: uri description: URL to the docs entry for this error code. example: https://mintfax.com/docs/errors/insufficient-balance request_id: type: string description: >- Unique identifier for this API request, also returned in the X-Request-Id response header. Include this value in support requests for fast triage. pattern: ^req_[0-9A-HJKMNP-TV-Z]{26}$ example: req_01J9XYZQ8KH7B3R0WXAZP8VW6F context: type: object description: Error-specific extra fields (e.g. balances, validation errors). additionalProperties: [] required: - error - message - action - docs - request_id title: Error PageSize: type: string enum: - letter - legal - a4 - b4 title: PageSize FaxResolution: type: string enum: - standard - fine title: FaxResolution FaxOptimization: type: string enum: - text - photo title: FaxOptimization securitySchemes: bearerAuth: type: http description: |- 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`. scheme: bearer ````