{
  "info": {
    "name": "SharePoint Fax API",
    "description": "Send faxes, follow them to delivery and hear about received faxes. SharePoint Fax — Powered by 365agents Inc.",
    "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
  },
  "auth": {
    "type": "apikey",
    "apikey": [
      {
        "key": "key",
        "value": "X-API-Key",
        "type": "string"
      },
      {
        "key": "value",
        "value": "{{apiKey}}",
        "type": "string"
      },
      {
        "key": "in",
        "value": "header",
        "type": "string"
      }
    ]
  },
  "variable": [
    {
      "key": "baseUrl",
      "value": "https://app.sharepointfax.com/api/public/v1"
    },
    {
      "key": "apiKey",
      "value": "sfx_live_XXXXXXXXXXXX_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
    },
    {
      "key": "since",
      "value": "2026-10-01T00:00:00Z"
    },
    {
      "key": "faxId",
      "value": "fax_0f3c9a8e2b7d4c1e9a5f6b2c3d4e5f60"
    },
    {
      "key": "subscriptionId",
      "value": "sub_0f3c9a8e2b7d4c1e9a5f6b2c3d4e5f60"
    }
  ],
  "item": [
    {
      "name": "Faxes",
      "item": [
        {
          "name": "List faxes",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/faxes",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "faxes"
              ],
              "query": [
                {
                  "key": "direction",
                  "value": "inbound",
                  "description": "inbound or outbound",
                  "disabled": false
                },
                {
                  "key": "since",
                  "value": "{{since}}",
                  "description": "RFC 3339 time, at most 31 days back",
                  "disabled": false
                },
                {
                  "key": "groupId",
                  "value": "grp_0f3c9a8e2b7d4c1e9a5f6b2c3d4e5f60",
                  "description": "Only this group",
                  "disabled": true
                },
                {
                  "key": "numberId",
                  "value": "num_0f3c9a8e2b7d4c1e9a5f6b2c3d4e5f60",
                  "description": "Only this number",
                  "disabled": true
                },
                {
                  "key": "cursor",
                  "value": "",
                  "description": "next_cursor from the previous page",
                  "disabled": true
                },
                {
                  "key": "limit",
                  "value": "50",
                  "description": "1–100 (default 50)",
                  "disabled": true
                }
              ]
            },
            "description": "Faxes since a time at most 31 days back, newest first. Requires fax.read."
          },
          "response": []
        },
        {
          "name": "Send a fax",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Idempotency-Key",
                "value": "{{$guid}}",
                "description": "8–128 letters, digits, - or _. The same key and body replays the original answer."
              },
              {
                "key": "Content-Type",
                "value": "application/json",
                "description": ""
              }
            ],
            "body": {
              "mode": "raw",
              "raw": "{\n  \"from\": \"num_0f3c9a8e2b7d4c1e9a5f6b2c3d4e5f60\",\n  \"to\": \"+14255550100\",\n  \"document\": {\n    \"contentBase64\": \"JVBERi0xLjcKJcKlwrHDqwo=\",\n    \"fileName\": \"referral.pdf\"\n  },\n  \"cover\": {\n    \"to\": \"Dr. Lee\",\n    \"from\": \"Referrals\",\n    \"note\": \"Please call on receipt.\"\n  }\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "url": {
              "raw": "{{baseUrl}}/faxes",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "faxes"
              ]
            },
            "description": "Sends a PDF from one of your numbers with no review step. The PDF is saved to the group's SharePoint outbound folder first. Requires fax.send; at most 20 sends a minute per key; the body needs a Content-Length."
          },
          "response": []
        },
        {
          "name": "Send a fax (multipart file upload)",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Idempotency-Key",
                "value": "{{$guid}}",
                "description": "8–128 letters, digits, - or _. The same key and body replays the original answer."
              }
            ],
            "body": {
              "mode": "formdata",
              "formdata": [
                {
                  "key": "from",
                  "value": "num_0f3c9a8e2b7d4c1e9a5f6b2c3d4e5f60",
                  "type": "text"
                },
                {
                  "key": "to",
                  "value": "+14255550100",
                  "type": "text"
                },
                {
                  "key": "cover.note",
                  "value": "Please call on receipt.",
                  "type": "text"
                },
                {
                  "key": "file",
                  "type": "file",
                  "src": ""
                }
              ]
            },
            "url": {
              "raw": "{{baseUrl}}/faxes",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "faxes"
              ]
            },
            "description": "Sends a PDF from one of your numbers with no review step. The PDF is saved to the group's SharePoint outbound folder first. Requires fax.send; at most 20 sends a minute per key; the body needs a Content-Length."
          },
          "response": []
        },
        {
          "name": "Get fax status",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/faxes/:id",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "faxes",
                ":id"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "{{faxId}}",
                  "description": "A fax id"
                }
              ]
            },
            "description": "One fax with its status. Requires fax.read."
          },
          "response": []
        }
      ]
    },
    {
      "name": "Directory",
      "item": [
        {
          "name": "List numbers",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/numbers",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "numbers"
              ],
              "query": [
                {
                  "key": "canSend",
                  "value": "true",
                  "description": "true: only numbers this key may send from",
                  "disabled": false
                }
              ]
            },
            "description": "The numbers this key may use."
          },
          "response": []
        },
        {
          "name": "List groups",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/groups",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "groups"
              ]
            },
            "description": "The groups this key may use."
          },
          "response": []
        },
        {
          "name": "Get page usage",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/usage",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "usage"
              ]
            },
            "description": "Pages this period, pooled across inbound and outbound."
          },
          "response": []
        }
      ]
    },
    {
      "name": "Notices",
      "item": [
        {
          "name": "List subscriptions",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/subscriptions",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "subscriptions"
              ]
            },
            "description": "List subscriptions"
          },
          "response": []
        },
        {
          "name": "Subscribe to notices",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json",
                "description": ""
              }
            ],
            "body": {
              "mode": "raw",
              "raw": "{\n  \"notificationUrl\": \"https://prod-00.westus.logic.azure.com/workflows/your-flow-callback\",\n  \"events\": [\n    \"fax.received\"\n  ],\n  \"groupId\": \"grp_0f3c9a8e2b7d4c1e9a5f6b2c3d4e5f60\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "url": {
              "raw": "{{baseUrl}}/subscriptions",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "subscriptions"
              ]
            },
            "description": "Power Automate trigger subscription. Requires events.manage."
          },
          "response": []
        },
        {
          "name": "Unsubscribe",
          "request": {
            "method": "DELETE",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/subscriptions/:id",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "subscriptions",
                ":id"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "{{subscriptionId}}",
                  "description": "A subscription id"
                }
              ]
            },
            "description": "Unsubscribe"
          },
          "response": []
        }
      ]
    }
  ]
}