The Documo API is organized around REST. All calls to the Documo API should be made to https://api.documo.com. All responses are formatted in JSON.
\nClick here for early access to additional endpoints (v2), still in beta.
\nThe example code snippets shown on the side of each endpoint's description can be changed. At the very top of the documentation, select the dropdown titled \"Language\". The list contains many common programming languages and libraries to help get things started!
\nTo begin using the Documo API, you will need to enable the API and generate an API key. This can be done in by logging into the web app and visiting Settings > API. Visual instructions here.
\n\n\nIn each section of this documentation, you will find which API key level of access is needed to use the corresponding endpoint.
\nExamples:
\nAny level: API Key Access: base | admin | print_driver
Admin only: API Key Access: admin
The sandbox environment is a copy of our application, its purpose is to let customers test their integrations with our services. It doesn't send any real faxes and can't sign documents for officially, it's fail-safe to use as a testing environment.
\nThe sandbox app can be accessed by URL https://app.sandbox.documo.com and API can be accessed by https://api.sandbox.documo.com.
We have some sandbox-specific tools for you to help you integrate. They are accessible by Sandbox Tools.
\nRead more about the Sandbox Environment here.
\nRate limit is the number of API calls a user can make within a given time period per API token. Documo restricts API requests when you exceed the limit of 60 calls per minute. Fax history and reports endpoints are limited to 8 calls per minute.
\nYou can check the current application rate limit usage in response headers:
\nWhen the upper limit is breached, an HTTP 429 error response is returned for subsequent requests. As a result, no more requests are served until the limit resets (within one minute).
\nThe Documo API uses the following error codes:
\nThe result codes used in fax responses:
\nA great way to get familiar with the webhooks is trying them out. Webhooks will be send in both the Sandbox Environment and in the Production Environment.
\nExample webhooks can be sent inside the application for each for type. If you would like to do some quick testing, webhook.site is a good option to capture webhook requests and view the data received.
\nBelow is a list of the types of webhooks available.
\nExample Response
\n{\n \"messageId\": \"e0e72262-bf92-47ed-a78c-69547479cad8\",\n \"deliveryId\": \"2220202171131453000\",\n \"watermark\": \"2220202171154972000\",\n \"messageNumber\": \"\",\n \"status\": \"success\",\n \"pagesCount\": 5,\n \"pagesComplete\": 5,\n \"duration\": 140000,\n \"faxNumber\": \"+12349999999\",\n \"faxCsid\": \"Fax CSID\",\n \"faxCallerId\": \"1234567890\",\n \"faxECM\": 256,\n \"faxSpeed\": 33600,\n \"faxDetected\": true,\n \"faxProtocol\": 0,\n \"faxAttempt\": 1,\n \"direction\": \"inbound\",\n \"channelType\": \"web\",\n \"deviceId\": \"93fbdb1cb82d9b4bbf3d034b85c704e4037eb37b997636e2f19f337b3426622c\",\n \"faxbridgeId\": null,\n \"accountId\": \"f452a5c9-8867-4b41-a1a7-4979d81d68af\",\n \"errorInfo\": \"\",\n \"errorCode\": \"0\",\n \"resultCode\": \"0\",\n \"resultInfo\": \"\",\n \"isArchived\": false,\n \"isFilePurged\": false,\n \"country\": \"US\",\n \"createdAt\": \"2022-02-02T17:11:31.453Z\",\n \"resolvedDate\": \"2022-02-02T17:11:54.972Z\",\n \"deletedAt\": null\n}\n\nFax outbound will send only once the fax has completed its entire lifespan. In most use cases this is sufficient. Fax outbound extended will send a request for each step along the lifespan (processing, transmitting, etc.) if more specific tracking is required.
\n{\n \"messageId\": \"cc38a979-fedb-4f27-9ad1-4ba1375ec9f8\",\n \"deliveryId\": \"2220202172805567000\",\n \"watermark\": \"2220202172858200000\",\n \"messageNumber\": \"\",\n \"status\": \"success\",\n \"pagesCount\": 3,\n \"pagesComplete\": 3,\n \"duration\": 140000,\n \"faxNumber\": \"+12349999999\",\n \"faxCsid\": \"Fax CSID\",\n \"faxCallerId\": \"1234567890\",\n \"faxECM\": 256,\n \"faxSpeed\": 33600,\n \"faxDetected\": true,\n \"faxProtocol\": 0,\n \"faxAttempt\": 1,\n \"direction\": \"outbound\",\n \"channelType\": \"web\",\n \"deviceId\": \"41d24f48bae55c8336829be058417c86d78948ba5bdb6d0d8620a20252ea03c5\",\n \"faxbridgeId\": null,\n \"accountId\": \"1670f416-0db7-4bf5-9874-4f519e616e12\",\n \"errorInfo\": \"\",\n \"errorCode\": \"0\",\n \"resultCode\": \"0\",\n \"resultInfo\": \"\",\n \"isArchived\": false,\n \"isFilePurged\": false,\n \"country\": \"US\",\n \"createdAt\": \"2022-02-02T17:28:05.567Z\",\n \"resolvedDate\": \"2022-02-02T17:28:58.200Z\",\n \"deletedAt\": null\n}\n\nExample Response
\n{\n \"uuid\": \"9aaa60a6-8c89-4771-8eb8-ebb226bc9c57\",\n \"accountId\": \"dc1b0cdb-c07b-4c7c-b9a8-ae4df7aa8278\",\n \"ownedBy\": \"14291108-0199-457b-88a8-26383f6395e2\",\n \"email\": \"Dasia25@hotmail.com\",\n \"emailSuppressed\": false,\n \"firstName\": \"Yasmine\",\n \"lastName\": \"Renner\",\n \"userRole\": \"user\",\n \"phone\": \"2349999999\",\n \"faxCsid\": null,\n \"faxCallerId\": \"1234567890\",\n \"faxDefaultCoverPage\": null,\n \"pushNotifications\": true,\n \"emailNotifySendOption\": \"all\",\n \"emailNotifySendIncAttachment\": true,\n \"emailNotifyReceiveOption\": \"all\",\n \"emailNotifyReceiveIncAttachment\": true,\n \"emailNotifyEmailToFaxQueued\": false,\n \"emailToFaxCoverPageOption\": true,\n \"isEmailConfirmed\": true,\n \"avatar\": null,\n \"avatarPath\": null,\n \"jobPosition\": null,\n \"timezone\": \"inherit\",\n \"driveFaxStoring\": false,\n \"driveFaxFolder\": null,\n \"signDefaultSignature\": null,\n \"signDefaultInitials\": null,\n \"signExpiresIn\": 60,\n \"signFirstReminder\": true,\n \"signFirstReminderIn\": 14,\n \"signRepeatReminder\": true,\n \"signRepeatReminderIn\": 7,\n \"signExpirationWarning\": true,\n \"fax\": true,\n \"sign\": true,\n \"drive\": true,\n \"colorMode\": \"auto\",\n \"createdAt\": \"2022-02-02T17:32:19.818Z\",\n \"updatedAt\": \"2022-02-02T17:32:19.818Z\",\n \"isScim\": null,\n \"deletedAt\": null\n}\n\nExample Response
\n{\n \"uuid\": \"8f8620fd-2e93-4df8-b9dc-f6c4e991b09c\",\n \"accountId\": \"bad04f30-fa7b-43e2-9747-4755099051c5\",\n \"ownedBy\": \"a2b611c8-f411-4df0-ba53-0eb5efbf7957\",\n \"email\": \"Laurine93@yahoo.com\",\n \"emailSuppressed\": false,\n \"firstName\": \"Rollin\",\n \"lastName\": \"Koch\",\n \"userRole\": \"user\",\n \"phone\": \"2349999999\",\n \"faxCsid\": null,\n \"faxCallerId\": \"1234567890\",\n \"faxDefaultCoverPage\": null,\n \"pushNotifications\": true,\n \"emailNotifySendOption\": \"all\",\n \"emailNotifySendIncAttachment\": true,\n \"emailNotifyReceiveOption\": \"all\",\n \"emailNotifyReceiveIncAttachment\": true,\n \"emailNotifyEmailToFaxQueued\": false,\n \"emailToFaxCoverPageOption\": true,\n \"isEmailConfirmed\": true,\n \"avatar\": null,\n \"avatarPath\": null,\n \"jobPosition\": null,\n \"timezone\": \"inherit\",\n \"driveFaxStoring\": false,\n \"driveFaxFolder\": null,\n \"signDefaultSignature\": null,\n \"signDefaultInitials\": null,\n \"signExpiresIn\": 60,\n \"signFirstReminder\": true,\n \"signFirstReminderIn\": 14,\n \"signRepeatReminder\": true,\n \"signRepeatReminderIn\": 7,\n \"signExpirationWarning\": true,\n \"fax\": true,\n \"sign\": true,\n \"drive\": true,\n \"colorMode\": \"auto\",\n \"createdAt\": \"2022-02-02T17:44:18.129Z\",\n \"updatedAt\": \"2022-02-02T17:44:18.129Z\",\n \"isScim\": null,\n \"deletedAt\": null\n}\n\nExample Response
\n{\n \"uuid\": \"115acc75-7387-437f-bf80-6408b26a7a17\",\n \"number\": \"2349999999\",\n \"numberE164\": \"+12349999999\",\n \"pendingUntil\": \"2022-02-02T17:49:25.787Z\",\n \"pendingPort\": false,\n \"ownedBy\": \"10391427-f882-46e6-91e7-536a737be46c\",\n \"managedBy\": \"fa9b630e-1f43-4ee1-9f88-39920768c478\",\n \"storage\": null,\n \"isLocal\": true,\n \"portReplaceNumberId\": null\n}\n\nExample Response
\n{\n \"uuid\": \"9c294a08-3e36-4dc7-9f68-3f4308cb5497\",\n \"number\": \"2349999999\",\n \"numberE164\": \"+12349999999\",\n \"pendingUntil\": \"2022-02-02T17:51:34.724Z\",\n \"pendingPort\": false,\n \"ownedBy\": \"654ab973-6068-48a3-bfa3-b9d68eb6526c\",\n \"managedBy\": \"8511924a-524c-4e89-a94d-cb27d3946ed5\",\n \"storage\": null,\n \"isLocal\": true,\n \"portReplaceNumberId\": null\n}\n\nExample Response
\n{\n \"uuid\": \"48fad9bf-b95c-47ea-97fa-b4620f4fac3d\",\n \"number\": \"2349999999\",\n \"numberE164\": \"+12349999999\",\n \"pendingUntil\": \"2022-02-02T17:52:29.322Z\",\n \"pendingPort\": false,\n \"ownedBy\": \"5cd8603b-9f10-44eb-b252-4c1e716cafe8\",\n \"managedBy\": \"71149e27-8be1-477b-b0ae-07367fa7e603\",\n \"storage\": null,\n \"isLocal\": true,\n \"portReplaceNumberId\": null\n}\n\n{\n \"status\": \"completed\",\n \"statusCapitalized\": \"Completed\",\n \"daysLeft\": null,\n \"uuid\": \"23b3b0f7-2b5b-465e-a888-95c5615c4e41\",\n \"title\": \"test-document\",\n \"accountId\": \"27a69b7e-0219-46c4-9217-992847c1e90b\",\n \"draft\": false,\n \"declined\": null,\n \"viewed\": true,\n \"signMode\": \"all\",\n \"order\": false,\n \"isPublic\": false,\n \"sharedWithAccount\": false,\n \"isApproveOrderEnabled\": false,\n \"approveStatus\": \"not_needed\",\n \"currentSigner\": null,\n \"type\": \"document\",\n \"emailMessage\": null,\n \"declineReasonRequired\": false,\n \"hash\": \"8e37f57d5d4cc817490af46048d2609df4103add33a816cf4c1d80e5fd857fdc\",\n \"fileId\": \"f1758c06-6d64-4c32-b482-47325fa70f0a\",\n \"signedFileId\": \"b482ba53-e94a-4d1a-bb4a-ffb6d6649964\",\n \"chatroomId\": \"06cd9867-0923-44ce-ab50-aa3698627c7e\",\n \"expiresIn\": 60,\n \"firstReminder\": true,\n \"firstReminderIn\": 14,\n \"repeatReminder\": true,\n \"repeatReminderIn\": 7,\n \"expirationWarning\": true,\n \"confirmationPage\": true,\n \"auditTrail\": false,\n \"industryId\": null,\n \"formId\": null,\n \"sentAt\": \"2022-02-02T17:52:57.860Z\",\n \"completedAt\": \"2022-02-02T17:52:57.860Z\",\n \"createdAt\": \"2022-02-02T17:52:57.860Z\",\n \"updatedAt\": \"2022-02-02T17:52:57.860Z\",\n \"deletedAt\": null\n}\n\n{\n \"status\": \"failed\",\n \"statusCapitalized\": \"Failed\",\n \"daysLeft\": null,\n \"uuid\": \"a8dab87c-9c2a-4a4a-84b1-a22cd752d593\",\n \"title\": \"test-document\",\n \"accountId\": \"6827eb27-f1de-4f82-abd3-fc4348e2af6d\",\n \"draft\": false,\n \"declined\": null,\n \"viewed\": true,\n \"signMode\": \"all\",\n \"order\": false,\n \"isPublic\": false,\n \"sharedWithAccount\": false,\n \"isApproveOrderEnabled\": false,\n \"approveStatus\": \"not_needed\",\n \"currentSigner\": null,\n \"type\": \"document\",\n \"emailMessage\": null,\n \"declineReasonRequired\": false,\n \"hash\": \"8e37f57d5d4cc817490af46048d2609df4103add33a816cf4c1d80e5fd857fdc\",\n \"fileId\": \"4100b42d-8994-4e3f-ac60-a88cc97d4389\",\n \"signedFileId\": \"9dd14747-2079-4ac2-a2e7-2127b8ca7a3e\",\n \"chatroomId\": \"298d48a5-54af-45fe-b457-5bad4f944860\",\n \"expiresIn\": 60,\n \"firstReminder\": true,\n \"firstReminderIn\": 14,\n \"repeatReminder\": true,\n \"repeatReminderIn\": 7,\n \"expirationWarning\": true,\n \"confirmationPage\": true,\n \"auditTrail\": false,\n \"industryId\": null,\n \"formId\": null,\n \"sentAt\": \"2022-02-02T18:01:32.799Z\",\n \"completedAt\": \"2022-02-02T18:01:32.799Z\",\n \"createdAt\": \"2022-02-02T18:01:32.799Z\",\n \"updatedAt\": \"2022-02-02T18:01:32.799Z\",\n \"deletedAt\": null\n}\n\nA session initiated webhook is triggered when user signs in, indicating the beginning of their session. Session terminated webhook is triggered when user signs out.
\n{\n \"userId\": \"a8dab87c-9c2a-4a4a-84b1-a22cd752d593\",\n \"email\": \"email@example.com\",\n \"sessionId\": \"6827eb27-f1de-4f82-abd3-fc4348e2af6d\"\n}\n\nYou may also find useful How To’s and tips by visiting our Help Center.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Set Language of Code Snippets","slug":"set-language-of-code-snippets"},{"content":"Enabling API Access","slug":"enabling-api-access"},{"content":"API Key Access","slug":"api-key-access"},{"content":"Sandbox Environment (Beta)","slug":"sandbox-environment-beta"},{"content":"API Rate Limits","slug":"api-rate-limits"},{"content":"Errors","slug":"errors"},{"content":"Result Codes","slug":"result-codes"},{"content":"Webhooks","slug":"webhooks"}],"owner":"14677030","collectionId":"a0f92106-25b4-4339-adb1-0ee3fa775276","publishedId":"TzRa5ia9","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"45b3ff"},"publishDate":"2025-01-03T17:03:02.000Z"},"item":[{"name":"Authentication","item":[{"name":"View My User","id":"3460900b-271c-4cd2-9933-1e73caa768a7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.documo.com/v1/me","description":"Returns your detailed user data.
\nAPI Key Access: base | admin | print_driver
Most calls will require authentication. Documo supports HTTP authentication. You will need to pass through your secret API key (example shown).
\nSecurity note: All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.
\n","_postman_id":"ea9f5a16-0ca6-4fd8-a238-6be4b7f683f7","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"Health check to see if API is currently up and available.
\nAPI Key Access: base | admin | print_driver
API Key Access: base | admin
Uuid | User ID
\n","type":"text/plain"},"key":"userId","value":""},{"disabled":true,"description":{"content":"Uuid | Account ID
\n","type":"text/plain"},"key":"accountId","value":""},{"disabled":true,"description":{"content":"String | Keyword to search in key name
\n","type":"text/plain"},"key":"search","value":""},{"disabled":true,"description":{"content":"Integer | Default: 20 | Limit: 100 | Number of results per page
\n","type":"text/plain"},"key":"limit","value":""},{"disabled":true,"description":{"content":"Integer | Default: 1 | Results page number
\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"String | Possible values: active, expired
\n","type":"text/plain"},"key":"status","value":null}],"variable":[]}},"response":[{"id":"e664a4a3-e259-43d5-91e4-5b4326c93da3","name":"View API Keys","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic API_KEY","type":"text"}],"url":{"raw":"https://api.documo.com/api-keys","host":["https://api.documo.com"],"path":["api-keys"],"query":[{"key":"userId","value":"d1077489-5ea1-4db1-9760-853f175e8288","description":"Uuid | User ID","disabled":true},{"key":"accountId","value":"d1077489-5ea1-4db1-9760-853f175e8288","description":"Uuid | Account ID","disabled":true},{"key":"search","value":"example","description":"String | Keyword to search in key name","disabled":true},{"key":"limit","value":"20","description":"Integer | Default: 20 | Limit: 100 | Number of results to return","disabled":true},{"key":"page","value":"1","description":"Integer | Default: 1 | Results page number","disabled":true}]}},"code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"[\n {\n \"uuid\": \"0b2e264c-2972-498b-a709-72a9009e0661\",\n \"userId\": \"27846918-99f5-40c4-a616-6702634c0123\",\n \"name\": \"Key Name\",\n \"token\": \"{TOKEN}\",\n \"createdAt\": \"2019-03-26T07:00:48.000Z\",\n \"expiresAt\": \"2019-03-31T06:58:27.000Z\",\n \"access\": \"admin\",\n \"user\": {\n \"uuid\": \"27846918-99f5-40c4-a616-6702634c0123\",\n \"email\": \"user@documo.com\",\n \"firstName\": \"John\",\n \"lastName\": \"Snow\",\n \"accountId\": \"12345678-d9a0-493f-a3aa-0cb1114eea0c\",\n \"avatar\": \"ddadc536-4569-4ad0-b5e0-743b751f775480x80.jpeg\",\n \"avatarPath\": \"path/to/avatar.jpeg\"\n }\n },\n ...\n]"}],"_postman_id":"5ce72785-c6f2-4121-aef5-06bdda4ee946"},{"name":"Create API Key","event":[{"listen":"prerequest","script":{"id":"af751d42-bcae-456d-b365-4b9b2b751f9b","exec":[""],"type":"text/javascript","packages":{}}}],"id":"761cbbc1-b648-4da6-a6e3-6f86909bd6b3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"description":"String | Required | Possible values: admin, base, print_driver
\n","key":"access","type":"text","value":""},{"description":"String| 128 characters limit | Key name | Default: null
\n","key":"name","type":"text","value":"","disabled":true},{"key":"userId","value":"","description":"Uuid | User id that will be assigned to key | Default: current user
\n","type":"text","disabled":true},{"description":"String | Expire date
\n","key":"expiresAt","type":"text","value":"","disabled":true}]},"url":"https://api.documo.com/api-keys","description":"API Key Access: base | admin
String | Required | Possible values: admin, base, print_driver
\n","key":"access","type":"text","value":""},{"description":"String| 128 characters limit | Key name
\n","key":"name","type":"text","value":"","disabled":true},{"description":"String | Expire date
\n","key":"expiresAt","type":"text","value":"","disabled":true}]},"url":"https://api.documo.com/api-keys/:keyId","description":"API Key Access: base | admin
String | Required | Key UUID
\n","type":"text/plain"},"type":"any","value":null,"key":"keyId"}]}},"response":[{"id":"5948a5d2-7dda-4daa-a3ca-79ca63bffc4d","name":"Update API Key","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"Basic API_KEY","type":"text"},{"key":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"description":"String | Required | Possible values: admin, base, print_driver","key":"access","type":"text","value":"example"},{"description":"String| 128 characters limit | Key name","key":"name","type":"text","value":"example"},{"description":"String | Expire date","key":"expiresAt","type":"text","value":"2020-01-01T00:00:00.000Z"}]},"url":{"raw":"https://api.documo.com/api-keys/:keyId","host":["https://api.documo.com"],"path":["api-keys",":keyId"],"variable":[{"key":"keyId","value":"d1077489-5ea1-4db1-9760-853f175e8288","description":"String | Required | Key UUID"}]}},"code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"uuid\": \"0b2e264c-2972-498b-a709-72a9009e0661\",\n \"name\": \"Key Name\",\n \"token\": \"{TOKEN}\",\n \"expiresAt\": \"2019-03-31T06:58:27.000Z\",\n \"access\": \"admin\",\n \"accountId\": \"12345678-d9a0-493f-a3aa-0cb1114eea0c\",\n \"userId\": \"87654321-99f5-40c4-a616-6702634c0b94\",\n \"createdAt\": \"2019-03-26T07:00:48.000Z\",\n \"updatedAt\": \"2019-03-26T09:16:01.000Z\",\n \"user\": {\n \"uuid\": \"27846918-99f5-40c4-a616-6702634c0b95\",\n \"email\": \"user@documo.com\",\n \"firstName\": \"John\",\n \"lastName\": \"Snow\",\n \"accountId\": \"12345678-d9a0-493f-a3aa-0cb1114eea0c\",\n \"avatar\": \"12adc536-4569-4ad0-b5e0-743b751f775480x80.jpeg\",\n \"avatarPath\": \"/path/to/avatar.jpeg\",\n }\n}"}],"_postman_id":"7081ede7-4360-4da3-818c-28d31988e141"},{"name":"Delete API Key","id":"44c5c664-5453-4b99-9c11-eaf684dd25ed","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.documo.com/api-keys/:keyId","description":"API Key Access: base | admin
String | Required | Key UUID
\n","type":"text/plain"},"type":"any","value":null,"key":"keyId"}]}},"response":[{"id":"cab7ed79-cb9e-45aa-b877-f5d16de1d67f","name":"Delete API Key","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Basic API_KEY","type":"text"}],"url":{"raw":"https://api.documo.com/api-keys/:keyId","host":["https://api.documo.com"],"path":["api-keys",":keyId"],"variable":[{"key":"keyId","value":"d1077489-5ea1-4db1-9760-853f175e8288","description":"String | Required | Key UUID"}]}},"code":204,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"OK"}],"_postman_id":"44c5c664-5453-4b99-9c11-eaf684dd25ed"}],"id":"3c0edaba-307b-40b9-b2eb-f1dd7e4b4ff9","_postman_id":"3c0edaba-307b-40b9-b2eb-f1dd7e4b4ff9","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"String | Required | Webook Name
\n","type":"text"},{"key":"url","value":"","description":"String | Required | Webhook URL
\n","type":"text"},{"key":"events","value":"","description":"String | Events Object
\n","type":"text","disabled":true},{"key":"auth","value":"","description":"String | Basic Auth (e.g: ‘username:password’)
\n","type":"text","disabled":true},{"key":"accountId","value":"","description":"Uuid | Account UUID
\n","type":"text","disabled":true},{"key":"numberId","value":"","description":"Uuid | Fax Number UUID
\n","type":"text","disabled":true},{"key":"notificationEmails","value":"","type":"text","description":"String[]
\n","disabled":true}]},"url":"https://api.documo.com/webhooks","description":"API Key Access: base | admin
String | Webook Name
\n","type":"text","disabled":true},{"key":"url","value":"","description":"String | Webhook URL
\n","type":"text","disabled":true},{"key":"events","value":"","description":"String | Events Object
\n","type":"text","disabled":true},{"key":"auth","value":"","description":"String | Basic Auth (e.g: ‘username:password’)
\n","type":"text","disabled":true},{"key":"accountId","value":"","description":"Uuid | Account UUID
\n","type":"text","disabled":true},{"key":"numberId","value":"","description":"Uuid | Fax Number UUID
\n","type":"text","disabled":true},{"key":"notificationEmails","value":"","type":"text","description":"String[]
\n","disabled":true}]},"url":"https://api.documo.com/webhooks/:webhookId","description":"API Key Access: base | admin
String | Required | Webhook UUID
\n","type":"text/plain"},"type":"any","value":null,"key":"webhookId"}]}},"response":[{"id":"14b76cea-1c17-485c-825b-866a71f3912e","name":"Update Webhook","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"Basic API_KEY","type":"text"},{"key":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"name","value":"example","description":"String | Webook Name","type":"text"},{"key":"url","value":"example","description":"String | Webhook URL","type":"text"},{"key":"events","value":"{ \"fax.inbound\": true, \"fax.outbound\": true, \"fax.outbound.extended\": true, \"user.create\": true, \"user.delete\": true, \"number.add\": false, \"number.release\": false, \"document.complete\": false, \"document.failed\": false }","description":"Object | Events Object","type":"text"},{"key":"auth","value":"example","description":"String | Basic Auth (e.g: ‘username:password’)","type":"text"},{"key":"accountId","value":"d1077489-5ea1-4db1-9760-853f175e8288","description":"Uuid | Account UUID","type":"text"},{"key":"numberId","value":"d1077489-5ea1-4db1-9760-853f175e8288","description":"Uuid | Fax Number UUID","type":"text"},{"key":"attachmentEnabled","value":"false","type":"text","description":"Boolean"},{"key":"notificationEmails","value":"example,example","type":"text","description":"String[]"}]},"url":{"raw":"https://api.documo.com/webhooks/:webhookId","host":["https://api.documo.com"],"path":["webhooks",":webhookId"],"variable":[{"key":"webhookId","value":"d1077489-5ea1-4db1-9760-853f175e8288","description":"String | Required | Webhook UUID"}]}},"code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"uuid\": \"00000000-0000-0000-0000-000000000000\",\n \"name\": \"Webhook\",\n \"enabled\": true,\n \"url\": \"https://webhook.com/test\",\n \"auth\": null,\n \"accountId\": \"00000000-0000-0000-0000-000000000000\",\n \"numberId\": null,\n \"events\": [\n \"fax.v1.inbound.init\",\n \"fax.v1.number.add\",\n \"identity.v1.user.create\"\n ],\n \"notificationEmails\": null,\n \"createdAt\": \"2023-01-01T00:00:00.000Z\",\n \"updatedAt\": \"2023-01-01T00:00:00.000Z\",\n \"account\": {\n \"uuid\": \"00000000-0000-0000-0000-000000000000\",\n \"accountName\": \"Night’s Watch\",\n \"accountNumber\": \"1202000000\",\n \"accountType\": \"customer\"\n }\n}\n"}],"_postman_id":"04752671-6bf7-4ee6-bfa2-dabe2ae79fda"},{"name":"Delete Webhook","id":"bbd40676-34fc-4cfc-b9df-b164ed504125","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.documo.com/webhooks/:webhookId","description":"API Key Access: base | admin
String | Required | Webhook UUID
\n","type":"text/plain"},"type":"any","value":"","key":"webhookId"}]}},"response":[{"id":"92116e78-5a63-4b3e-b60a-7032a19f85cf","name":"Delete Webhook","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Basic API_KEY","type":"text"}],"url":{"raw":"https://api.documo.com/webhooks/:webhookId","host":["https://api.documo.com"],"path":["webhooks",":webhookId"],"variable":[{"key":"webhookId","value":"d1077489-5ea1-4db1-9760-853f175e8288","description":"String | Required | Webhook UUID"}]}},"code":204,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"OK"}],"_postman_id":"bbd40676-34fc-4cfc-b9df-b164ed504125"},{"name":"View Webhooks","id":"e42144a3-ad8c-4fac-b58d-919d719b8069","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.documo.com/webhooks","description":"API Key Access: base | admin
Uuid | Account’s UUID
\n","type":"text/plain"},"key":"accountId","value":""},{"disabled":true,"description":{"content":"Uuid | Fax Number UUID
\n","type":"text/plain"},"key":"numberId","value":""}],"variable":[]}},"response":[{"id":"01590dd8-719a-44ed-a432-4128b8162fbb","name":"View Webhooks","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic API_KEY","type":"text"}],"url":{"raw":"https://api.documo.com/webhooks","host":["https://api.documo.com"],"path":["webhooks"],"query":[{"key":"accountId","value":"","description":"Uuid | Account’s UUID","type":"text","disabled":true},{"key":"numberId","value":"","description":"Uuid | Fax Number UUID","type":"text","disabled":true}]}},"code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"count\": 10,\n \"rows\": [\n {\n \"uuid\": \"00000000-0000-0000-0000-000000000000\",\n \"name\": \"Webhook\",\n \"enabled\": true,\n \"url\": \"https://webhook.com/test\",\n \"auth\": null,\n \"accountId\": \"00000000-0000-0000-0000-000000000000\",\n \"numberId\": null,\n \"events\": [\n \"fax.v1.inbound.init\",\n \"fax.v1.number.add\",\n \"identity.v1.user.create\"\n ],\n \"notificationEmails\": null,\n \"createdAt\": \"2023-01-01T00:00:00.000Z\",\n \"updatedAt\": \"2023-01-01T00:00:00.000Z\"\n },\n ...\n ]\n}"}],"_postman_id":"e42144a3-ad8c-4fac-b58d-919d719b8069"}],"id":"da8dc725-8327-470c-83e4-34b40205cfa2","_postman_id":"da8dc725-8327-470c-83e4-34b40205cfa2","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"Rate Limit: 8 per minute
\nReturns summary report.
\nAPI Key Access: admin
String | Filter by account
\n","type":"text/plain"},"key":"accountId","value":""},{"disabled":true,"description":{"content":"String | Start date as ISO 8601 string. Filtering by ‘resolvedDate’ | Default: beginning of month
\n","type":"text/plain"},"key":"startDate","value":""},{"disabled":true,"description":{"content":"String | End date as ISO 8601 string. Filtering by ‘resolvedDate’ | Default: end of month
\n","type":"text/plain"},"key":"endDate","value":""},{"disabled":true,"description":{"content":"Boolean | If true - returns result as .csv file
\n","type":"text/plain"},"key":"csv","value":""},{"disabled":true,"description":{"content":"Boolean | If true - compiles report in the background and delivers it to mDrive when complete
\n","type":"text/plain"},"key":"deliverToDrive","value":""},{"disabled":true,"description":{"content":"String | The uuid of the mDrive folder to deliver the report to
\n","type":"text/plain"},"key":"folderId","value":""},{"disabled":true,"description":{"content":"Boolean | If true - compiles report in the background and delivers it to your email address when complete
\n","type":"text/plain"},"key":"deliverToEmail","value":""},{"disabled":true,"description":{"content":"Integer | Default: 0 | Number of results to skip (used for pagination)
\n","type":"text/plain"},"key":"offset","value":""},{"disabled":true,"description":{"content":"Integer | Default: 100 | Number of results to be returned (used for pagination)
\n","type":"text/plain"},"key":"limit","value":""},{"disabled":true,"description":{"content":"String | Accepts accounts, users, numbers, or faxbridges. Defaults to users.
\n","type":"text/plain"},"key":"reportState","value":""},{"disabled":true,"description":{"content":"Boolean | Include children to report
\n","type":"text/plain"},"key":"includeSubaccounts","value":""}],"variable":[]}},"response":[{"id":"d0aee1f7-89c2-4af3-a692-53b7aadfae20","name":"Summary Report","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic API_KEY"}],"url":{"raw":"https://api.documo.com/v1/reports/summary","host":["https://api.documo.com"],"path":["v1","reports","summary"],"query":[{"key":"startDate","value":"","description":"String | Start date as ISO 8601 string. Filtering by ‘resolvedDate’","disabled":true},{"key":"endDate","value":"","description":"String | End date as ISO 8601 string. Filtering by ‘resolvedDate’","disabled":true},{"key":"csv","value":"","description":"Boolean | If true - returns result as .csv file","disabled":true},{"key":"deliverToDrive","value":null,"description":"Boolean | If true - compiles report in the background and delivers it to mDrive when complete","disabled":true},{"key":"folderId","value":null,"description":"String | The uuid of the mDrive folder to deliver the report to","disabled":true},{"key":"deliverToEmail","value":null,"description":"Boolean | If true - compiles report in the background and delivers it to your email address when complete","disabled":true},{"key":"offset","value":"","description":"Integer | Default: 0 | Number of results to skip (used for pagination)","disabled":true},{"key":"limit","value":"","description":"Integer | Default: 100 | Number of results to be returned (used for pagination)","disabled":true},{"key":"reportState","value":"","description":"String | Accepts accounts, users, numbers, or faxbridges. Defaults to users.","disabled":true},{"key":"includeSubaccounts","value":"","description":"Boolean | Include children to report","disabled":true},{"key":"accountId","value":"","description":"String | Filter by account","disabled":true}]}},"code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"count\": 1,\n \"rows\": [\n {\n \"accountType\": \"reseller\",\n \"accountName\": \"The Master Account\",\n \"accountNumber\": \"1234567891\",\n \"totalAttempts\": 0,\n \"totalDuration\": 0,\n \"totalFailed\": 0,\n \"totalSuccess\": 0,\n \"totalPages\": 0,\n \"totalFaxes\": 0\n }\n ]\n}"}],"_postman_id":"16729e57-827f-4e5a-a9fe-a0e1d57a0408"},{"name":"Detailed Report","id":"dfedb3ae-1ffb-46cc-9726-81d499512d28","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.documo.com/v1/reports/detailed","description":"Rate Limit: 8 per minute
\nReturns detailed report.
\nAPI Key Access: admin
String | Filter by account
\n","type":"text/plain"},"key":"accountId","value":""},{"disabled":true,"description":{"content":"String | Filter by User ID
\n","type":"text/plain"},"key":"userId","value":""},{"disabled":true,"description":{"content":"String | Start date as ISO 8601 string. Filtering by ‘resolvedDate’
\n","type":"text/plain"},"key":"startDate","value":""},{"disabled":true,"description":{"content":"String | End date as ISO 8601 string. Filtering by ‘resolvedDate’
\n","type":"text/plain"},"key":"endDate","value":""},{"disabled":true,"description":{"content":"String | If true - returns result as .csv file
\n","type":"text/plain"},"key":"csv","value":""},{"disabled":true,"description":{"content":"Boolean | If true - compiles report in the background and delivers it to mDrive when complete
\n","type":"text/plain"},"key":"deliverToDrive","value":""},{"disabled":true,"description":{"content":"String | The uuid of the mDrive folder to deliver the report to
\n","type":"text/plain"},"key":"folderId","value":""},{"disabled":true,"description":{"content":"Boolean | If true - compiles report in the background and delivers it to your email address when complete
\n","type":"text/plain"},"key":"deliverToEmail","value":""},{"disabled":true,"description":{"content":"Integer | Default: 0 | Number of results to skip (used for pagination)
\n","type":"text/plain"},"key":"offset","value":""},{"disabled":true,"description":{"content":"Integer | Default: 50 | Number of results to be returned (used for pagination)
\n","type":"text/plain"},"key":"limit","value":""},{"disabled":true,"description":{"content":"String | Fax status - all, failed, success
\n","type":"text/plain"},"key":"status","value":""},{"disabled":true,"description":{"content":"String | Possible values: all, inbound, outbound
\n","type":"text/plain"},"key":"direction","value":""},{"disabled":true,"description":{"content":"String | Accepts accounts, users, numbers, or faxbridges. Defaults to users.
\n","type":"text/plain"},"key":"reportState","value":""},{"disabled":true,"description":{"content":"Boolean | Include children to report
\n","type":"text/plain"},"key":"includeSubaccounts","value":""}],"variable":[]}},"response":[{"id":"1a894697-c236-416b-9ebe-a78cd282ff76","name":"Detailed Report","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic API_KEY","type":"text"}],"url":{"raw":"https://api.documo.com/v1/reports/detailed","host":["https://api.documo.com"],"path":["v1","reports","detailed"],"query":[{"key":"userId","value":"","description":"String | Filter by User ID","type":"text","disabled":true},{"description":"String | Start date as ISO 8601 string. Filtering by ‘resolvedDate’","key":"startDate","type":"text","value":"","disabled":true},{"description":"String | End date as ISO 8601 string. Filtering by ‘resolvedDate’","key":"endDate","type":"text","value":"","disabled":true},{"description":"String | If true - returns result as .csv file","key":"csv","type":"text","value":"","disabled":true},{"description":"Integer | Default: 0 | Number of results to skip (used for pagination)","key":"offset","type":"text","value":"","disabled":true},{"description":"Integer | Default: 100 | Number of results to be returned (used for pagination)","key":"limit","type":"text","value":"","disabled":true},{"key":"status","value":"","description":"String | Fax status - all, failed, success","type":"text","disabled":true},{"key":"direction","value":"","description":"String | Possible values: all, inbound, outbound","type":"text","disabled":true},{"description":"String | Accepts accounts, users, numbers, or faxbridges. Defaults to users.","key":"reportState","type":"text","value":"","disabled":true},{"description":"Boolean | Include children to report","key":"includeSubaccounts","type":"text","value":"","disabled":true},{"description":"String | Filter by account","key":"accountId","type":"text","value":"","disabled":true},{"key":"deliverToDrive","value":null,"description":"Boolean | If true - compiles report in the background and delivers it to mDrive when complete","type":"text","disabled":true},{"key":"folderId","value":null,"description":"String | The uuid of the mDrive folder to deliver the report to","type":"text","disabled":true},{"key":"deliverToEmail","value":null,"description":"Boolean | If true - compiles report in the background and delivers it to your email address when complete","type":"text","disabled":true}]}},"code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"count\": 335,\n \"rows\": [\n {\n \"account\": {\n \"uuid\": \"00000000-0000-0000-0000-000000000000\",\n \"accountName\": \"Night’s Watch\",\n \"accountNumber\": \"1202100000\",\n \"accountType\": \"customer\"\n },\n \"createdAt\": \"2021-01-01T12:00:00.000Z\",\n \"deliveryId\": \"2201208225531330952\",\n \"direction\": \"outbound\",\n \"faxAttempt\": 1,\n \"faxCallerId\": \"5094570051\",\n \"faxCsid\": \"mFax\",\n \"faxDetected\": true,\n \"faxDuration\": 76000,\n \"faxEcm\": 256,\n \"faxNumber\": \"+18885551234\",\n \"faxProtocol\": 17,\n \"faxResultCode\": \"0\",\n \"faxSpeed\": 12000,\n \"faxbridge\": \"214041002320\",\n \"isSuccess\": true,\n \"pagesComplete\": 1,\n \"pagesCount\": 1,\n \"resolvedDate\": \"2021-01-01T12:00:30.000Z\",\n \"subject\": \"Fax Subject\",\n \"contacts\": \"John Doe, Jane Doe\",\n \"tags\": \"test, tag\"\n },\n ...\n ]\n}"}],"_postman_id":"dfedb3ae-1ffb-46cc-9726-81d499512d28"},{"name":"Billing Report","id":"a24c9f86-69ac-48c3-b486-4aed9ee0fb5a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.documo.com/v1/reports/billing","description":"This endpoint is deprecated
\nRate Limit: 8 per minute
\nReturns billing report.
\nAPI Key Access: admin
Boolean | If true - returns result as .csv file
\n","type":"text/plain"},"key":"csv","value":""},{"disabled":true,"description":{"content":"String | Filter by account
\n","type":"text/plain"},"key":"accountId","value":""},{"disabled":true,"description":{"content":"Integer | Default: 0 | Number of results to skip (used for pagination)
\n","type":"text/plain"},"key":"offset","value":""},{"disabled":true,"description":{"content":"Integer | Default: 100 | Max: 100 | Number of results to be returned (used for pagination)
\n","type":"text/plain"},"key":"limit","value":""},{"disabled":true,"description":{"content":"Boolean | If true - compiles report in the background and delivers it to mDrive when complete
\n","type":"text/plain"},"key":"deliverToDrive","value":null},{"disabled":true,"description":{"content":"String | The uuid of the mDrive folder to deliver the report to
\n","type":"text/plain"},"key":"folderId","value":null},{"disabled":true,"description":{"content":"Boolean | If true - compiles report in the background and delivers it to your email address when complete
\n","type":"text/plain"},"key":"deliverToEmail","value":null}],"variable":[]}},"response":[{"id":"34330065-3f6d-4fe7-bd5b-330ca0764c96","name":"Billing Report","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic API_KEY","type":"text"}],"url":{"raw":"https://api.documo.com/v1/reports/billing","host":["https://api.documo.com"],"path":["v1","reports","billing"],"query":[{"description":"Boolean | If true - returns result as .csv file","key":"csv","type":"text","value":"","disabled":true},{"description":"String | Filter by account","key":"accountId","type":"text","value":"","disabled":true},{"key":"offset","value":"","description":"Integer | Default: 0 | Number of results to skip (used for pagination)","disabled":true},{"key":"limit","value":"","description":"Integer | Default: 100 | Max: 100 | Number of results to be returned (used for pagination)","disabled":true},{"key":"deliverToDrive","value":null,"description":"Boolean | If true - compiles report in the background and delivers it to mDrive when complete","type":"text","disabled":true},{"key":"folderId","value":null,"description":"String | The uuid of the mDrive folder to deliver the report to","type":"text","disabled":true},{"key":"deliverToEmail","value":null,"description":"Boolean | If true - compiles report in the background and delivers it to your email address when complete","type":"text","disabled":true}]}},"code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"rows\": [\n {\n \"uuid\": \"123a4a5a-9999-4444-8888-bb12e3e4abcde\",\n \"accountName\": \"Account Name\",\n \"accountNumber\": \"2221184399\",\n \"accountType\": \"reseller\",\n \"subaccounts\": 10,\n \"numbers\": 15,\n \"users\": 25,\n \"faxbridges\": 10,\n \"metadata\": null\n },\n ...\n ]\n}"}],"_postman_id":"a24c9f86-69ac-48c3-b486-4aed9ee0fb5a"}],"id":"dc4e6fcd-2c3c-428f-9685-6ee56e039891","_postman_id":"dc4e6fcd-2c3c-428f-9685-6ee56e039891","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"String | Required | Account name
\n","type":"text"},{"key":"faxCallerId","value":"","description":"String | 10 characters limit | ID of fax caller
\n","type":"text","disabled":true},{"key":"faxCsid","value":"","description":"String | 20 characters limit | Unique fax ID
\n","type":"text","disabled":true},{"key":"emailNotifySendOption","value":"","description":"String | Outbound fax notification settings. Acceptable values: None, All (default), Success, Failure
\n","type":"text","disabled":true},{"key":"emailNotifyReceiveOption","value":"","description":"String | Inbound fax notification settings. Acceptable values: None, All (default), Success, Failure
\n","type":"text","disabled":true},{"key":"emailNotifySendIncAttachment","value":"","description":"Boolean | Outbound fax notification attachment settings. Acceptable values: true (default), false
\n","type":"text","disabled":true},{"key":"emailNotifyReceiveIncAttachment","value":"","description":"Boolean | Inbound fax notification attachment settings. Acceptable values: true (default), false
\n","type":"text","disabled":true},{"key":"timezone","value":"","description":"String | Timezone
\n","type":"text","disabled":true},{"key":"allowEmailToFax","value":"","description":"Boolean | Email to Fax
\n","type":"text","disabled":true},{"key":"usersTokenLife","value":"","description":"Integer | Set manual user token time for this account
\n","type":"text","disabled":true},{"key":"cf","value":"","description":"Object | Object with custom fields
\n","type":"text","disabled":true},{"key":"accountType","value":"","description":"Enum | reseller, subaccount, department | Optional | Type of account
\n","type":"text","disabled":true}]},"url":"https://api.documo.com/v1/accounts","description":"Creates subaccount or department for current user’s account.
\nAPI Key Access: admin
Returns all sub accounts of current user account.
\nAPI Key Access: admin
String | Account type. Acceptable values: subaccount, department, reseller
\n","type":"text/plain"},"key":"accountType","value":""},{"disabled":true,"description":{"content":"String | Include details, branding, plan. Example: branding,plan
\n","type":"text/plain"},"key":"include","value":""},{"disabled":true,"description":{"content":"Integer | Default: 0 | Number of results to skip (used for pagination)
\n","type":"text/plain"},"key":"offset","value":""},{"disabled":true,"description":{"content":"Integer | Default: 50 | Number of results to be returned (used for pagination)
\n","type":"text/plain"},"key":"limit","value":""},{"disabled":true,"description":{"content":"String | Sort response values by account_name, account_type, created_at in ascending or descending order. Example: account_name asc
\n","type":"text/plain"},"key":"order","value":""},{"disabled":true,"description":{"content":"String | Search by Account Name, Account Number, Account UUID
\n","type":"text/plain"},"key":"query","value":""},{"disabled":true,"description":{"content":"Boolean | Defalut: false | When true, includes all descendant accounts in the hierarchy; when false, only returns direct child accounts.
Returns current account info and settings.
\nAPI Key Access: admin
String | Required | Account UUID
\n","type":"text/plain"},"type":"any","value":null,"key":"accountId"}]}},"response":[{"id":"5f1a0da7-3950-404a-97d2-f17361711a7f","name":"View Account Info","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic API_KEY","type":"text"}],"url":{"raw":"https://api.documo.com/v1/accounts/:accountId","host":["https://api.documo.com"],"path":["v1","accounts",":accountId"],"variable":[{"key":"accountId","value":"d1077489-5ea1-4db1-9760-853f175e8288","description":"String | Required | Account UUID"}]}},"code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"account\": {\n \"uuid\": \"00000000-0000-0000-0000-000000000000\",\n \"accountName\": \"Night’s Watch\",\n \"accountNumber\": \"1201700000\",\n \"accountType\": \"customer\",\n \"allowAdmin\": \"inherit\",\n \"allowApi\": \"inherit\",\n \"allowEnterprise\": \"inherit\",\n \"allowAdminNumbersProvision\": \"allow\",\n \"allowAdminNumbersReleasing\": \"allow\",\n \"allowEmailToFax\": true,\n \"allowFaxAttachments\": true,\n \"allowNumbersForwarding\": \"allow\",\n \"allowNumbersManaging\": \"allow\",\n \"allowNumbersPorting\": \"deny\",\n \"allowUsersManaging\": \"allow\",\n \"timezone\": \"America/Los_Angeles\",\n \"emailNotifySendOption\": \"all\",\n \"emailNotifyReceiveOption\": \"all\",\n \"emailNotifySendIncAttachment\": true,\n \"emailNotifyReceiveIncAttachment\": true,\n \"emailNotifyEmailToFaxQueued\": true,\n \"faxCsid\": \"mFax\",\n \"faxCallerId\": \"12021234567\",\n \"faxDefaultCoverPage\": \"35fb8cc3-064b-4182-943a-76bf7e64725a\",\n \"faxLifetime\": \"31622400\",\n \"parentId\": \"35fb8cc3-064b-4182-943a-76bf7e64725a\",\n \"portingNotificationEmails\": [\"john@snow.com\"],\n \"createdAt\": \"2017-07-05T08:28:14.000Z\",\n \"updatedAt\": \"2018-09-04T16:41:14.000Z\",\n \"childrenCount\": 1,\n \"usersCount\": 17,\n \"cf\": {\n \"customField\": \"value\" \n }\n },\n \"breadcrumb\": []\n}"}],"_postman_id":"c44d59d9-2b13-4d70-9160-4a632e439cfb"},{"name":"Update Account","id":"eab89a11-4b63-4655-aa7e-cfacf048fc1b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"accountName","value":"","description":"String | Name of the company
\n","type":"text","disabled":true},{"key":"faxCallerId","value":"","description":"String | 10 characters limit | ID of fax caller
\n","type":"text","disabled":true},{"key":"faxCsid","value":"","description":"String | 20 characters limit | Unique fax ID
\n","type":"text","disabled":true},{"key":"emailNotifySendOption","value":"","description":"String | Outbound fax notification settings. Acceptable values: None, All (default), Success, Failure
\n","type":"text","disabled":true},{"key":"emailNotifyReceiveOption","value":"","description":"String | Inbound fax notification settings. Acceptable values: None, All (default), Success, Failure
\n","type":"text","disabled":true},{"key":"emailNotifySendIncAttachment","value":"","description":"Boolean | Outbound fax notification attachment settings. Acceptable values: true (default), false
\n","type":"text","disabled":true},{"key":"emailNotifyReceiveIncAttachment","value":"","description":"Boolean | Inbound fax notification attachment settings. Acceptable values: true (default), false
\n","type":"text","disabled":true},{"key":"timezone","value":"","description":"String | Timezone
\n","type":"text","disabled":true},{"key":"allowEmailToFax","value":"","description":"Boolean | Email to Fax
\n","type":"text","disabled":true},{"key":"usersTokenLife","value":"","description":"Integer | Set manual user token time for this account
\n","type":"text","disabled":true},{"key":"isSuspend","value":"","description":"Boolean | Value of true puts account in suspended status. Users will not be able to login or perform billable functions
\n","type":"text","disabled":true},{"key":"suspendAt","value":"","description":"Date | Sets a date that account will move to suspended status. E.g: ‘2019-01-01T12:00:00.000Z’
\n","type":"text","disabled":true},{"key":"cf","value":"","description":"Object | Object with custom fields
\n","type":"text","disabled":true}]},"url":"https://api.documo.com/v1/accounts/:accountId","description":"This method will allow you to modify global account settings and info. You will need to pass through the account ID and will also need administrative privileges to access.
\nAPI Key Access: admin
String | Required | Account UUID
\n","type":"text/plain"},"type":"any","value":null,"key":"accountId"}]}},"response":[{"id":"c2aa870d-3582-4c1b-ae63-1f04f30d5f07","name":"Update Account","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"Basic API_KEY","type":"text"},{"key":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"accountName","value":"example","description":"String | Name of the company","type":"text"},{"key":"faxCallerId","value":"example","description":"String | 10 characters limit | ID of fax caller","type":"text"},{"key":"faxCsid","value":"example","description":"String | 20 characters limit | Unique fax ID","type":"text"},{"key":"emailNotifySendOption","value":"None","description":"String | Outbound fax notification settings. Acceptable values: None, All (default), Success, Failure","type":"text"},{"key":"emailNotifyReceiveOption","value":"None","description":"String | Inbound fax notification settings. Acceptable values: None, All (default), Success, Failure","type":"text"},{"key":"emailNotifySendIncAttachment","value":"false","description":"Boolean | Outbound fax notification attachment settings. Acceptable values: true (default), false","type":"text"},{"key":"emailNotifyReceiveIncAttachment","value":"false","description":"Boolean | Inbound fax notification attachment settings. Acceptable values: true (default), false","type":"text"},{"key":"timezone","value":"pacific","description":"String | Timezone","type":"text"},{"key":"allowEmailToFax","value":"false","description":"Boolean | Email to Fax","type":"text"},{"key":"usersTokenLife","value":"1","description":"Integer | Set manual user token time for this account","type":"text"},{"key":"isSuspend","value":"false","description":"Boolean | Value of true puts account in suspended status. Users will not be able to login or perform billable functions","type":"text"},{"key":"suspendAt","value":"2020-01-01T00:00:00.000Z","description":"Date | Sets a date that account will move to suspended status. E.g: ‘2019-01-01T12:00:00.000Z’","type":"text"},{"key":"cf","value":"{\"example\": \"value\"}","description":"Object | Object with custom fields","type":"text"}]},"url":{"raw":"https://api.documo.com/v1/accounts/:accountId","host":["https://api.documo.com"],"path":["v1","accounts",":accountId"],"variable":[{"key":"accountId","value":"d1077489-5ea1-4db1-9760-853f175e8288","description":"String | Required | Account UUID"}]}},"code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"uuid\": \"00000000-0000-0000-0000-000000000000\",\n \"accountName\": \"Night’s Watch\",\n \"accountNumber\": \"1201700000\",\n \"accountType\": \"customer\",\n \"allowAdmin\": \"inherit\",\n \"allowApi\": \"inherit\",\n \"allowEnterprise\": \"inherit\",\n \"allowAdminNumbersProvision\": \"allow\",\n \"allowAdminNumbersReleasing\": \"allow\",\n \"allowEmailToFax\": true,\n \"allowFaxAttachments\": true,\n \"allowNumbersForwarding\": \"allow\",\n \"allowNumbersManaging\": \"allow\",\n \"allowNumbersPorting\": \"deny\",\n \"allowUsersManaging\": \"allow\",\n \"timezone\": \"America/Los_Angeles\",\n \"emailNotifySendOption\": \"all\",\n \"emailNotifyReceiveOption\": \"all\",\n \"emailNotifySendIncAttachment\": true,\n \"emailNotifyReceiveIncAttachment\": true,\n \"emailNotifyEmailToFaxQueued\": true,\n \"faxCsid\": \"mFax\",\n \"faxCallerId\": \"12021234567\",\n \"faxDefaultCoverPage\": \"35fb8cc3-064b-4182-943a-76bf7e64725a\",\n \"faxLifetime\": \"31622400\",\n \"parentId\": \"35fb8cc3-064b-4182-943a-76bf7e64725a\",\n \"portingNotificationEmails\": [\"john@snow.com\"],\n \"createdAt\": \"2017-07-05T08:28:14.000Z\",\n \"updatedAt\": \"2018-09-04T16:41:14.000Z\",\n \"childrenCount\": 1,\n \"usersCount\": 17,\n \"cf\": {\n \"customField\": \"new value\"\n }\n}"}],"_postman_id":"eab89a11-4b63-4655-aa7e-cfacf048fc1b"},{"name":"Delete Account","id":"b929d7a0-ddd1-415c-9d34-8e38af35f330","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.documo.com/v1/accounts/:accountId","description":"Deletes account, users and all assigned numbers. You won’t be able to delete account if it has subbacounts.
\nAPI Key Access: admin
String | Required | Account UUID
\n","type":"text/plain"},"type":"any","value":null,"key":"accountId"}]}},"response":[{"id":"22aac301-5ac0-40e9-9c1e-f25fded37c36","name":"Delete Account","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Basic API_KEY","type":"text"}],"url":{"raw":"https://api.documo.com/v1/accounts/:accountId","host":["https://api.documo.com"],"path":["v1","accounts",":accountId"],"variable":[{"key":"accountId","value":"d1077489-5ea1-4db1-9760-853f175e8288","description":"String | Required | Account UUID"}]}},"code":204,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"OK"}],"_postman_id":"b929d7a0-ddd1-415c-9d34-8e38af35f330"}],"id":"6b61141f-d401-4962-85c3-254681615327","description":"Accessible by admin level users only.
\n","event":[{"listen":"prerequest","script":{"id":"8d5d042b-fec2-4a99-a677-a942332a7c3c","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"b1331305-7117-4d1e-8a8d-b6438302d9b6","type":"text/javascript","exec":[""]}}],"_postman_id":"6b61141f-d401-4962-85c3-254681615327","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"String | Required | 100 characters limit | First name on the card
\n","type":"text"},{"key":"lastName","value":"","description":"String | Required | 100 characters limit | Last name on the card
\n","type":"text"},{"key":"email","value":"","description":"String | Required | User email
\n","type":"text"},{"key":"userRole","value":"","description":"String | Required | User role
\n","type":"text"},{"key":"password","value":"","description":"String | Required | 128 characters limit | User password
\n","type":"text"},{"key":"phone","value":"","description":"String | User phone
\n","type":"text","disabled":true},{"key":"accountId","value":"","description":"String | Account id
\n","type":"text","disabled":true},{"key":"jobPosition","value":"","description":"String | Job position of user
\n","type":"text","disabled":true},{"key":"drive","value":"","description":"Boolean | If user should have mdrive access
\n","type":"text","disabled":true},{"key":"sign","value":"","description":"Boolean | If user should have msign access
\n","type":"text","disabled":true},{"key":"fax","value":"","description":"Boolean | If user should have mfax access
\n","type":"text","disabled":true},{"key":"faxCallerId","value":"","description":"String | 10 characters limit | ID of fax caller
\n","type":"text","disabled":true},{"key":"faxCsid","value":"","description":"String | 20 characters limit | Unique fax ID
\n","type":"text","disabled":true},{"key":"cf","value":"","description":"Object | Object with custom fields
\n","type":"text","disabled":true}]},"url":"https://api.documo.com/v1/users","description":"Creates a user for account.
\nAPI Key Access: admin
Deletes user and unassign all fax numbers.
\nAPI Key Access: admin
String | Required | User UUID
\n","type":"text/plain"},"type":"any","value":null,"key":"userId"}]}},"response":[{"id":"2efcdbd0-4f76-494b-9da6-3070ee45504d","name":"Delete User","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Basic API_KEY","type":"text"}],"url":{"raw":"https://api.documo.com/v1/users/:userId","host":["https://api.documo.com"],"path":["v1","users",":userId"],"variable":[{"key":"userId","value":"d1077489-5ea1-4db1-9760-853f175e8288","description":"String | Required | User UUID"}]}},"code":204,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"OK"}],"_postman_id":"c898d3f6-012a-4223-8557-c27e0a83b518"},{"name":"View User","id":"eb303ee3-48bd-4683-9130-2457f47635f7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.documo.com/v1/users/:userId","description":"API Key Access: admin
String | Required | User UUID
\n","type":"text/plain"},"type":"any","value":null,"key":"userId"}]}},"response":[{"id":"28ed61a0-47cd-4630-9ee8-cb5581c28f67","name":"View User","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic API_KEY","type":"text"}],"url":{"raw":"https://api.documo.com/v1/users/:userId","host":["https://api.documo.com"],"path":["v1","users",":userId"],"variable":[{"key":"userId","value":"d1077489-5ea1-4db1-9760-853f175e8288","description":"String | Required | User UUID"}]}},"code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"uuid\": \"6c838c7c-cb48-4763-84d6-233b5f8cf782\",\n \"accountId\": \"00000000-0000-0000-0000-000000000000\",\n \"avatarPath\": \"https://storage.googleapis.com/documo-storage/avatars/ddadc536-4569-4ad0-b510-743b751f775480x80.jpeg\",\n \"avatar\": \"ddadc536-4569-4ad0-b510-743b751f775480x80.jpeg\",\n \"email\": \"john@snow.com\",\n \"emailNotifySendOption\": \"all\",\n \"emailNotifyReceiveOption\": \"all\",\n \"emailNotifySendIncAttachment\": true,\n \"emailNotifyReceiveIncAttachment\": true,\n \"emailNotifyEmailToFaxQueued\": true,\n \"faxCsid\": \"mFax\",\n \"faxCallerId\": \"12021234567\",\n \"faxDefaultCoverPage\": \"35fb8cc3-064b-4182-943a-76bf7e64725a\",\n \"firstName\": \"Jon\",\n \"lastName\": \"Snow\",\n \"isEmailConfirmed\": true,\n \"ownedBy\": \"00000000-0000-0000-0000-000000000000\",\n \"phone\": \"(201) 555-1234\",\n \"createdAt\": \"2017-07-05T08:39:59.000Z\",\n \"updated_at\": \"2018-09-04T17:13:05.747Z\",\n \"userRole\": \"user\",\n \"account\": {\n ...\n },\n \"cf\": {\n \"customField\": \"value\" \n }\n}"}],"_postman_id":"eb303ee3-48bd-4683-9130-2457f47635f7"},{"name":"View Users","id":"48eb1985-07b3-4256-915b-9a3fe891ec27","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.documo.com/v1/users","description":"Get all users for account that is specified in path.
\nAPI Key Access: admin
Integer | Default: 20 | Number of results to be returned (used for pagination)
\n","type":"text/plain"},"key":"limit","value":""},{"disabled":true,"description":{"content":"Integer | Default: 0 | Number of results to skip (used for pagination)
\n","type":"text/plain"},"key":"offset","value":""},{"disabled":true,"description":{"content":"String | Search by email, first name, last name, phone, fax_csid and fax_caller_id
\n","type":"text/plain"},"key":"query","value":""},{"disabled":true,"description":{"content":"String | Result order. Available values: email first_name last_name users_count last_login_date + asc desc. E.g: email asc
\n","type":"text/plain"},"key":"order","value":""}],"variable":[]}},"response":[{"id":"50d57c04-e699-4e9f-876b-2ffdd5c5acc5","name":"View Users","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic API_KEY","type":"text"}],"url":{"raw":"https://api.documo.com/v1/users/{userId}","host":["https://api.documo.com"],"path":["v1","users","{userId}"],"query":[{"key":"limit","value":"","description":"Integer | Default: 20 | Number of results to be returned (used for pagination)","type":"text","disabled":true},{"key":"offset","value":"","description":"Integer | Default: 0 | Number of results to skip (used for pagination)","type":"text","disabled":true},{"key":"query","value":"","description":"String | Search by email, first name, last name, phone, fax_csid and fax_caller_id","type":"text","disabled":true},{"key":"order","value":"","description":"String | Result order. Available values: email first_name last_name users_count last_login_date + asc desc. E.g: email asc","type":"text","disabled":true}]}},"code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"count\": 10,\n \"rows\": [\n {\n \"uuid\": \"6c838c7c-cb48-4763-84d6-233b5f8cf782\",\n \"accountId\": \"00000000-0000-0000-0000-000000000000\",\n \"avatarPath\": \"https://storage.googleapis.com/documo-storage/avatars/ddadc536-4569-4ad0-b510-743b751f775480x80.jpeg\",\n \"avatar\": \"ddadc536-4569-4ad0-b510-743b751f775480x80.jpeg\",\n \"email\": \"john@snow.com\",\n \"emailNotifySendOption\": \"all\",\n \"emailNotifyReceiveOption\": \"all\",\n \"emailNotifySendIncAttachment\": true,\n \"emailNotifyReceiveIncAttachment\": true,\n \"emailNotifyEmailToFaxQueued\": true,\n \"faxCsid\": \"mFax\",\n \"faxCallerId\": \"12021234567\",\n \"faxDefaultCoverPage\": \"35fb8cc3-064b-4182-943a-76bf7e64725a\",\n \"firstName\": \"Jon\",\n \"lastName\": \"Snow\",\n \"isEmailConfirmed\": true,\n \"ownedBy\": \"00000000-0000-0000-0000-000000000000\",\n \"phone\": \"(201) 555-1234\",\n \"createdAt\": \"2017-07-05T08:39:59.000Z\",\n \"updated_at\": \"2018-09-04T17:13:05.747Z\",\n \"userRole\": \"user\",\n \"account\": {\n ...\n },\n \"cf\": {\n \"customField\": \"value\" \n }\n },\n ...\n ]\n}"}],"_postman_id":"48eb1985-07b3-4256-915b-9a3fe891ec27"},{"name":"Update User","id":"9656c1e6-cd8d-49b8-97e8-e528061e4fa9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"firstName","value":"","description":"String | 100 characters limit | First name on the card
\n","type":"text","disabled":true},{"key":"lastName","value":"","description":"String | 100 characters limit | Last name on the card
\n","type":"text","disabled":true},{"key":"phone","value":"","description":"String | User phone
\n","type":"text","disabled":true},{"key":"faxCallerId","value":"","description":"String | 10 characters limit | ID of fax caller
\n","type":"text","disabled":true},{"key":"faxCsid","value":"","description":"String | 20 characters limit | Unique fax ID
\n","type":"text","disabled":true},{"key":"emailNotifySendOption","value":"","description":"String | Outbound fax notification settings. Acceptable values: None, All (default), Success, Failure
\n","type":"text","disabled":true},{"key":"emailNotifyReceiveOption","value":"","description":"String | Inbound fax notification settings. Acceptable values: None, All (default), Success, Failure
\n","type":"text","disabled":true},{"key":"emailNotifySendIncAttachment","value":"","description":"Boolean | Outbound fax notification attachment settings. Acceptable values: true (default), false
\n","type":"text","disabled":true},{"key":"emailNotifyReceiveIncAttachment","value":"","description":"Boolean | Inbound fax notification attachment settings. Acceptable values: true (default), false
\n","type":"text","disabled":true},{"key":"emailToFaxCoverPageOption","value":"","description":"Boolean | Email to Fax cover page option
\n","type":"text","disabled":true},{"key":"cf","value":"","description":"Object | Object with custom fields
\n","type":"text","disabled":true}]},"url":"https://api.documo.com/v1/users/:userId","description":"Updates user info and settings by user ID.
\nAPI Key Access: admin
String | Required | User UUID
\n","type":"text/plain"},"type":"any","value":null,"key":"userId"}]}},"response":[{"id":"1da86f93-8086-42eb-ae70-ee6b749204e4","name":"Update User","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"Basic API_KEY","type":"text"},{"key":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"firstName","value":"example","description":"String | 100 characters limit | First name on the card","type":"text"},{"key":"lastName","value":"example","description":"String | 100 characters limit | Last name on the card","type":"text"},{"key":"phone","value":"1234567890","description":"String | User phone","type":"text"},{"key":"faxCallerId","value":"example","description":"String | 10 characters limit | ID of fax caller","type":"text"},{"key":"faxCsid","value":"example","description":"String | 20 characters limit | Unique fax ID","type":"text"},{"key":"emailNotifySendOption","value":"None","description":"String | Outbound fax notification settings. Acceptable values: None, All (default), Success, Failure","type":"text"},{"key":"emailNotifyReceiveOption","value":"None","description":"String | Inbound fax notification settings. Acceptable values: None, All (default), Success, Failure","type":"text"},{"key":"emailNotifySendIncAttachment","value":"false","description":"Boolean | Outbound fax notification attachment settings. Acceptable values: true (default), false","type":"text"},{"key":"emailNotifyReceiveIncAttachment","value":"false","description":"Boolean | Inbound fax notification attachment settings. Acceptable values: true (default), false","type":"text"},{"key":"emailToFaxCoverPageOption","value":"false","description":"Boolean | Email to Fax cover page option","type":"text"},{"key":"cf","value":"{\"example\": \"value\"}","description":"Object | Object with custom fields","type":"text"}]},"url":{"raw":"https://api.documo.com/v1/users/:userId","host":["https://api.documo.com"],"path":["v1","users",":userId"],"variable":[{"key":"userId","value":"d1077489-5ea1-4db1-9760-853f175e8288","description":"String | Required | User UUID"}]}},"code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"emailNotifySendOption\": \"All\",\n \"emailNotifyReceiveOption\": \"All\",\n \"emailNotifySendIncAttachment\": true,\n \"emailNotifyReceiveIncAttachment\": true,\n \"emailToFaxCoverPageOption\": true,\n \"userId\": \"fdb9f0dd-ac0c-4f3e-8e4b-1be0225186de\",\n \"accountId\": \"6c838c7c-cb48-4763-84d6-233b5f8cf782\",\n \"email\": \"example@mail.com\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"userRole\": \"user\",\n \"phone\": \"12021234567\",\n \"faxCsid\": \"mFax\",\n \"faxCallerId\": \"12021234567\",\n \"isEmailConfirmed\": true,\n \"createdAt\": \"2017-06-06T11:23:11.000Z\",\n \"cf\": {\n \"customField\": \"value\"\n }\n}"}],"_postman_id":"9656c1e6-cd8d-49b8-97e8-e528061e4fa9"}],"id":"8aa3410e-2ca5-4a60-a648-8465d4737670","_postman_id":"8aa3410e-2ca5-4a60-a648-8465d4737670","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"API Key Access: base | admin | print_driver
String | User ID. If not specified - returns results for current user
\n","type":"text/plain"},"key":"userId","value":""},{"disabled":true,"description":{"content":"Integer | Default: 0 | Number of results to skip (used for pagination)
\n","type":"text/plain"},"key":"offset","value":""},{"disabled":true,"description":{"content":"Integer | Default: 50 | Number of results to be returned (used for pagination)
\n","type":"text/plain"},"key":"limit","value":""},{"disabled":true,"description":{"content":"String | Order results. Ordered by name in ascending order, default value is name asc
\n","type":"text/plain"},"key":"order","value":""},{"disabled":true,"description":{"content":"String | Search by contact name, fax number, phone number or email
\n","type":"text/plain"},"key":"query","value":""}],"variable":[]}},"response":[{"id":"1ff17f03-2bc1-4ec7-a289-5606c901cd03","name":"View Contacts","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic API_KEY","type":"text"}],"url":{"raw":"https://api.documo.com/v1/contacts","host":["https://api.documo.com"],"path":["v1","contacts"],"query":[{"key":"userId","value":"","description":"String | User ID. If not specified - returns results for current user","disabled":true},{"key":"offset","value":"","description":"Integer | Default: 0 | Number of results to skip (used for pagination)","disabled":true},{"key":"limit","value":"","description":"Integer | Default: 50 | Number of results to be returned (used for pagination)","disabled":true},{"key":"order","value":"","description":"String | Order results. Ordered by name in ascending order, default value is name asc","disabled":true},{"key":"query","value":"","description":"String | Search by contact name, fax number, phone number or email","disabled":true}]}},"code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"count\": 1,\n \"rows\": [\n {\n \"uuid\": \"861660d0-1807-44cb-b68f-c96381a741d6\",\n \"isOrganization\": true,\n \"userId\": \"7b667809-c88f-4a27-b1fe-2cc932401e15\",\n \"name\": \"Organization\",\n \"phoneNumber\": \"\",\n \"faxNumber\": \"\",\n \"email\": \"org@com\",\n \"isPublic\": false,\n \"publicEditable\": false,\n \"organizationId\": null,\n \"contacts\": [\n {\n \"uuid\": \"1df1aa6d-0e5e-4a77-8dde-de601e902608\",\n \"isOrganization\": false,\n \"userId\": \"7b667809-c88f-4a27-b1fe-2cc932401e15\",\n \"name\": \"Person\",\n \"phoneNumber\": \"\",\n \"faxNumber\": \"\",\n \"email\": \"person@org\",\n \"isPublic\": false,\n \"publicEditable\": false,\n \"organizationId\": \"861660d0-1807-44cb-b68f-c96381a741d6\"\n }\n ]\n }\n ],\n \"limit\": 15,\n \"offset\": 0\n}"}],"_postman_id":"3a09fc24-9131-4169-853a-84c4720447c4"},{"name":"Create Contact","id":"b195b064-58a5-4a1e-ba01-59aab8f6b95f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"name","value":"","description":"String | Contact name
\n","type":"text","disabled":true},{"key":"email","value":"","description":"String | Contact email
\n","type":"text","disabled":true},{"key":"faxNumber","value":"","description":"Integer | Fax number must be in E164 or number format with country code included (ie. +19999999999, 19999999999). Required for sending fax using contact
\n","type":"text","disabled":true},{"key":"phoneNumber","value":"","description":"Integer | Phone number must be in E164 or number format with country code included (ie. +19999999999, 19999999999)
\n","type":"text","disabled":true},{"key":"organizationId","value":"","description":"String | Assign contact to existing organization contact
\n","type":"text","disabled":true},{"key":"isPublic","value":"","description":"Boolean | Contact will be shown for all users in the account
\n","type":"text","disabled":true},{"key":"isOrganization","value":"","description":"Boolean | If true, organization will be created
\n","type":"text","disabled":true},{"key":"publicEditable","value":"","description":"Boolean | All account users will be able to edit contact if value is true
\n","type":"text","disabled":true}]},"url":"https://api.documo.com/v1/contacts","description":"API Key Access: base | admin
String | Contact name
\n","key":"name","type":"text","value":"","disabled":true},{"description":"String | Contact email
\n","key":"email","type":"text","value":"","disabled":true},{"description":"Integer | Fax number must be in E164 or number format with country code included (ie. +19999999999, 19999999999). Required for sending fax using contact
\n","key":"faxNumber","type":"text","value":"","disabled":true},{"description":"Integer | Phone number must be in E164 or number format with country code included (ie. +19999999999, 19999999999)
\n","key":"phoneNumber","type":"text","value":"","disabled":true},{"description":"String | Assign contact to existing organization contact
\n","key":"organizationId","type":"text","value":"","disabled":true},{"description":"Boolean | Contact will be shown for all users in the account
\n","key":"isPublic","type":"text","value":"","disabled":true},{"description":"Boolean | If true, organization will be created
\n","key":"isOrganization","type":"text","value":"","disabled":true},{"description":"Boolean | All account users will be able to edit contact if value is true
\n","key":"publicEditable","type":"text","value":"","disabled":true}]},"url":"https://api.documo.com/v1/contacts/:contactId","description":"API Key Access: base | admin
String | Required | Contact UUID
\n","type":"text/plain"},"type":"any","value":null,"key":"contactId"}]}},"response":[{"id":"324dc8b0-fcb4-4ed0-893d-323c5d23b4d9","name":"Update Contact","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Basic API_KEY","type":"text"},{"key":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"description":"String | Contact name","key":"name","type":"text","value":"example"},{"description":"String | Contact email","key":"email","type":"text","value":"example"},{"description":"Integer | Fax number must be in E164 or number format with country code included (ie. +19999999999, 19999999999). Required for sending fax using contact","key":"faxNumber","type":"text","value":"+19999999999"},{"description":"Integer | Phone number must be in E164 or number format with country code included (ie. +19999999999, 19999999999)","key":"phoneNumber","type":"text","value":"+19999999999"},{"description":"String | Assign contact to existing organization contact","key":"organizationId","type":"text","value":"example"},{"description":"Boolean | Contact will be shown for all users in the account","key":"isPublic","type":"text","value":"false"},{"description":"Boolean | If true, organization will be created","key":"isOrganization","type":"text","value":"false"},{"description":"Boolean | All account users will be able to edit contact if value is true","key":"publicEditable","type":"text","value":"false"}]},"url":{"raw":"https://api.documo.com/v1/contacts/:contactId","host":["https://api.documo.com"],"path":["v1","contacts",":contactId"],"variable":[{"key":"contactId","value":"d1077489-5ea1-4db1-9760-853f175e8288","description":"String | Required | Contact UUID"}]}},"code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"uuid\": \"e073d09d-9edd-40b4-ba7a-8a423a52e74a\",\n \"name\": \"John Snow\",\n \"phoneNumber\": \"(201) 555-0123\",\n \"faxNumber\": \"(201) 555-0124\",\n \"email\": \"john@snow.com\",\n \"isPublic\": false,\n \"publicEditable\": false,\n \"isOrganization\": false,\n \"userId\": \"7b667809-c88f-4a27-b1fe-2cc932401e15\"\n}"}],"_postman_id":"a0225bb8-d3f8-41cf-985e-6c793ca5945c"},{"name":"Delete Contact","id":"0ce0293f-0d65-46f2-85e9-d1dd9adbca45","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.documo.com/v1/contacts/:contactId","description":"API Key Access: base | admin
String | Required | Contact UUID
\n","type":"text/plain"},"type":"any","value":null,"key":"contactId"}]}},"response":[{"id":"d84fda14-7d04-45e5-8811-c9ab9e9ba318","name":"Delete Contact","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Basic API_KEY","type":"text"}],"url":{"raw":"https://api.documo.com/v1/contacts/:contactId","host":["https://api.documo.com"],"path":["v1","contacts",":contactId"],"variable":[{"key":"contactId","value":"d1077489-5ea1-4db1-9760-853f175e8288","description":"String | Required | Contact UUID"}]}},"code":204,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"OK"}],"_postman_id":"0ce0293f-0d65-46f2-85e9-d1dd9adbca45"},{"name":"Bulk Delete Contact","id":"a5b2b268-977b-442b-ad8e-3e8aaa7c530c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.documo.com/v1/contacts/bulk","description":"API Key Access: base | admin
String | Contact IDs
\n","type":"text/plain"},"key":"contactIds","value":""}],"variable":[]}},"response":[{"id":"4225398c-4490-4900-b65a-e44ca3b42cf7","name":"Bulk Delete Contact","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Basic API_KEY","type":"text"}],"url":{"raw":"https://api.documo.com/v1/contacts/bulk?contactIds=d1077489-5ea1-4db1-9760-853f175e8288","host":["https://api.documo.com"],"path":["v1","contacts","bulk"],"query":[{"key":"contactIds","value":"d1077489-5ea1-4db1-9760-853f175e8288","description":"String | Contact IDs"}]}},"code":204,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"OK"}],"_postman_id":"a5b2b268-977b-442b-ad8e-3e8aaa7c530c"}],"id":"147eb9df-a870-43b7-a9b5-58ddff00d538","_postman_id":"147eb9df-a870-43b7-a9b5-58ddff00d538","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"API Key Access: base | admin | print_driver
String | Required | 32 characters limit | Tag name
\n","type":"text"},{"key":"color","value":"","description":"String | Required | 7 characters limit with # character | Tag color hex
\n","type":"text"},{"key":"isPublic","value":"","description":"Boolean | If tag should be shown for all users in the account
\n","type":"text","disabled":true}]},"url":"https://api.documo.com/v1/tag","description":"API Key Access: base | admin | print_driver
API Key Access: base | admin
String | Required | Tag UUID
\n","type":"text/plain"},"type":"any","value":null,"key":"tagId"}]}},"response":[{"id":"673364f1-8d31-47e0-8460-4fe105b1437b","name":"Delete Tag","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Basic API_KEY","type":"text"}],"url":{"raw":"https://api.documo.com/v1/tag/:tagId","host":["https://api.documo.com"],"path":["v1","tag",":tagId"],"variable":[{"key":"tagId","value":"d1077489-5ea1-4db1-9760-853f175e8288","description":"String | Required | Tag UUID"}]}},"code":204,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"OK"}],"_postman_id":"fad35e0c-e2e6-4ad2-90db-f0db62b079a0"},{"name":"View Fax Tags","id":"bbb7b41c-3b08-4589-ac57-3111427edc12","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.documo.com/v1/fax/:messageId/tags","description":"Get fax tags list by Message ID
\nAPI Key Access: base | admin
String | Required | Message UUID
\n","type":"text/plain"},"type":"any","value":null,"key":"messageId"}]}},"response":[{"id":"cebf1800-3bd6-4243-81a5-391021a5d26d","name":"View Fax Tags","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic API_KEY","type":"text"}],"url":{"raw":"https://api.documo.com/v1/fax/:messageId/tags","host":["https://api.documo.com"],"path":["v1","fax",":messageId","tags"],"variable":[{"key":"messageId","value":"d1077489-5ea1-4db1-9760-853f175e8288","description":"String | Required | Message UUID"}]}},"code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"[\n {\n \"uuid\": \"4c225812-81f1-4827-8194-b0e9475c54e6\",\n \"createdBy\": \"7b667809-c88f-4a27-b1fe-2cc932401e15\",\n \"name\": \"Healthcare\",\n \"color\": \"1E88E5\",\n \"isPublic\": 1\n }\n]"}],"_postman_id":"bbb7b41c-3b08-4589-ac57-3111427edc12"},{"name":"Assign Tag to Fax","id":"75251388-9cfd-4d28-90b9-c3756f4f1741","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"tagId","value":"","description":"String | Tag ID
\n","type":"text"}]},"url":"https://api.documo.com/v1/fax/:messageId/tag","description":"API Key Access: base | admin
String | Required | Message UUID
\n","type":"text/plain"},"type":"any","value":null,"key":"messageId"}]}},"response":[{"id":"2cd8147e-eef3-4d3c-9b82-14cf7fb0d977","name":"Assign Tag to Fax","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Basic API_KEY","type":"text"},{"key":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"tagId","value":"d1077489-5ea1-4db1-9760-853f175e8288","description":"Uuid | Tag ID","type":"text"}]},"url":{"raw":"https://api.documo.com/v1/fax/:messageId/tag","host":["https://api.documo.com"],"path":["v1","fax",":messageId","tag"],"variable":[{"key":"messageId","value":"d1077489-5ea1-4db1-9760-853f175e8288","description":"String | Required | Message UUID"}]}},"code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"75251388-9cfd-4d28-90b9-c3756f4f1741"},{"name":"Unassign Tag from Fax","id":"30fc34cc-214b-4a99-bd21-a1f5d4376f90","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.documo.com/v1/fax/:messageId/tag/:tagId","description":"API Key Access: base | admin
String | Required | Message UUID
\n","type":"text/plain"},"type":"any","value":null,"key":"messageId"},{"description":{"content":"String | Required | Tag UUID
\n","type":"text/plain"},"type":"any","value":null,"key":"tagId"}]}},"response":[{"id":"89ae0e7a-3ba9-460e-83be-314517f3dac7","name":"Unassign Tag from Fax","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Basic API_KEY","type":"text"}],"url":{"raw":"https://api.documo.com/v1/fax/:messageId/tag/:tagId","host":["https://api.documo.com"],"path":["v1","fax",":messageId","tag",":tagId"],"variable":[{"key":"messageId","value":"d1077489-5ea1-4db1-9760-853f175e8288","description":"String | Required | Message UUID"},{"key":"tagId","value":"d1077489-5ea1-4db1-9760-853f175e8288","description":"String | Required | Tag UUID"}]}},"code":204,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"OK"}],"_postman_id":"30fc34cc-214b-4a99-bd21-a1f5d4376f90"},{"name":"Assign Tag to Document","id":"99fba2e5-b96a-4bea-9ffa-07f617973ba3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"tagId","value":"","description":"String | Tag ID
\n","type":"text"}]},"url":"https://api.documo.com/v1/documents/:documentId/tag","description":"API Key Access: base | admin
String | Required | Document UUID
\n","type":"text/plain"},"type":"any","value":null,"key":"documentId"}]}},"response":[{"id":"2bf6d923-5a67-46f3-8ad8-a4802a25dee7","name":"Assign Tag to Document","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Basic API_KEY","type":"text"},{"key":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"tagId","value":"d1077489-5ea1-4db1-9760-853f175e8288","description":"Uuid | Tag ID","type":"text"}]},"url":{"raw":"https://api.documo.com/v1/documents/:documentId/tag","host":["https://api.documo.com"],"path":["v1","documents",":documentId","tag"],"variable":[{"key":"documentId","value":"d1077489-5ea1-4db1-9760-853f175e8288","description":"String | Required | Document UUID"}]}},"code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"99fba2e5-b96a-4bea-9ffa-07f617973ba3"},{"name":"Assign Tag to Template","id":"96848d08-a4a3-4a0d-9a44-d27ef4559632","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"tagId","value":"","description":"String | Tag ID
\n","type":"text"}]},"url":"https://api.documo.com/v1/templates/:templateId/tag","description":"API Key Access: base | admin
String | Required | Template UUID
\n","type":"text/plain"},"type":"any","value":null,"key":"templateId"}]}},"response":[{"id":"7566fa17-e5bf-4276-b7ff-6980eb56a867","name":"Assign Tag to Template","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Basic API_KEY","type":"text"},{"key":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"tagId","value":"d1077489-5ea1-4db1-9760-853f175e8288","description":"Uuid | Tag ID","type":"text"}]},"url":{"raw":"https://api.documo.com/v1/templates/:templateId/tag","host":["https://api.documo.com"],"path":["v1","templates",":templateId","tag"],"variable":[{"key":"templateId","value":"d1077489-5ea1-4db1-9760-853f175e8288","description":"String | Required | Template UUID"}]}},"code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"96848d08-a4a3-4a0d-9a44-d27ef4559632"},{"name":"Unassign Tag from Document","id":"9c6b84b9-2449-4fa5-b5bb-01a672e5ca39","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.documo.com/v1/documents/:documentId/tag/:tagId","description":"API Key Access: base | admin
String | Required | Document UUID
\n","type":"text/plain"},"type":"any","value":null,"key":"documentId"},{"description":{"content":"String | Required | Tag UUID
\n","type":"text/plain"},"type":"any","value":null,"key":"tagId"}]}},"response":[{"id":"75ae45b2-563f-4c14-a702-88abf2ec3792","name":"Unassign Tag from Document","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Basic API_KEY","type":"text"}],"url":{"raw":"https://api.documo.com/v1/documents/:documentId/tag/:tagId","host":["https://api.documo.com"],"path":["v1","documents",":documentId","tag",":tagId"],"variable":[{"key":"documentId","value":"d1077489-5ea1-4db1-9760-853f175e8288","description":"String | Required | Document UUID"},{"key":"tagId","value":"d1077489-5ea1-4db1-9760-853f175e8288","description":"String | Required | Tag UUID"}]}},"code":204,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"OK"}],"_postman_id":"9c6b84b9-2449-4fa5-b5bb-01a672e5ca39"},{"name":"Unassign Tag from Template","id":"c7efe25a-7779-4e9a-9c39-f102c9d59d54","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.documo.com/v1/templates/:templateId/tag/:tagId","description":"API Key Access: base | admin
String | Required | Template UUID
\n","type":"text/plain"},"type":"any","value":null,"key":"templateId"},{"description":{"content":"String | Required | Tag UUID
\n","type":"text/plain"},"type":"any","value":null,"key":"tagId"}]}},"response":[{"id":"a5e54d97-a969-47d1-bd58-b96e2c4557a7","name":"Unassign Tag from Template","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Basic API_KEY","type":"text"}],"url":{"raw":"https://api.documo.com/v1/templates/:templateId/tag/:tagId","host":["https://api.documo.com"],"path":["v1","templates",":templateId","tag",":tagId"],"variable":[{"key":"templateId","value":null,"description":"String | Required | Template UUID"},{"key":"tagId","value":null,"description":"String | Required | Tag UUID"}]}},"code":204,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"OK"}],"_postman_id":"c7efe25a-7779-4e9a-9c39-f102c9d59d54"}],"id":"40e23da0-733f-4c5c-a283-8c0bceab937f","_postman_id":"40e23da0-733f-4c5c-a283-8c0bceab937f","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"String | Required
\n"},{"key":"apiName","value":"","type":"text","description":"String | Required
\n"},{"key":"entity","value":"","type":"text","description":"String | Required | Possible values: fax, account, user
\n"},{"key":"displayUI","value":"","type":"text","description":"Boolean | Required
\n"},{"key":"displayUITable","value":"","type":"text","description":"Boolean | Required
\n"},{"key":"hint","value":"","type":"text","description":"String | Required
\n"}]},"url":"https://api.documo.com/v1/custom-fields","description":"API Key Access: base | admin | print_driver
Boolean
\n","disabled":true}]},"url":"https://api.documo.com/v1/custom-fields/:customFieldId","description":"API Key Access: base | admin | print_driver
String | Required | Custom Field UUID
\n","type":"text/plain"},"type":"any","value":null,"key":"customFieldId"}]}},"response":[{"id":"5400e2de-390e-4fdc-a366-772c0d77c65d","name":"Archive Custom Field","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"Basic API_KEY","type":"text"},{"key":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"isArchived","value":"false","type":"text","description":"Boolean"}]},"url":{"raw":"https://api.documo.com/v1/custom-fields/:customFieldId","host":["https://api.documo.com"],"path":["v1","custom-fields",":customFieldId"],"variable":[{"key":"customFieldId","value":"d1077489-5ea1-4db1-9760-853f175e8288","description":"String | Required | Custom Field UUID"}]}},"code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"uuid\": \"00000000-0000-0000-0000-000000000000\",\n \"label\": \"Patient ID\",\n \"apiName\": \"patientID\",\n \"entity\": \"fax\",\n \"displayUI\": false,\n \"displayUITable\": false,\n \"hint\": \"Patient ID from medical record\",\n \"accountId\": \"00000000-0000-0000-0000-000000000000\",\n \"isArchived\": true,\n \"archivedAt\": \"2021-01-01T12:00:00.000Z\",\n \"createdAt\": \"2021-01-01T12:00:00.000Z\"\n}"}],"_postman_id":"0d157c43-3393-4d72-a7f5-872c8b7af0ba"},{"name":"Delete Custom Field","id":"eabd8707-3ee2-40a1-8e98-75f97f7a61e7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.documo.com/v1/custom-fields/:customFieldId","description":"Deletes custom field.
\nNote: Only archived field can be deleted.
\nAPI Key Access: base | admin | print_driver
String | Required | Custom Field UUID
\n","type":"text/plain"},"type":"any","value":null,"key":"customFieldId"}]}},"response":[{"id":"98c28aa1-2c7f-4449-a2d6-243602c9e6c4","name":"Delete Custom Field","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Basic API_KEY","type":"text"}],"url":{"raw":"https://api.documo.com/v1/custom-fields/:customFieldId","host":["https://api.documo.com"],"path":["v1","custom-fields",":customFieldId"],"variable":[{"key":"customFieldId","value":"d1077489-5ea1-4db1-9760-853f175e8288","description":"String | Required | Custom Field UUID"}]}},"code":204,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"OK"}],"_postman_id":"eabd8707-3ee2-40a1-8e98-75f97f7a61e7"},{"name":"View Custom Fields","id":"d8f06a49-cdb5-4512-8e11-bdd1eb971861","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.documo.com/v1/custom-fields","description":"Get all custom fields.
\nAPI Key Access: base | admin | print_driver
String | Possible values: fax, account, user
\n","type":"text/plain"},"key":"entity","value":""}],"variable":[]}},"response":[{"id":"aecc34d9-2347-4b27-b1de-b6cadaf5e5ba","name":"View Custom Fields","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic API_KEY","type":"text"}],"url":{"raw":"https://api.documo.com/v1/custom-fields","host":["https://api.documo.com"],"path":["v1","custom-fields"],"query":[{"key":"entity","value":"","description":"String | Possible values: fax, account, user","type":"text","disabled":true}]}},"code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"count\": 1,\n \"rows\": [\n {\n \"uuid\": \"00000000-0000-0000-0000-000000000000\",\n \"label\": \"Patient ID\",\n \"apiName\": \"patientID\",\n \"entity\": \"fax\",\n \"displayUI\": false,\n \"displayUITable\": false,\n \"hint\": \"Patient ID from medical record\",\n \"accountId\": \"00000000-0000-0000-0000-000000000000\",\n \"isArchived\": true,\n \"archivedAt\": \"2021-01-01T12:00:00.000Z\",\n \"createdAt\": \"2021-01-01T12:00:00.000Z\"\n },\n ...\n ]\n}"}],"_postman_id":"d8f06a49-cdb5-4512-8e11-bdd1eb971861"}],"id":"f1dd6fa5-7af0-47f8-9129-befe6747dc0e","_postman_id":"f1dd6fa5-7af0-47f8-9129-befe6747dc0e","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"String | Required | Destination phone number.
\n","type":"text"},{"key":"coverPage","value":"","description":"Boolean | Default: false | Indicating true will include system cover page. If coverPage is added, this removes file requirement.
\n","type":"text","disabled":true},{"key":"coverPageId","value":"","description":"UUID | The uuid of the cover page you want to include. If this param isn’t set but coverPage is true, default cover page for user will be used.
\n","type":"text","disabled":true},{"key":"tags","value":"","description":"String | Comma separated list of tag IDs (ex. 4c225812-81f1-4827-8194-b0e9475c54e6,7328e171-bc1f-44a6-bc18-df40a4345c9d)
\n","type":"text","disabled":true},{"key":"recipientName","value":"","description":"String | 40 characters limit | Will populate in TO field of cover page
\n","type":"text","disabled":true},{"key":"senderName","value":"","description":"String | 40 characters limit | Will populate in FROM field of cover page
\n","type":"text","disabled":true},{"key":"subject","value":"","description":"String | 55 characters limit | Will populate Subject field of cover page
\n","type":"text","disabled":true},{"key":"callerId","value":"","description":"String | 10 characters limit | Phone number. Defaults to user setting if not included in call
\n","type":"text","disabled":true},{"key":"notes","value":"","description":"String | 4000 characters limit | Will populate Notes field of cover page
\n","type":"text","disabled":true},{"description":"Object | Object with custom fields
\n","key":"cf","type":"text","value":"","disabled":true},{"key":"scheduledDate","value":"","description":"String | ISO string indicating the date and time the fax is to be sent
\n","type":"text","disabled":true},{"key":"attachments","description":"File Stream | Required: if coverPage parameter is not added | File(s) you wish to fax. Add files to the stream in order they should be rendered.
\n","type":"file","value":null,"disabled":true},{"key":"attachmentUrls","value":"","description":"String Array | Array of url strings of the document you want to be attach and sent in this fax. Be aware that the total attachments, including attachmentUrls should not exceed our limit of 100 file attachments and each attachment should not exceed the 100mb in size.
\n","type":"text","disabled":true},{"key":"fileIds","value":"","description":"Uuid Array | The uuid of file entities stored in mDrive would serve as part of the attachments in the sent fax. This supports large file attachments
\n","type":"text"},{"key":"async","value":"","description":"Boolean | Default: false | When true, server immediately responds with an object that contains only messageId. Failure notifications will be sent over email to the user.
String | Default: auto | Default auto setting detects content type page by page and applies optimization automatically. Additionally, it will fallback to monochrome if grayscale image exceeds 400kb. Use text or image if you want to force such optimization.
Use this method to create and send a fax. You may include our default cover page by adding coverPage parameter with a value of true. Files added to the stream will be converted to the body of the fax in the order they are added.
\nAPI Key Access: base | admin | print_driver
String[] | Required | Destination phone number. Multiple destinations separated by comma.
\n","key":"recipientFax","type":"text","value":""},{"key":"recipientContacts","value":"","description":"String[] | Contact IDs separated by comma
\n","type":"text","disabled":true},{"description":"Blob | Required: if coverPage parameter is not added | File(s) you wish to fax. Add files to the stream in order they should be rendered.
\n","key":"attachments","type":"file","value":null,"disabled":true},{"description":"Boolean | Default: false | Indicating true will include system cover page. If coverPage is added, this removes file requirement.
\n","key":"coverPage","type":"text","value":"","disabled":true},{"description":"Uuid | The uuid of the cover page you want to include. If this param isn’t set but coverPage is true, default cover page for user will be used.
\n","key":"coverPageId","type":"text","value":"","disabled":true},{"description":"String | Comma separated list of tag IDs (ex. 4c225812-81f1-4827-8194-b0e9475c54e6,7328e171-bc1f-44a6-bc18-df40a4345c9d)
\n","key":"tags","type":"text","value":"","disabled":true},{"description":"String | 40 characters limit | Will populate in TO field of cover page
\n","key":"recipientName","type":"text","value":"","disabled":true},{"description":"String | 40 characters limit | Will populate in FROM field of cover page
\n","key":"senderName","type":"text","value":"","disabled":true},{"description":"String | 55 characters limit | Will populate Subject field of cover page
\n","key":"subject","type":"text","value":"","disabled":true},{"description":"String | 10 characters limit | Phone number. Defaults to user setting if not included in call
\n","key":"callerId","type":"text","value":"","disabled":true},{"description":"String | 4000 characters limit | Will populate Notes field of cover page
\n","key":"notes","type":"text","value":"","disabled":true},{"description":"Object | Object with custom fields
\n","key":"cf","type":"text","value":"","disabled":true},{"description":"String | ISO string indicating the date and time the fax is to be sent
\n","key":"scheduledDate","type":"text","value":"","disabled":true},{"key":"optimizeFax","value":"","description":"String | Default: auto | Default auto setting detects content type page by page and applies optimization automatically. Additionally, it will fallback to monochrome if grayscale image exceeds 400kb. Use text or image if you want to force such optimization.
Use this method to create and send a fax. You may include our default cover page by adding coverPage parameter with a value of true. Files added to the stream will be converted to the body of the fax in the order they are added.
\nMultiple recipients: You may add multiple comma separated recipient destinations. This will result in an identical fax being sent to each destination.
\nAPI Key Access: base | admin | print_driver
String | Required | Unique message identifier provided by Documo
\n","type":"text"},{"key":"recipientFax","value":"","description":"String | Use this parameter to change destination phone number.
\n","type":"text","disabled":true}]},"url":"https://api.documo.com/v1/fax/resend","description":"This call will resend a previously attempted fax. Simply supply the messageId of previous fax and we will resend.
\nAPI Key Access: base | admin
Blob | Required: if coverPage parameter is not added | File(s) you wish to fax. Add files to the stream in order they should be rendered.
\n","key":"attachments","type":"file","value":null},{"description":"Boolean | Default: false | Indicating true will include system cover page. If coverPage is added, this removes file requirement.
\n","key":"coverPage","type":"text","value":"","disabled":true},{"description":"Uuid | The uuid of the cover page you want to include. If this param isn’t set but coverPage is true, default cover page for user will be used.
\n","key":"coverPageId","type":"text","value":"","disabled":true},{"description":"String | 40 characters limit | Will populate in TO field of cover page
\n","key":"recipientName","type":"text","value":"","disabled":true},{"description":"String | 40 characters limit | Will populate in FROM field of cover page
\n","key":"senderName","type":"text","value":"","disabled":true},{"description":"String | 55 characters limit | Will populate Subject field of cover page
\n","key":"subject","type":"text","value":"","disabled":true},{"description":"String | 10 characters limit | Phone number. Defaults to user setting if not included in call
\n","key":"callerId","type":"text","value":"","disabled":true},{"description":"String | 4000 characters limit | Will populate Notes field of cover page
\n","key":"notes","type":"text","value":"","disabled":true},{"key":"optimizeFax","value":"","description":"String | Default: auto | Default auto setting detects content type page by page and applies optimization automatically. Additionally, it will fallback to monochrome if grayscale image exceeds 400kb. Use text or image if you want to force such optimization.
Use this method to preview fax file before sending it.
\nAPI Key Access: base | admin | print_driver
Blob | Excel file with list of recipients
\n","type":"file","value":null},{"description":"Boolean | Default: false | Indicating true will include system cover page. If coverPage is added, this removes file requirement.
\n","key":"coverPage","type":"text","value":"","disabled":true},{"description":"Uuid | The uuid of the cover page you want to include. If this param isn’t set but coverPage is true, default cover page for user will be used.
\n","key":"coverPageId","type":"text","value":"","disabled":true},{"key":"optimizeFax","value":"","description":"String | Default: auto | Default auto setting detects content type page by page and applies optimization automatically. Additionally, it will fallback to monochrome if grayscale image exceeds 400kb. Use text or image if you want to force such optimization.
Use this method to send out many faxes with a list of recipients in an excel file.
\nAPI Key Access: base | admin | print_driver
This method cancels sending of processing or scheduled faxes
\nAPI Key Access: base | admin
String | Required | Message UUID
\n","type":"text/plain"},"type":"any","value":null,"key":"messageId"}]}},"response":[{"id":"70f7703e-37fb-4b28-bb3f-c50aa24c8519","name":"Cancel Fax","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"Basic API_KEY","type":"text"},{"key":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"isArchived","value":"false","description":"Boolean | Use this parameter to change archived status of fax.","type":"text"}]},"url":{"raw":"https://api.documo.com/v1/fax/:messageId","host":["https://api.documo.com"],"path":["v1","fax",":messageId"],"variable":[{"key":"messageId","value":"d1077489-5ea1-4db1-9760-853f175e8288","description":"String | Required | Message UUID"}]}},"code":204,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":""}],"_postman_id":"08aa7bfa-206a-4332-bd06-44a2ceb092ac"},{"name":"Update Fax","id":"7683b27f-e874-4364-9d07-c796db3869f9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"isArchived","value":"","description":"Boolean | Use this parameter to change archived status of fax.
\n","type":"text","disabled":true}]},"url":"https://api.documo.com/v1/fax/:messageId","description":"This method will update fax properties, currently only isArchived property available for editing.
\nAPI Key Access: base | admin
String | Required | Message UUID
\n","type":"text/plain"},"type":"any","value":null,"key":"messageId"}]}},"response":[{"id":"e7d5841d-8d4f-449d-a96b-b553de962f2a","name":"Update Fax","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"Basic API_KEY","type":"text"},{"key":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"isArchived","value":"false","description":"Boolean | Use this parameter to change archived status of fax.","type":"text"}]},"url":{"raw":"https://api.documo.com/v1/fax/:messageId","host":["https://api.documo.com"],"path":["v1","fax",":messageId"],"variable":[{"key":"messageId","value":"d1077489-5ea1-4db1-9760-853f175e8288","description":"String | Required | Message UUID"}]}},"code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"accountId\":\"6c838c7c-cb48-4763-84d6-233b5f8cf782\",\n \"channelType\":\"web\",\n \"direction\":\"outbound\",\n \"createdAt\":\"2018-01-01T12:00:00.000Z\",\n \"deletedAt\":null,\n \"deliveryId\":\"2180614133420933276\",\n \"duration\":86318,\n \"faxAttempt\":1,\n \"faxbridgeId\":210000000000,\n \"faxCallerId\":\"5094570051\",\n \"faxCsid\":\"mFax\",\n \"faxDetected\":true,\n \"faxECM\":256,\n \"faxNumber\":\"+18885550000\",\n \"faxProtocol\":34,\n \"faxSpeed\":33600,\n \"isArchived\":false,\n \"isFilePurged\":false,\n \"isRead\":false,\n \"messageId\":\"027012f1-80c9-4be5-b093-1f54783dfa3b\",\n \"messageNumber\":\"8900000\",\n \"pagesComplete\":3,\n \"pagesCount\":3,\n \"status\":\"success\",\n \"resolvedDate\":\"2018-01-01T12:00:00.000Z\",\n \"resultCode\": \"0\",\n \"resultInfo\": \"OK\",\n \"contacts\":[]\n \"tags\":[],\n \"users\":[],\n \"faxbridge\": {\n \"deviceCode\": \"210000000000\",\n \"name\": \"FaxBridge\",\n \"isActive\": true\n },\n}"}],"_postman_id":"7683b27f-e874-4364-9d07-c796db3869f9"},{"name":"Download Fax","id":"7e276dda-ee4a-42c4-bd3e-eac06d1f400a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.documo.com/v1/fax/:messageId/download?format=pdf","description":"Method will return PDF download of requested fax.
\nAPI Key Access: base | admin
pdf | tiff
\n","type":"text/plain"},"key":"format","value":"pdf"}],"variable":[{"description":{"content":"String | Required | Message UUID
\n","type":"text/plain"},"type":"any","value":null,"key":"messageId"}]}},"response":[{"id":"bfb77d3f-1cae-47cc-a8ae-a33fa89d7b38","name":"Download Fax","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic API_KEY","type":"text"}],"url":{"raw":"https://api.documo.com/v1/fax/:messageId/download?format=pdf","host":["https://api.documo.com"],"path":["v1","fax",":messageId","download"],"query":[{"key":"format","value":"pdf","description":"pdf | tiff","type":"text"}],"variable":[{"key":"messageId","value":"d1077489-5ea1-4db1-9760-853f175e8288","description":"String | Required | Message UUID"}]}},"code":200,"_postman_previewlanguage":null,"header":[{"key":"Content-Disposition","value":"attachment; filename=\"Sample.pdf\"","description":"","type":"text"},{"key":"Content-Length","value":"53248","description":"","type":"text"},{"key":"Content-Type","value":"application/pdf","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"OK"}],"_postman_id":"7e276dda-ee4a-42c4-bd3e-eac06d1f400a"},{"name":"View Fax History","id":"520223cb-2e79-4d28-bd1f-41c273a70322","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.documo.com/v1/fax/history?accountId=&offset=&limit=&direction=&status=","description":"Rate Limit: 8 per minute
\nReturns detailed fax history as line items. Response is paged.
\nAPI Key Access: base | admin
String | Required | Account ID to get the history for
\n","type":"text/plain"},"key":"accountId","value":""},{"description":{"content":"String | Required | Default: 0 | Number of results to skip (used for pagination)
\n","type":"text/plain"},"key":"offset","value":""},{"description":{"content":"String | Required | Default: 10 | Maximum 500 | Number of results to be returned (used for pagination)
\n","type":"text/plain"},"key":"limit","value":""},{"description":{"content":"String | Required | Filters results by direction. Can indicate all (default), inbound or outbound
\n","type":"text/plain"},"key":"direction","value":""},{"description":{"content":"String | Required | Filters results by status. Can indicate all (default), failed, success, or processing
\n","type":"text/plain"},"key":"status","value":""},{"disabled":true,"description":{"content":"Date | Filters results from starting date by createdAt field. (ex. 2012-04-23)
Date | Filters results up to end date by createdAt field. (ex. 2012-04-23)
String | Filters results by User ID
\n","type":"text/plain"},"key":"userId","value":""},{"disabled":true,"description":{"content":"String | Search by CSID, Caller ID, fax number, message ID, subject, recipient name or custom fields.
\n","type":"text/plain"},"key":"query","value":""},{"disabled":true,"description":{"content":"String | Comma separated list of tag IDs (ex. 4c225812-81f1-4827-8194-b0e9475c54e6,7328e171-bc1f-44a6-bc18-df40a4345c9d)
Boolean | Filters by archived faxes if true
String[] | Include assigned contacts or tags. Example: tags,contacts
Boolean | The simplify parameter, when activated, omits counters from the response, resulting in faster processing. Use this option cautiously and only if you fully understand the potential impact on data presentation
Returns fax info.
\nAPI Key Access: base | admin
String | Required | Message UUID
\n","type":"text/plain"},"type":"any","value":null,"key":"messageId"}]}},"response":[{"id":"0ca9f5db-865a-451f-b5bf-743e845bb9f8","name":"View Fax Info","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic API_KEY","type":"text"}],"url":{"raw":"https://api.documo.com/v1/fax/:messageId/info","host":["https://api.documo.com"],"path":["v1","fax",":messageId","info"],"variable":[{"key":"messageId","value":"d1077489-5ea1-4db1-9760-853f175e8288","description":"String | Required | Message UUID"}]}},"code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"accountId\":\"00000000-0000-0000-0000-000000000000\",\n \"channelType\":\"web\",\n \"direction\":\"outbound\",\n \"createdAt\":\"2018-01-01T12:00:00.000Z\",\n \"deletedAt\":null,\n \"deliveryId\":\"2180614133420933276\",\n \"duration\":86318,\n \"faxAttempt\":1,\n \"faxbridgeId\":null,\n \"faxCallerId\":\"5094570051\",\n \"faxCsid\":\"mFax\",\n \"faxDetected\":true,\n \"faxECM\":256,\n \"faxNumber\":\"+18885550000\",\n \"faxProtocol\":34,\n \"faxSpeed\":33600,\n \"isArchived\":false,\n \"isFilePurged\":false,\n \"messageId\":\"027012f1-80c9-4be5-b093-1f54783dfa3b\",\n \"messageNumber\":\"8900000\",\n \"pagesComplete\":3,\n \"pagesCount\":3,\n \"status\":\"success\",\n \"resolvedDate\":\"2018-01-01T12:00:00.000Z\",\n \"resultCode\": \"0\",\n \"resultInfo\": \"OK\",\n \"contacts\":[],\n \"tags\":[],\n \"faxbridge\": {\n \"deviceCode\": \"210000000000\",\n \"name\": \"FaxBridge\",\n \"isActive\": true\n },\n \"users\": [\n {\n \"userId\": \"7b667809-c88f-4a27-b1fe-2cc932401e15\",\n \"firstName\": \"John\",\n \"lastName\": \"Snow\",\n \"email\": \"john@snow.com\"\n }\n ],\n \"account\": {\n \"uuid\": \"6c838c7c-cb48-4763-84d6-233b5f8cf782\",\n \"supportCode\": \"1201800000\",\n \"companyName\": \"Winterfell\"\n }\n}"}],"_postman_id":"c2dc1026-15d7-42ae-ac90-05c3757635f8"},{"name":"View Cover Pages","id":"c32a0dcc-0f5b-49b9-bc6a-9561ad292ce0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.documo.com/coverpages","description":"Use this method to fetch all available cover pages.
\nAPI Key Access: base | admin | print_driver
\\n
| To: ${tokens.recipientName} | \\nFrom: ${tokens.senderName} | \\n
| Fax: ${tokens.recipientFax} | \\nFax: ${tokens.callerId} | \\n
| RE: ${tokens.subject} | \\nDate: ${tokens.date} | \\n
| Pages: ${tokens.pages} | \\n
Comments: ${tokens.notes}
\",\n \"accountId\": null,\n \"userId\": null,\n \"isPublic\": true,\n \"previewLink\": \"https://storage.googleapis.com/documo-storage/coverpages/00000000-0000-0000-0000-000000000000.png\"\n },\n ...\n]"}],"_postman_id":"c32a0dcc-0f5b-49b9-bc6a-9561ad292ce0"},{"name":"Delete Fax","id":"b26d40bd-52d5-466b-aedc-8b4f9c7a28b5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.documo.com/v1/fax/:messageId","description":"Removes a fax.
\nAPI Key Access: base | admin
String | Required | Message UUID
\n","type":"text/plain"},"type":"any","value":null,"key":"messageId"}]}},"response":[{"id":"51862686-9bf6-4beb-b2ac-f61b05b5fdb2","name":"Delete Fax","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Basic API_KEY","type":"text"}],"url":{"raw":"https://api.documo.com/v1/fax/:messageId","host":["https://api.documo.com"],"path":["v1","fax",":messageId"],"variable":[{"key":"messageId","value":"d1077489-5ea1-4db1-9760-853f175e8288","description":"String | Required | Message UUID"}]}},"code":204,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"OK"}],"_postman_id":"b26d40bd-52d5-466b-aedc-8b4f9c7a28b5"},{"name":"Fax Split Download","id":"9e2afd3a-99e5-4553-b5f6-f1b6d5eddc64","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n // faxId - UUID | Required | Fax identifier (messageId)\n \"faxId\": \"\",\n\n // pageGroups - Array of DcmPageGroup | Required | Document split instructions\n \"pageGroups\": [\n {\n // name - String | Required | Name of document\n \"name\": \"\",\n\n // pagesStr - Comma separated interval of page indexes to be splitted | Required | 1-2,3-4\n \"pagesStr\": \"\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.documo.com/v1/fax/download/split","description":"This endpoint is used to split a fax document based on the provided instructions.
\nDcmPageGroup {\n name: string,\n pagesStr: string,\n}\nexample: [{\"name\":\"Document 1\",\"pagesStr\":\"1-3,4-6\"}]\n\nStatus: 200
\nContent-Type: application/zip, application/octet-stream
\nReturns all fax numbers owned by account.
\nAPI Key Access: admin
String | Account ID
\n","type":"text/plain"},"key":"accountId","value":""},{"disabled":true,"description":{"content":"String | Possible values: available, assigned, pending
\n","type":"text/plain"},"key":"type","value":""},{"disabled":true,"description":{"content":"Integer | Default: 0 | Number of results to skip (used for pagination)
\n","type":"text/plain"},"key":"offset","value":""},{"disabled":true,"description":{"content":"Integer | Default: 30 | Number of results to be returned (used for pagination)
\n","type":"text/plain"},"key":"limit","value":""},{"disabled":true,"description":{"content":"String | Search query
\n","type":"text/plain"},"key":"query","value":""}],"variable":[]}},"response":[{"id":"3f78659e-597f-449f-a3aa-e0ed7bc1f43c","name":"View Fax Numbers","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic API_KEY","type":"text"}],"url":{"raw":"https://api.documo.com/v1/numbers","host":["https://api.documo.com"],"path":["v1","numbers"],"query":[{"key":"accountId","value":"","description":"String | Account ID","disabled":true},{"key":"type","value":"","description":"String | Possible values: available, assigned, pending","disabled":true},{"key":"offset","value":"","description":"Integer | Default: 0 | Number of results to skip (used for pagination)","disabled":true},{"key":"limit","value":"","description":"Integer | Default: 30 | Number of results to be returned (used for pagination)","disabled":true},{"key":"query","value":"","description":"String | Search query","disabled":true}]}},"code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"rows\": [\n {\n \"uuid\": \"04d651f6-5092-44a1-bbd4-822a0ab43d29\",\n \"number\": \"3144508380\",\n \"pendingUntil\": null,\n \"ownedBy\": \"8d3165b3-d23c-4cb4-9bee-b33013c008f7\",\n \"managedBy\": \"8d3165b3-d23c-4cb4-9bee-b33013c008f7\",\n \"faxbridge\": {\n \"deviceCode\": \"210000000000\",\n \"name\": \"FaxBridge\"\n },\n \"users\": [\n {\n \"userId\": \"fdb9f0dd-ac0c-4f3e-8e4b-1be0225186de\",\n \"accountId\": \"6c838c7c-cb48-4763-84d6-233b5f8cf782\",\n \"email\": \"example@mail.com\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"avatarUrl\": null\n }\n ],\n \"owner\": {\n \"uuid\": \"00000000-0000-0000-0000-000000000000\",\n \"accountNumber\": \"1200000000\",\n \"accountName\": \"Night’s Watch\",\n \"accountType\": \"customer\"\n },\n \"manager\": {\n \"uuid\": \"00000000-0000-0000-0000-000000000000\",\n \"accountNumber\": \"1200000000\",\n \"accountName\": \"Night’s Watch\",\n \"accountType\": \"customer\"\n },\n \"tags\": [\n {\n \"uuid\": \"57f2acd2-89d8-46af-af8b-83cad6fgh5564\",\n \"name\": \"Inbound Fax Tag\",\n \"color\": \"#F44336\",\n \"type\": \"fax\",\n \"isPublic\": true,\n \"createdBy\": \"666d7136-713f-41d1-888e-hfg463536744\",\n \"accountId\": \"efaa36f7-d9a0-493f-a3aa-765478hfgyej\",\n \"createdAt\": \"2024-06-25T15:38:54.000Z\",\n \"updatedAt\": \"2024-06-25T15:38:54.000Z\",\n \"created_by\": \"666d7136-713f-41d1-888e-jahdgf784652\",\n \"account_id\": \"efaa36f7-d9a0-493f-a3aa-hfg463564537\",\n \"FaxNumberTag\": {\n \"tagId\": \"57f2acd2-89d8-46af-af8b-83cad6f59e63\",\n \"numberId\": \"b3d0bffa-240c-49b5-b7cd-84758hfjghe\",\n \"type\": \"inbound\",\n \"createdAt\": \"2024-06-25T15:38:55.000Z\",\n \"number_id\": \"b3d0bffa-240c-49b5-b7cd-74657hghfj867\",\n \"numberUuid\": \"b3d0bffa-240c-49b5-b7cd-7567fhgjkleu\",\n \"tagUuid\": \"57f2acd2-89d8-46af-af8b-857890987hgfg\",\n \"tag_id\": \"57f2acd2-89d8-46af-af8b-j57hfjg89kj4\"\n }\n }\n ]\n }\n ],\n \"count\": 1718,\n \"limit\": 100,\n \"offset\": 0\n}"}],"_postman_id":"f9d04e39-efdf-4a0b-ad1d-15e7106a95f0"},{"name":"Add User to Fax Number","id":"9c4cca04-1767-46fe-9ad3-dda555a3aa40","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://api.documo.com/v1/numbers/:numberId/user/:userId","description":"Add users to fax numbers. Only users from account that manages this number can be assigned. Inbound faxes are accessible by the assigned user(s).
\nAPI Key Access: admin
String | Required | Number UUID
\n","type":"text/plain"},"type":"any","value":null,"key":"numberId"},{"description":{"content":"String | Required | User UUID
\n","type":"text/plain"},"type":"any","value":null,"key":"userId"}]}},"response":[{"id":"45ccf116-20ba-4226-9093-d624cc2514ad","name":"Add User to Fax Number","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Basic API_KEY","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"https://api.documo.com/v1/numbers/:numberId/user/:userId","host":["https://api.documo.com"],"path":["v1","numbers",":numberId","user",":userId"],"variable":[{"key":"numberId","value":"d1077489-5ea1-4db1-9760-853f175e8288","description":"String | Required | Number UUID"},{"key":"userId","value":"d1077489-5ea1-4db1-9760-853f175e8288","description":"String | Required | User UUID"}]}},"code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"uuid\": \"7cd0224e-ee05-4f32-9f56-9a4ebf83a38c\",\n \"number\": \"3122833994\",\n \"pendingUntil\": null,\n \"ownedBy\": \"6c838c7c-cb48-4763-84d6-233b5f8cf782\",\n \"createdAt\": \"2017-06-06T11:37:14.000Z\",\n \"users\": [\n {\n \"userId\": \"fdb9f0dd-ac0c-4f3e-8e4b-1be0225186de\",\n \"accountId\": \"6c838c7c-cb48-4763-84d6-233b5f8cf782\",\n \"email\": \"example@mail.com\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"avatarUrl\": null\n }\n ],\n \"manager\": {\n \"uuid\": \"00000000-0000-0000-0000-000000000000\",\n \"accountNumber\": \"1200000000\",\n \"accountName\": \"Night’s Watch\",\n \"accountType\": \"customer\"\n }\n}"}],"_postman_id":"9c4cca04-1767-46fe-9ad3-dda555a3aa40"},{"name":"Remove User from Fax Number","id":"4d2b3852-606d-405d-bb00-72634a618d3f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.documo.com/v1/numbers/:numberId/user/:userId","description":"Remove user from fax number.
\nAPI Key Access: admin
String | Required | Number UUID
\n","type":"text/plain"},"type":"any","value":null,"key":"numberId"},{"description":{"content":"String | Required | User UUID
\n","type":"text/plain"},"type":"any","value":null,"key":"userId"}]}},"response":[{"id":"f13d8687-5608-42f9-bd6c-279591a93f34","name":"Remove User from Fax Number","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Basic API_KEY","type":"text"}],"url":{"raw":"https://api.documo.com/v1/numbers/:numberId/user/:userId","host":["https://api.documo.com"],"path":["v1","numbers",":numberId","user",":userId"],"variable":[{"key":"numberId","value":"d1077489-5ea1-4db1-9760-853f175e8288","description":"String | Required | Number UUID"},{"key":"userId","value":"d1077489-5ea1-4db1-9760-853f175e8288","description":"String | Required | User UUID"}]}},"code":204,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"OK"}],"_postman_id":"4d2b3852-606d-405d-bb00-72634a618d3f"},{"name":"Fax Number Settings","id":"08bb7cd2-c18a-4578-8235-93116ae4831d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"storage","value":"","description":"String | FTP/SFTP storage credentials in JSON format
\n","type":"text","disabled":true},{"key":"managedBy","value":"","description":"Uuid | Uuid of manager account
\n","type":"text","disabled":true}]},"url":"https://api.documo.com/v1/numbers/:numberId","description":"Storage settings of number.
\nAPI Key Access: admin
String | Required | Number UUID
\n","type":"text/plain"},"type":"any","value":null,"key":"numberId"}]}},"response":[{"id":"36b5c3f5-f16e-48de-bdce-66fa221ada21","name":"Fax Number Settings","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"Basic API_KEY","type":"text"},{"key":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"storage","value":"example","description":"String | FTP/SFTP storage credentials in JSON format","type":"text","disabled":true},{"key":"managedBy","value":"d1077489-5ea1-4db1-9760-853f175e8288","description":"Uuid | Uuid of manager account","type":"text","disabled":true}]},"url":{"raw":"https://api.documo.com/v1/numbers/:numberId","host":["https://api.documo.com"],"path":["v1","numbers",":numberId"],"variable":[{"key":"numberId","value":"d1077489-5ea1-4db1-9760-853f175e8288","description":"String | Required | Number UUID"}]}},"code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"uuid\": \"7cd0224e-ee05-4f32-9f56-9a4ebf83a38c\",\n \"number\": \"3122833994\",\n \"pendingUntil\": null,\n \"storage\": \"{\\\"protocol\\\":\\\"ftp\\\",\\\"host\\\":\\\"example.com\\\",\\\"outputDirPath\\\":\\\"uploads/\\\",\\\"password\\\":\\\"password\\\",\\\"user\\\":\\\"user\\\",\\\"port\\\":21}\",\n \"ownedBy\": \"6c838c7c-cb48-4763-84d6-233b5f8cf782\",\n \"createdAt\": \"2017-06-06T11:37:14.000Z\",\n \"users\": [\n {\n \"userId\": \"fdb9f0dd-ac0c-4f3e-8e4b-1be0225186de\",\n \"accountId\": \"6c838c7c-cb48-4763-84d6-233b5f8cf782\",\n \"email\": \"example@mail.com\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"avatarUrl\": null\n }\n ],\n \"manager\": {\n \"uuid\":\"00000000-0000-0000-0000-000000000000\",\n \"accountNumber\":\"1200000000\",\n \"accountName\":\"Documo\",\n \"accountType\":\"customer\"\n }\n}"}],"_postman_id":"08bb7cd2-c18a-4578-8235-93116ae4831d"},{"name":"Delete Fax Number","id":"504ebe78-f9ac-4e73-9b8c-6d0d70460c50","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.documo.com/v1/numbers/:numberId/release","description":"Release fax number by number ID and move it to pending.
\nAPI Key Access: admin
String | Required | Number UUID
\n","type":"text/plain"},"type":"any","value":null,"key":"numberId"}]}},"response":[{"id":"c1b40bfa-3ba3-4e07-b5e4-fe50f7331938","name":"Delete Fax Number","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Basic API_KEY","type":"text"}],"url":{"raw":"https://api.documo.com/v1/numbers/:numberId/release","host":["https://api.documo.com"],"path":["v1","numbers",":numberId","release"],"variable":[{"key":"numberId","value":"d1077489-5ea1-4db1-9760-853f175e8288","description":"String | Required | Number UUID"}]}},"code":204,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"OK"}],"_postman_id":"504ebe78-f9ac-4e73-9b8c-6d0d70460c50"},{"name":"Validate Fax Number","id":"4a66c11a-ea33-405d-8961-da68c0eb2030","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.documo.com/v1/numbers/validate?number=&country=","description":"Indicates whether a number is valid.
\nAPI Key Access: base | admin | print_driver
String | Required | The number you wish to validate
\n","type":"text/plain"},"key":"number","value":""},{"description":{"content":"String | Required | The Alpha-2 country code
\n","type":"text/plain"},"key":"country","value":""}],"variable":[]}},"response":[{"id":"1f46496e-5532-4626-9dce-0fc11c99632e","name":"Validate Fax Number","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic API_KEY","type":"text"}],"url":{"raw":"https://api.documo.com/v1/numbers/validate?number=example&country=US","host":["https://api.documo.com"],"path":["v1","numbers","validate"],"query":[{"key":"number","value":"example","description":"String | Required | The number you wish to validate"},{"key":"country","value":"US","description":"String | Required | The Alpha-2 country code"}]}},"code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"isValid\": false\n}"}],"_postman_id":"4a66c11a-ea33-405d-8961-da68c0eb2030"}],"id":"476f7969-a924-4743-b77c-7b303729ec44","description":"Accessible by admin level users only.
\n","event":[{"listen":"prerequest","script":{"id":"691177d6-71c0-4a84-bf22-b65d5e308adc","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"0aac71bb-2304-4b08-b284-84e5f9af134b","type":"text/javascript","exec":[""]}}],"_postman_id":"476f7969-a924-4743-b77c-7b303729ec44","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"Please use Number porting v2 endpoints.
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"d5d3a280-00af-4155-902c-0b0a6be56957","type":"text/javascript","requests":{},"exec":[""]}},{"listen":"test","script":{"id":"b37c0a5c-30d0-4998-9213-e76c2720c7a2","type":"text/javascript","requests":{},"exec":[""]}}],"_postman_id":"bd371130-240a-4327-8435-10b995346cc0"},{"name":"Number Provisioning","item":[],"id":"ccb3c3dc-e48f-4413-b593-1ab6b2ec0274","description":"Please use Number provisioning v2 endpoints.
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"c369b679-8910-4e53-a4b9-8cbc13f9ed78","type":"text/javascript","packages":{},"requests":{},"exec":[""]}},{"listen":"test","script":{"id":"cf0a03eb-3f17-47de-80cf-09851db9c590","type":"text/javascript","packages":{},"requests":{},"exec":[""]}}],"_postman_id":"ccb3c3dc-e48f-4413-b593-1ab6b2ec0274"},{"name":"FaxBridges","item":[{"name":"View FaxBridges","id":"9ad45d09-f33c-4ed5-a0cb-09080fcd32f6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.documo.com/v1/faxbridges","description":"Get FaxBridges list owned by account.
\nAPI Key Access: admin
String | Account ID
\n","type":"text/plain"},"key":"accountId","value":""},{"disabled":true,"description":{"content":"String | Search Query
\n","type":"text/plain"},"key":"query","value":""},{"disabled":true,"description":{"content":"Integer | Default: 0 | Number of results to skip (used for pagination)
\n","type":"text/plain"},"key":"offset","value":""},{"disabled":true,"description":{"content":"Integer | Default: 30 | Number of results to be returned (used for pagination)
\n","type":"text/plain"},"key":"limit","value":""}],"variable":[]}},"response":[{"id":"e066a869-b043-4a19-b22c-62e8c604a701","name":"View FaxBridges","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic API_KEY","type":"text"}],"url":{"raw":"https://api.documo.com/v1/faxbridges","host":["https://api.documo.com"],"path":["v1","faxbridges"],"query":[{"key":"accountId","value":"","description":"String | Account ID","type":"text","disabled":true},{"key":"query","value":"","description":"String | Search Query","type":"text","disabled":true},{"key":"offset","value":"","description":"Integer | Default: 0 | Number of results to skip (used for pagination)","type":"text","disabled":true},{"key":"limit","value":"","description":"Integer | Default: 30 | Number of results to be returned (used for pagination)","type":"text","disabled":true}]}},"code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"rows\": [\n {\n \"deviceCode\": \"216061830920\",\n \"active\": false,\n \"name\":\"FaxBridge Name\",\n \"ownedBy\":\"00000000-0000-0000-0000-000000000000\",\n \"managedBy\":\"00000000-0000-0000-0000-000000000000\",\n \"faxNumberId\": \"e7c885cf-6045-43f4-8eb5-2d6c68071292\",\n \"faxCallerId\":\"5094570051\",\n \"ipAddressPublic\": \"68.104.9.224\",\n \"ipAddressPrivate\": \"192.168.0.4\",\n \"firmware\": \"20170702B\",\n \"macAddress\": \"D8FB11618309\",\n \"printIncomingFaxes\":true,\n \"timezone\": \"pacific\",\n \"orderId\": \"00000000-0000-0000-0000-000000000000\",\n \"billing\": \"classic\",\n \"purchasedAt\": \"2020-01-01T12:00:00.000Z\",\n \"eventDate\": \"2020-01-01T12:00:00.000Z\",\n \"activateDate\": \"2020-01-01T12:00:00.000Z\",\n \"createdAt\": \"2020-01-01T12:00:00.000Z\",\n \"updatedAt\": \"2020-01-01T12:00:00.000Z\",\n \"owner\":{\n \"uuid\": \"00000000-0000-0000-0000-000000000000\",\n \"accountNumber\": \"1200000000\",\n \"accountName\": \"Documo\",\n \"accountType\": \"customer\"\n },\n \"manager\":{\n \"uuid\": \"00000000-0000-0000-0000-000000000000\",\n \"accountNumber\": \"1200000000\",\n \"accountName\": \"Documo\",\n \"accountType\": \"customer\"\n },\n \"number\":{\n \"uuid\": \"00000000-0000-0000-0000-000000000000\",\n \"number\": \"4697292693\",\n \"pendingUntil\": null,\n \"ownedBy\": \"00000000-0000-0000-0000-000000000000\",\n \"createdAt\": \"2017-07-15T17:49:05.000Z\",\n },\n \"users\": [\n {\n \"userId\": \"00000000-0000-0000-0000-000000000000\",\n \"firstName\": \"John\",\n \"lastName\": \"Snow\",\n \"email\": \"john@snow.com\"\n },\n ...\n ],\n }\n ],\n \"query\": {\n \"offset\": 0,\n \"limit\": 20\n },\n}"}],"_postman_id":"9ad45d09-f33c-4ed5-a0cb-09080fcd32f6"},{"name":"View FaxBridge","id":"40a5fd67-a275-4a5c-81c2-dcb4822a70bd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.documo.com/v1/faxbridges/:deviceCode","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"String | 256 characters limit |Customize FaxBridge name
\n","type":"text","disabled":true},{"key":"active","value":"","description":"String | FaxBridge activation
\n","type":"text","disabled":true},{"key":"printIncomingFaxes","value":"","description":"Boolean | Print incoming faxes
\n","type":"text","disabled":true},{"key":"faxCallerId","value":"","description":"String | 10 characters limit | Fax Caller Id
\n","type":"text","disabled":true},{"key":"managedBy","value":"","description":"Uuid | Uuid of manager account
\n","type":"text","disabled":true},{"key":"faxNumberId","value":"","description":"Uuid | Uuid of number
\n","type":"text","disabled":true},{"key":"timezone","value":"","description":"String | Possible values: ‘pacific’, ‘mountain’, ‘arizona’, ‘central’, ‘eastern’, ‘alaska’, ‘hawaii’
\n","type":"text","disabled":true}]},"url":"https://api.documo.com/v1/faxbridges/:deviceCode","description":"API Key Access: admin
String | Required | Device Code
\n","type":"text/plain"},"type":"any","value":null,"key":"deviceCode"}]}},"response":[{"id":"a64c35fc-c21c-4c86-84d5-d6124bfd4c96","name":"Change Fax Bridge Settings","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"Basic API_KEY","type":"text"},{"key":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"name","value":"example","description":"String | 256 characters limit |Customize FaxBridge name","type":"text"},{"key":"active","value":"example","description":"String | FaxBridge activation","type":"text"},{"key":"printIncomingFaxes","value":"false","description":"Boolean | Print incoming faxes","type":"text"},{"key":"faxCallerId","value":"example","description":"String | 10 characters limit | Fax Caller Id","type":"text"},{"key":"managedBy","value":"d1077489-5ea1-4db1-9760-853f175e8288","description":"Uuid | Uuid of manager account","type":"text"},{"key":"faxNumberId","value":"d1077489-5ea1-4db1-9760-853f175e8288","description":"Uuid | Uuid of number","type":"text"},{"key":"timezone","value":"pacific","description":"String | Possible values: ‘pacific’, ‘mountain’, ‘arizona’, ‘central’, ‘eastern’, ‘alaska’, ‘hawaii’","type":"text"}]},"url":{"raw":"https://api.documo.com/v1/faxbridges/:deviceCode","host":["https://api.documo.com"],"path":["v1","faxbridges",":deviceCode"],"variable":[{"key":"deviceCode","value":"1","description":"String | Required | Device Code"}]}},"code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"deviceCode\": \"216061830920\",\n \"active\": false,\n \"name\":\"FaxBridge Name\",\n \"ownedBy\":\"00000000-0000-0000-0000-000000000000\",\n \"managedBy\":\"00000000-0000-0000-0000-000000000000\",\n \"faxNumberId\": \"00000000-0000-0000-0000-000000000000\",\n \"faxCallerId\":\"5094570051\",\n \"ipAddressPublic\": \"68.104.9.224\",\n \"ipAddressPrivate\": \"192.168.0.4\",\n \"firmware\": \"20170702B\",\n \"macAddress\": \"D8FB11618309\",\n \"printIncomingFaxes\":true,\n \"timezone\": \"pacific\",\n \"orderId\": \"00000000-0000-0000-0000-000000000000\",\n \"billing\": \"classic\",\n \"purchasedAt\": \"2020-01-01T12:00:00.000Z\",\n \"eventDate\": \"2020-01-01T12:00:00.000Z\",\n \"activateDate\": \"2020-01-01T12:00:00.000Z\",\n \"createdAt\": \"2020-01-01T12:00:00.000Z\",\n \"updatedAt\": \"2020-01-01T12:00:00.000Z\",\n \"owner\":{\n \"uuid\": \"00000000-0000-0000-0000-000000000000\",\n \"accountNumber\": \"1200000000\",\n \"accountName\": \"Documo\",\n \"accountType\": \"customer\"\n },\n \"manager\":{\n \"uuid\": \"00000000-0000-0000-0000-000000000000\",\n \"accountNumber\": \"1200000000\",\n \"accountName\": \"Documo\",\n \"accountType\": \"customer\"\n },\n \"number\":{\n \"uuid\": \"00000000-0000-0000-0000-000000000000\",\n \"number\": \"4697292693\",\n \"pendingUntil\": null,\n \"ownedBy\": \"00000000-0000-0000-0000-000000000000\",\n \"createdAt\": \"2017-07-15T17:49:05.000Z\",\n },\n \"users\": [\n {\n \"userId\": \"00000000-0000-0000-0000-000000000000\",\n \"firstName\": \"John\",\n \"lastName\": \"Snow\",\n \"email\": \"john@snow.com\"\n },\n ...\n ],\n}"}],"_postman_id":"96732767-3c91-4aa5-b5c0-5db723f19b3d"}],"id":"67c5ee37-badd-4460-9463-f4a967c23b7e","_postman_id":"67c5ee37-badd-4460-9463-f4a967c23b7e","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"String | Required | Folder name
\n","type":"text"},{"key":"sharedWithAccount","value":"","description":"Boolean | Setting this to ‘true’ will make this folder accessible by users across the account
\n","type":"text","disabled":true},{"key":"parentId","value":"","description":"Uuid | If you wish to create this folder within another folder, pass the UUID of the parent folder
\n","type":"text","disabled":true},{"key":"userId","value":"","description":"Uuid | UUID of the user who owns this folder
\n","type":"text","disabled":true}]},"url":"https://api.documo.com/folders","description":"Creates a folder.
\nAPI Key Access: base | admin
Get folder by ID.
\nAPI Key Access: base | admin | print_driver
String | Required | Folder UUID
\n","type":"text/plain"},"type":"any","value":null,"key":"folderId"}]}},"response":[{"id":"507999ef-824f-4900-a8e7-1117f62f1405","name":"Get Folder","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic API_KEY","type":"text"}],"url":{"raw":"https://api.documo.com/folders/:folderId/info","host":["https://api.documo.com"],"path":["folders",":folderId","info"],"variable":[{"key":"folderId","value":"d1077489-5ea1-4db1-9760-853f175e8288","description":"String | Required | Folder UUID"}]}},"code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"59"},{"key":"Date","value":"Tue, 01 Jun 2021 19:32:02 GMT"},{"key":"X-RateLimit-Reset","value":"1622575983"},{"key":"Access-Control-Expose-Headers","value":"Content-Disposition"},{"key":"X-Server-Version","value":"4.2.2"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1921"},{"key":"ETag","value":"W/\"781-86ybKVoB+bUKSoHigRuBx79U3aI\""},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"folder\": {\n \"uuid\": \"a781f1aa-9cea-42fc-b5a6-102254d03788\",\n \"name\": \"test\",\n \"accountId\": \"efaa36f7-d9a0-493f-a3aa-0cb1114eea0c\",\n \"createdBy\": \"c7ef70fc-7563-4b47-95bc-a951a636bb71\",\n \"parentId\": null,\n \"hierarchyLevel\": 1,\n \"sharedWithAccount\": false,\n \"createdAt\": \"2021-06-01T19:31:28.000Z\",\n \"updatedAt\": \"2021-06-01T19:31:28.000Z\",\n \"users\": [\n {\n \"avatarPath\": null,\n \"userId\": \"c7ef70fc-7563-4b47-95bc-a951a636bb71\",\n \"uuid\": \"c7ef70fc-7563-4b47-95bc-a951a636bb71\",\n \"email\": \"test@tester.com\",\n \"firstName\": \"Test\",\n \"lastName\": \"Tester\",\n \"accountId\": \"efaa36f7-d9a0-493f-a3aa-0cb1114eea0c\",\n \"avatar\": null,\n \"uf\": {\n \"folderId\": \"a781f1aa-9cea-42fc-b5a6-102254d03788\",\n \"userId\": \"c7ef70fc-7563-4b47-95bc-a951a636bb71\",\n \"isOwner\": true,\n \"access\": 2,\n \"createdAt\": \"2021-06-01T19:31:28.000Z\",\n }\n }\n ]\n },\n \"path\": [\n {\n \"uuid\": \"a781f1aa-9cea-42fc-b5a6-102254d03788\",\n \"name\": \"test\",\n \"accountId\": \"efaa36f7-d9a0-493f-a3aa-0cb1114eea0c\",\n \"createdBy\": \"c7ef70fc-7563-4b47-95bc-a951a636bb71\",\n \"parentId\": null,\n \"hierarchyLevel\": 1,\n \"sharedWithAccount\": false,\n \"createdAt\": \"2021-06-01T19:31:28.000Z\",\n \"updatedAt\": \"2021-06-01T19:31:28.000Z\",\n \"users\": [\n {\n \"avatarPath\": null,\n \"userId\": \"c7ef70fc-7563-4b47-95bc-a951a636bb71\",\n \"uuid\": \"c7ef70fc-7563-4b47-95bc-a951a636bb71\",\n \"email\": \"test@tester.com\",\n \"firstName\": \"Test\",\n \"lastName\": \"Tester\",\n \"accountId\": \"efaa36f7-d9a0-493f-a3aa-0cb1114eea0c\",\n \"avatar\": null,\n \"uf\": {\n \"folderId\": \"a781f1aa-9cea-42fc-b5a6-102254d03788\",\n \"userId\": \"c7ef70fc-7563-4b47-95bc-a951a636bb71\",\n \"isOwner\": true,\n \"access\": 2,\n \"createdAt\": \"2021-06-01T19:31:28.000Z\",\n }\n }\n ]\n }\n ]\n}"}],"_postman_id":"2288a6ff-f3ed-4289-a8e5-0576c1d62fbf"},{"name":"Upload File","id":"ff65d976-0525-4a08-80d2-050354ce7927","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"files","description":"Blob | Required
\n","type":"file","value":null},{"key":"isPublic","value":"","description":"Boolean | Makes file accessible by direct link stored in publicHref
\n","type":"text","disabled":true},{"key":"sharedWithAccount","value":"","description":"Boolean | Setting this to ‘true’ will make this file accessible by users across the account
\n","type":"text","disabled":true},{"key":"folderId","value":"","description":"Uuid | UUID of the folder where the file will reside
\n","type":"text","disabled":true},{"key":"userId","value":"","description":"Uuid | UUID of the user who owns this folder
\n","type":"text","disabled":true}]},"url":"https://api.documo.com/files","description":"API Key Access: base | admin