{
  "info": {
    "_postman_id": "apeiron-fax",
    "name": "Apeiron API - Fax",
    "description": "Fax sending/receiving, fax document management, and email-to-fax authentication.\n\nCollection Version: 1.0.0\nBase URL: https://api.apeiron.io/v2\nAuth: HTTP Basic (email + API token) or JWT Bearer token\nAPI Reference: https://api.apeiron.io/v2/",
    "version": "1.0.0",
    "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
  },
  "auth": {
    "type": "basic",
    "basic": [
      {
        "key": "username",
        "value": "{{username}}",
        "type": "string"
      },
      {
        "key": "password",
        "value": "{{api_token}}",
        "type": "string"
      }
    ]
  },
  "variable": [
    {
      "key": "base_url",
      "value": "https://api.apeiron.io",
      "type": "string"
    },
    {
      "key": "username",
      "value": "",
      "type": "string"
    },
    {
      "key": "api_token",
      "value": "",
      "type": "string"
    }
  ],
  "item": [
    {
      "name": "Fax",
      "description": "Fax endpoints",
      "item": [
        {
          "name": "List fax numbers",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{base_url}}/fax",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "fax"
              ]
            },
            "description": "List all fax enabled phone numbers on the account"
          }
        },
        {
          "name": "List fax messages for phone number",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{base_url}}/fax/{phone_number}?direction=",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "fax",
                "{phone_number}"
              ],
              "query": [
                {
                  "key": "direction",
                  "value": "",
                  "description": "Direction of fax to filter on. Note that the `direction` attribute of returned Fax objects may not necessarily match. For example, a fax may be sent and received by phone numbers on the same account.",
                  "disabled": true
                }
              ]
            },
            "description": "List fax messages received or sent by a fax enabled number"
          }
        },
        {
          "name": "Send fax",
          "request": {
            "method": "POST",
            "header": [],
            "url": {
              "raw": "{{base_url}}/fax/{phone_number}",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "fax",
                "{phone_number}"
              ]
            },
            "description": "Send a PDF or text file as a fax from a number.",
            "body": {
              "mode": "formdata",
              "formdata": [
                {
                  "key": "to_number",
                  "description": "Destination number",
                  "type": "text",
                  "value": ""
                },
                {
                  "key": "document",
                  "description": "File to send as fax.  Maximum file size is 150MB. `.txt` and `.docx` files will be converted to `.pdf`",
                  "type": "file",
                  "src": ""
                },
                {
                  "key": "file_name",
                  "description": "File name",
                  "type": "text",
                  "value": ""
                },
                {
                  "key": "display_number",
                  "description": "Display number to show. This can be different than the fax enabled phone number specified in path.",
                  "type": "text",
                  "value": ""
                },
                {
                  "key": "quality_preset",
                  "description": "Fax quality preset",
                  "type": "text",
                  "value": "fine"
                }
              ]
            }
          }
        },
        {
          "name": "Send fax",
          "request": {
            "method": "POST",
            "header": [],
            "url": {
              "raw": "{{base_url}}/fax/{phone_number}/urlencoded/send",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "fax",
                "{phone_number}",
                "urlencoded",
                "send"
              ]
            },
            "description": "Send a PDF or text file as a fax from a number. This endpoint only supports application/x-www-form-urlencoded content type requests",
            "body": {
              "mode": "formdata",
              "formdata": [
                {
                  "key": "to_number",
                  "description": "Destination number",
                  "type": "text",
                  "value": ""
                },
                {
                  "key": "document",
                  "description": "File encoded in url safe base64 to send as fax.  Maximum file size is 150MB. `.txt` and `.docx` files will be converted to `.pdf`",
                  "type": "text",
                  "value": ""
                },
                {
                  "key": "file_name",
                  "description": "File name",
                  "type": "text",
                  "value": ""
                },
                {
                  "key": "display_number",
                  "description": "Display number to show. This can be different than the fax enabled phone number specified in path.",
                  "type": "text",
                  "value": ""
                },
                {
                  "key": "quality_preset",
                  "description": "Fax quality preset",
                  "type": "text",
                  "value": "fine"
                }
              ]
            }
          }
        },
        {
          "name": "Get outbound fax",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{base_url}}/fax/{phone_number}/{fax_id}",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "fax",
                "{phone_number}",
                "{fax_id}"
              ]
            },
            "description": "Retrieve outbound fax information."
          }
        },
        {
          "name": "Delete fax",
          "request": {
            "method": "DELETE",
            "header": [],
            "url": {
              "raw": "{{base_url}}/fax/{phone_number}/{fax_id}",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "fax",
                "{phone_number}",
                "{fax_id}"
              ]
            },
            "description": "Delete fax document. Fax meta data will still be available in dashboard."
          }
        },
        {
          "name": "Get fax document",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{base_url}}/fax/{phone_number}/{fax_id}/document",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "fax",
                "{phone_number}",
                "{fax_id}",
                "document"
              ]
            },
            "description": "Retrieve fax document"
          }
        },
        {
          "name": "Add fax email authentication",
          "request": {
            "method": "POST",
            "header": [],
            "url": {
              "raw": "{{base_url}}/fax/email_authentication/create",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "fax",
                "email_authentication",
                "create"
              ]
            },
            "description": "Add Fax Email Authentication",
            "body": {
              "mode": "formdata",
              "formdata": [
                {
                  "key": "fax_domain",
                  "description": "Fax domain",
                  "type": "text",
                  "value": ""
                },
                {
                  "key": "origination_auth",
                  "description": "Origination auth email",
                  "type": "text",
                  "value": ""
                },
                {
                  "key": "did_number",
                  "description": "DID to be associated",
                  "type": "text",
                  "value": ""
                },
                {
                  "key": "display_name",
                  "description": "Display name. Must not include spaces.",
                  "type": "text",
                  "value": ""
                }
              ]
            }
          }
        },
        {
          "name": "List fax email authentication",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{base_url}}/fax/email_authentication?did=",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "fax",
                "email_authentication"
              ],
              "query": [
                {
                  "key": "did",
                  "value": "",
                  "description": "Optionally specify a DID to filter by",
                  "disabled": true
                }
              ]
            },
            "description": "List all Fax Email Authentication records"
          }
        },
        {
          "name": "Remove fax email authentication",
          "request": {
            "method": "POST",
            "header": [],
            "url": {
              "raw": "{{base_url}}/fax/email_authentication/delete",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "fax",
                "email_authentication",
                "delete"
              ]
            },
            "description": "Remove Fax Email Authentication record for a given `fax_domain` and `origination_auth` pair",
            "body": {
              "mode": "formdata",
              "formdata": [
                {
                  "key": "fax_domain",
                  "description": "Fax domain",
                  "type": "text",
                  "value": ""
                },
                {
                  "key": "origination_auth",
                  "description": "Origination auth email",
                  "type": "text",
                  "value": ""
                }
              ]
            }
          }
        }
      ]
    }
  ]
}