{ "item": [ { "id": "9a1c0001-0000-4000-8000-000000000001", "name": "Fax", "description": { "content": "Send, resend, retrieve, list, and download faxes.", "type": "text/plain" }, "item": [ { "id": "9a1c0001-0000-4000-8000-000000000010", "name": "Send a fax", "request": { "name": "Send a fax", "description": { "content": "Sends a fax to one or more recipients with optional cover page, scheduling, tags, and custom fields.", "type": "text/plain" }, "url": { "path": ["fax", "send"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "formdata", "formdata": [ { "key": "recipientFax", "value": "12345678900", "type": "text" }, { "key": "recipientName", "value": "John Snow", "type": "text" }, { "key": "faxNumber", "value": "", "type": "text" }, { "key": "subject", "value": "", "type": "text" }, { "key": "notes", "value": "", "type": "text" }, { "key": "coverPage", "value": "true", "type": "text" }, { "key": "attachments", "type": "file", "src": [] } ] } }, "response": [] }, { "id": "9a1c0001-0000-4000-8000-000000000011", "name": "Get a fax", "request": { "name": "Get a fax", "description": { "content": "Retrieves the detail and current status of a single fax by its message id.", "type": "text/plain" }, "url": { "path": ["fax", ":messageId"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "key": "messageId", "value": "" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [] }, { "id": "9a1c0001-0000-4000-8000-000000000012", "name": "Resend a fax", "request": { "name": "Resend a fax", "description": { "content": "Resends a previously failed fax by message id; optionally change the destination via recipientFax.", "type": "text/plain" }, "url": { "path": ["fax", ":messageId", "resend"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "key": "messageId", "value": "" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"recipientFax\": \"12345678900\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "id": "9a1c0001-0000-4000-8000-000000000013", "name": "Download a fax", "request": { "name": "Download a fax", "description": { "content": "Downloads the document for a delivered or received fax. Use the format query parameter to select pdf or tiff.", "type": "text/plain" }, "url": { "path": ["fax", ":messageId", "download"], "host": ["{{baseUrl}}"], "query": [ { "key": "format", "value": "pdf" } ], "variable": [ { "key": "messageId", "value": "" } ] }, "header": [ { "key": "Accept", "value": "application/pdf" } ], "method": "GET", "auth": null }, "response": [] }, { "id": "9a1c0001-0000-4000-8000-000000000014", "name": "List faxes (fax history)", "request": { "name": "List faxes (fax history)", "description": { "content": "Returns a paginated list of inbound and outbound faxes. Rate limited to 8 calls per minute.", "type": "text/plain" }, "url": { "path": ["faxes"], "host": ["{{baseUrl}}"], "query": [ { "key": "direction", "value": "outbound" }, { "key": "limit", "value": "50" }, { "key": "offset", "value": "0" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [] } ], "event": [] }, { "id": "9a1c0001-0000-4000-8000-000000000002", "name": "Numbers", "description": { "content": "Search, provision, list, and release inbound fax numbers.", "type": "text/plain" }, "item": [ { "id": "9a1c0001-0000-4000-8000-000000000020", "name": "Search available numbers", "request": { "name": "Search available numbers", "description": { "content": "Searches for available inbound fax numbers that can be provisioned.", "type": "text/plain" }, "url": { "path": ["numbers", "search"], "host": ["{{baseUrl}}"], "query": [ { "key": "areaCode", "value": "202" }, { "key": "country", "value": "US" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [] }, { "id": "9a1c0001-0000-4000-8000-000000000021", "name": "List provisioned numbers", "request": { "name": "List provisioned numbers", "description": { "content": "Lists the inbound fax numbers provisioned on the account.", "type": "text/plain" }, "url": { "path": ["numbers"], "host": ["{{baseUrl}}"], "query": [ { "key": "limit", "value": "50" }, { "key": "offset", "value": "0" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [] }, { "id": "9a1c0001-0000-4000-8000-000000000022", "name": "Provision a number", "request": { "name": "Provision a number", "description": { "content": "Provisions (adds) an available inbound fax number to the account.", "type": "text/plain" }, "url": { "path": ["numbers"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"faxNumber\": \"+12025550143\",\n \"label\": \"Front Desk\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "id": "9a1c0001-0000-4000-8000-000000000023", "name": "Release a number", "request": { "name": "Release a number", "description": { "content": "Releases (removes) a provisioned inbound fax number from the account.", "type": "text/plain" }, "url": { "path": ["numbers", ":numberId"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "key": "numberId", "value": "" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [] } ], "event": [] }, { "id": "9a1c0001-0000-4000-8000-000000000003", "name": "Webhooks", "description": { "content": "Manage webhook subscriptions for fax and number events.", "type": "text/plain" }, "item": [ { "id": "9a1c0001-0000-4000-8000-000000000030", "name": "List webhooks", "request": { "name": "List webhooks", "description": { "content": "Lists webhook subscriptions configured on the account.", "type": "text/plain" }, "url": { "path": ["webhooks"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [] }, { "id": "9a1c0001-0000-4000-8000-000000000031", "name": "Create a webhook", "request": { "name": "Create a webhook", "description": { "content": "Creates a webhook subscription at the account or number level for fax and number events.", "type": "text/plain" }, "url": { "path": ["webhooks"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"url\": \"https://example.com/webhooks/documo\",\n \"events\": [\n \"fax.v1.inbound.succeed\",\n \"fax.v1.outbound.succeed\",\n \"fax.v1.outbound.failed\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "id": "9a1c0001-0000-4000-8000-000000000032", "name": "Delete a webhook", "request": { "name": "Delete a webhook", "description": { "content": "Deletes a webhook subscription by id.", "type": "text/plain" }, "url": { "path": ["webhooks", ":webhookId"], "host": ["{{baseUrl}}"], "query": [], "variable": [ { "key": "webhookId", "value": "" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [] } ], "event": [] }, { "id": "9a1c0001-0000-4000-8000-000000000004", "name": "Account", "description": { "content": "Read account profile and settings.", "type": "text/plain" }, "item": [ { "id": "9a1c0001-0000-4000-8000-000000000040", "name": "Get account", "request": { "name": "Get account", "description": { "content": "Retrieves the authenticated account's profile and settings.", "type": "text/plain" }, "url": { "path": ["account"], "host": ["{{baseUrl}}"], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [] } ], "event": [] } ], "event": [], "variable": [ { "type": "string", "value": "https://api.documo.com/v1", "key": "baseUrl" } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "info": { "_postman_id": "9a1c0001-0000-4000-8000-00000000ffff", "name": "Documo API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "REST API for the Documo (mFax) cloud fax platform. Send and receive faxes, manage numbers, subscribe to webhook events, and read account information. Authenticate with an API key in the Authorization header.\n\nContact Support:\n Name: Documo Support\n URL: https://help.documo.com/", "type": "text/plain" } } }