{"info":{"_postman_id":"2bd20c8f-e97b-4afa-9a5b-de33b28d794b","name":"Documo - Fax API - User access only","description":"

Introduction

Getting Started

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.

Enabling API access

To begin using the Documo API, you will need to enable the API and generate an API key. This can be done in the Admin console in Account Settings: API. Visual instructions here

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Introduction","slug":"introduction"}],"owner":"3967924","collectionId":"2bd20c8f-e97b-4afa-9a5b-de33b28d794b","publishedId":"RW1hhvSU","public":true,"customColor":null,"publishDate":"2018-05-09T08:59:25.000Z"},"item":[{"name":"me","item":[{"name":"Get current user","id":"b1ac3cb7-33eb-4903-ab6a-b86e73a17fa9","request":{"method":"GET","header":[],"url":"https://api.documo.com/v1/me","description":"

Returns current logged in user with fax numbers and account

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{API_KEY}}"}]},"isInherited":true,"source":{"_postman_id":"2bd20c8f-e97b-4afa-9a5b-de33b28d794b","id":"2bd20c8f-e97b-4afa-9a5b-de33b28d794b","name":"Documo - Fax API - User access only","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","me"],"host":["api","documo","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"b1ac3cb7-33eb-4903-ab6a-b86e73a17fa9"}],"id":"cf8c9747-9584-40de-9b12-a719a4761d39","_postman_id":"cf8c9747-9584-40de-9b12-a719a4761d39","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{API_KEY}}"}]},"isInherited":true,"source":{"_postman_id":"2bd20c8f-e97b-4afa-9a5b-de33b28d794b","id":"2bd20c8f-e97b-4afa-9a5b-de33b28d794b","name":"Documo - Fax API - User access only","type":"collection"}}},{"name":"contacts","item":[{"name":"Get contact","id":"20614ebd-7109-4b70-90cc-aa8eecbb9edb","request":{"method":"GET","header":[],"url":"https://api.documo.com/v1/contacts?userId={{userId}}&limit={{limit}}&offset={{offset}}&order={{order}}&query={{query}}","description":"

Returns contact list

User ID. If not specified - returns results for current user

\n","type":"text/plain"},"key":"userId","value":"{{userId}}"},{"description":{"content":"

Amount of line items per page that will be returned

\n","type":"text/plain"},"key":"limit","value":"{{limit}}"},{"description":{"content":"

Number of pages to return

\n","type":"text/plain"},"key":"offset","value":"{{offset}}"},{"description":{"content":"

Order results. Ordered by name in ascending order, default value is name asc

\n","type":"text/plain"},"key":"order","value":"{{order}}"},{"description":{"content":"

Search by contact name, fax number, phone number or email

\n","type":"text/plain"},"key":"query","value":"{{query}}"}],"variable":[]}},"response":[],"_postman_id":"20614ebd-7109-4b70-90cc-aa8eecbb9edb"},{"name":"Create contact","id":"23d4145a-1f59-45ce-8029-8f11dbb1037b","request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"phoneNumber","value":"{{phoneNumber}}","type":"text","description":"

Phone number in format (***) -*

\n"},{"key":"faxNumber","value":"{{faxNumber}}","type":"text","description":"

Fax number in format (***) -*. Required for sending fax using contact

\n"},{"key":"name","value":"{{name}}","type":"text","description":"

Contact name

\n"},{"key":"email","value":"{{email}}","type":"text","description":"

Contact email

\n"},{"key":"isPublic","value":"{{isPublic}}","type":"text","description":"

Contact will be shown for all users in the account

\n"},{"key":"publicEditable","value":"{{publicEditable}}","type":"text","description":"

All account users will be able to edit contact if value is true

\n"},{"key":"organizationId","value":"{{organizationId}}","type":"text","description":"

Assign contact to existing organization contact

\n"},{"key":"isOrganization","value":"{{isOrganization}}","type":"text","description":"

If true - organization will be created

\n"}]},"url":"https://api.documo.com/v1/contacts?userId={{userId}}","description":"

Creates a contact

User ID. If not specified - creates contact for current user

\n","type":"text/plain"},"key":"userId","value":"{{userId}}"}],"variable":[]}},"response":[],"_postman_id":"23d4145a-1f59-45ce-8029-8f11dbb1037b"},{"name":"Update contact","id":"845e3924-5fe1-4424-a811-dbf230e55dda","request":{"method":"PATCH","header":[],"body":{"mode":"formdata","formdata":[{"key":"phoneNumber","value":"{{phoneNumber}}","type":"text","description":"

Phone number in format (***) -*

\n"},{"key":"faxNumber","value":"{{faxNumber}}","type":"text","description":"

Fax number in format (***) -*. Required for sending fax using contact

\n"},{"key":"name","value":"{{name}}","type":"text","description":"

Contact name

\n"},{"key":"email","value":"{{email}}","type":"text","description":"

Contact email

\n"},{"key":"isPublic","value":"{{isPublic}}","type":"text","description":"

Contact will be shown for all users in the account

\n"},{"key":"publicEditable","value":"{{publicEditable}}","type":"text","description":"

All account users will be able to edit contact if value is true

\n"},{"key":"organizationId","value":"{{organizationId}}","type":"text","description":"

Assign contact to existing organization contact

\n"}]},"url":"https://api.documo.com/v1/contacts/:contactId","description":"

Creates a contact

Contact ID

\n","type":"text/plain"},"type":"any","value":"{{contactId}}","key":"contactId"}]}},"response":[],"_postman_id":"845e3924-5fe1-4424-a811-dbf230e55dda"},{"name":"Bulk delete contacts","id":"2b220fca-21b4-463f-8697-f1164db82591","request":{"method":"DELETE","header":[],"url":"https://api.documo.com/v1/contacts/bulk?contactsIds={{contactsIds}}","description":"

Deletes contacts bulk

Contact IDs

\n","type":"text/plain"},"key":"contactsIds","value":"{{contactsIds}}"}],"variable":[]}},"response":[],"_postman_id":"2b220fca-21b4-463f-8697-f1164db82591"},{"name":"Delete contact","id":"7828be94-5580-4770-8f47-060bde3c831a","request":{"method":"DELETE","header":[],"url":"https://api.documo.com/v1/contacts/:contactId","description":"

Deletes contact

Contact ID

\n","type":"text/plain"},"type":"any","value":"{{contactId}}","key":"contactId"}]}},"response":[],"_postman_id":"7828be94-5580-4770-8f47-060bde3c831a"}],"id":"dea6ab82-56a5-4fdb-8658-dc14febdf2dc","_postman_id":"dea6ab82-56a5-4fdb-8658-dc14febdf2dc","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{API_KEY}}"}]},"isInherited":true,"source":{"_postman_id":"2bd20c8f-e97b-4afa-9a5b-de33b28d794b","id":"2bd20c8f-e97b-4afa-9a5b-de33b28d794b","name":"Documo - Fax API - User access only","type":"collection"}}},{"name":"fax","item":[{"name":"Fax send","id":"85f38f27-754f-444a-a9cc-4caca6a64571","request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"recipientFax","value":"{{recipientFax}}","type":"text","description":"

Destination phone number. Country code must be included (ex. 18885551234). Multiple destinations separated by comma.

\n"},{"key":"recipientContacts","value":"{{recipientContacts}}","type":"text","description":"

Contact IDs separated by comma

\n"},{"key":"coverPage","value":"{{coverPage}}","type":"text","description":"

Defaults to false. Indicating true will include system cover page. If coverPage is added, this removes file requirement.

\n"},{"key":"recipientName","value":"{{recipientName}}","type":"text","description":"

Will populate in TO field of cover page

\n"},{"key":"subject","value":"{{subject}}","type":"text","description":"

Will populate Subject field of cover page

\n"},{"key":"notes","value":"{{notes}}","type":"text","description":"

Will populate Notes field of cover page

\n"},{"key":"callerId","value":"{{callerId}}","type":"text","description":"

Phone number. Defaults to user setting if not included in call.

\n"},{"key":"coverPageId","value":"{{coverPageId}}","type":"text","description":"

Coverpage ID

\n"},{"key":"tags","value":"{{tags}}","type":"text","description":"

Comma separated tag IDs list

\n"},{"key":"file","value":null,"description":"

File(s) you wish to fax. Add files to the stream in order they should be rendered. At least 1 file is required if coverPage parameter is not added.

\n","type":"file"}]},"url":"https://api.documo.com/v1/fax/send","description":"

Sends a fax

Unique message identifier provided by Documo

\n"},{"key":"recipientFax","value":"{{recipientFax}}","type":"text","description":"

Use this parameter to change destination phone number.

\n"}]},"url":"https://api.documo.com/v1/fax/resend","description":"

Resend fax

Returns fax

Unique message identifier provided by Documo

\n","type":"text/plain"},"type":"any","value":"{{messageId}}","key":"messageId"}]}},"response":[],"_postman_id":"188dbb87-dbd7-4c59-aefe-e6a520ee669e"},{"name":"Get fax history","id":"48004df2-09a0-4ac4-a13c-f4aaf62b01a2","request":{"method":"GET","header":[],"url":"https://api.documo.com/v1/fax/history?offset=0&limit=20&direction=all&status=all&fromDate={{fromDate}}&toDate={{toDate}}&accountId={{accountId}}&userId={{userId}}&query={{query}}&tags={{tags}}&archived={{archived}}&include={{include}}","description":"

Returns fax list of current user

Number of pages to return

\n","type":"text/plain"},"key":"offset","value":"0"},{"description":{"content":"

Amount of line items per page that will be returned

\n","type":"text/plain"},"key":"limit","value":"20"},{"description":{"content":"

Filters results by direction. Can indicate all (default), inbound or outbound

\n","type":"text/plain"},"key":"direction","value":"all"},{"description":{"content":"

Filters results by status. Can indicate all (default), failed, success, or processing

\n","type":"text/plain"},"key":"status","value":"all"},{"description":{"content":"

Filters results from starting date. (ex. 2012-04-23T18:25:43.511Z)

\n","type":"text/plain"},"key":"fromDate","value":"{{fromDate}}"},{"description":{"content":"

Filters results up to end date. (ex. 2012-04-23T18:25:43.511Z)

\n","type":"text/plain"},"key":"toDate","value":"{{toDate}}"},{"description":{"content":"

Filters results by Account ID

\n","type":"text/plain"},"key":"accountId","value":"{{accountId}}"},{"description":{"content":"

Filters results by User ID

\n","type":"text/plain"},"key":"userId","value":"{{userId}}"},{"description":{"content":"

Search by CSID, Caller ID, fax number and message id.

\n","type":"text/plain"},"key":"query","value":"{{query}}"},{"description":{"content":"

Filters by comma separated tags list

\n","type":"text/plain"},"key":"tags","value":"{{tags}}"},{"description":{"content":"

Filters by archived faxes if true

\n","type":"text/plain"},"key":"archived","value":"{{archived}}"},{"description":{"content":"

Include assigned contacts or tags. Example: tags,contacts

\n","type":"text/plain"},"key":"include","value":"{{include}}"}],"variable":[]}},"response":[],"_postman_id":"48004df2-09a0-4ac4-a13c-f4aaf62b01a2"},{"name":"Download fax","id":"b7b5735f-e0e0-409d-b95e-ca0e3814f920","request":{"method":"GET","header":[],"url":"https://api.documo.com/v1/fax/download?messageId={{messageId}}&extension={{extension}}","description":"

Download fax files

Unique message identifier provided by Documo

\n","type":"text/plain"},"key":"messageId","value":"{{messageId}}"},{"description":{"content":"

File extension. Default is pdf, tiff is also available

\n","type":"text/plain"},"key":"extension","value":"{{extension}}"}],"variable":[]}},"response":[],"_postman_id":"b7b5735f-e0e0-409d-b95e-ca0e3814f920"},{"name":"Delete fax","id":"3d502724-9247-4cf3-947e-558d4816352a","request":{"method":"DELETE","header":[],"url":"https://api.documo.com/v1/fax/:messageId","description":"

Removes fax

Unique message identifier provided by Documo

\n","type":"text/plain"},"type":"any","value":"{{messageId}}","key":"messageId"}]}},"response":[],"_postman_id":"3d502724-9247-4cf3-947e-558d4816352a"}],"id":"adcfbf81-8a22-4451-b987-e70eb0982a90","_postman_id":"adcfbf81-8a22-4451-b987-e70eb0982a90","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{API_KEY}}"}]},"isInherited":true,"source":{"_postman_id":"2bd20c8f-e97b-4afa-9a5b-de33b28d794b","id":"2bd20c8f-e97b-4afa-9a5b-de33b28d794b","name":"Documo - Fax API - User access only","type":"collection"}}},{"name":"tags","item":[{"name":"Get tags","id":"79a523e6-7299-4af5-9e3e-940493ebc4a7","request":{"method":"GET","header":[],"url":"https://api.documo.com/v1/tags","description":"

get current user tags list

Get all tags of fax

Fax Message ID

\n","type":"text/plain"},"type":"any","value":"{{messageId}}","key":"messageId"}]}},"response":[],"_postman_id":"f422188d-5c21-4e52-8b49-3f321a4ebaad"},{"name":"Create tag","id":"06fd2f7a-feb6-42a5-8632-207d60b1ca5e","request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"name","value":"{{name}}","type":"text","description":"

Tag name

\n"},{"key":"color","value":"{{color}}","type":"text","description":"

Tag color hex

\n"},{"key":"isPublic","value":"false","type":"text","description":"

Tag will be shown for all users in the account

\n"}]},"url":"https://api.documo.com/v1/tag","description":"

create a tag

Tag ID

\n"}]},"url":"https://api.documo.com/v1/fax/:messageId/tag","description":"

add a tag to a fax

Fax Message ID

\n","type":"text/plain"},"type":"any","value":"{{messageId}}","key":"messageId"}]}},"response":[],"_postman_id":"326ff532-a16b-41e6-86e9-3d7db07cb15d"},{"name":"Delete fax tag","id":"ee8eb95b-ef59-4e01-9191-edfe3c154da3","request":{"method":"DELETE","header":[],"url":"https://api.documo.com/v1/fax/:messageId/tag/:tagId","description":"

delete tag

Fax Message ID

\n","type":"text/plain"},"type":"any","value":"{{messageId}}","key":"messageId"},{"description":{"content":"

Tag ID

\n","type":"text/plain"},"type":"any","value":"{{tagId}}","key":"tagId"}]}},"response":[],"_postman_id":"ee8eb95b-ef59-4e01-9191-edfe3c154da3"},{"name":"Delete tag","id":"e8f261e4-0228-4bf3-a4c5-c9532a092109","request":{"method":"DELETE","header":[],"url":"https://api.documo.com/v1/tag/:tagId","description":"

delete a tag

Tag ID

\n","type":"text/plain"},"type":"any","value":"{{tagId}}","key":"tagId"}]}},"response":[],"_postman_id":"e8f261e4-0228-4bf3-a4c5-c9532a092109"}],"id":"fcb0bc23-56e1-4acc-a518-c51d5c582df1","_postman_id":"fcb0bc23-56e1-4acc-a518-c51d5c582df1","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{API_KEY}}"}]},"isInherited":true,"source":{"_postman_id":"2bd20c8f-e97b-4afa-9a5b-de33b28d794b","id":"2bd20c8f-e97b-4afa-9a5b-de33b28d794b","name":"Documo - Fax API - User access only","type":"collection"}}},{"name":"settings","item":[{"name":"Update user","id":"f4e4ac14-4791-43f0-9775-7930de3ad8a6","request":{"method":"PATCH","header":[],"body":{"mode":"formdata","formdata":[{"key":"firstName","value":"{{firstName}}","type":"text","description":"

First name on the card

\n"},{"key":"lastName","value":"{{lastName}}","type":"text","description":"

Last name on the card

\n"},{"key":"userRole","value":"{{userRole}}","type":"text","description":"

User role

\n"},{"key":"phone","value":"{{phone}}","type":"text","description":"

User phone

\n"},{"key":"faxCallerId","value":"{{phone}}","type":"text","description":"

ID of fax caller

\n"},{"key":"faxCsid","value":"{{faxCsid}}","type":"text","description":"

Unique fax ID

\n"},{"key":"emailNotifySendOption","value":"all","type":"text","description":"

Outbound fax notification settings. Acceptable values: None, All (default), Success, Failure

\n"},{"key":"emailNotifyReceiveOption","value":"all","type":"text","description":"

Inbound fax notification settings. Acceptable values: None, All (default), Success, Failure

\n"},{"key":"emailNotifySendIncAttachment","value":true,"type":"text","description":"

Outbound fax notification attachment settings. Acceptable values: true (default), false

\n"},{"key":"emailNotifyReceiveIncAttachment","value":true,"type":"text","description":"

Inbound fax notification attachment settings. Acceptable values: true (default), false

\n"},{"key":"emailToFaxCoverPageOption","value":true,"type":"text","description":"

Email to Fax cover page option

\n"},{"key":"faxExtension","value":"{{faxExtension}}","type":"text","description":"

Extension '.pdf' or '.tiff'

\n"},{"key":"webhookUrl","value":"{{webhookUrl}}","description":"

POST request to webhookUrl when received income fax. URL should start with http:// or https://

\n","type":"text"}]},"url":"https://api.documo.com/v1/users/:userId","description":"

Updates user data by user's userId

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{API_KEY}}"}]},"isInherited":true,"source":{"_postman_id":"2bd20c8f-e97b-4afa-9a5b-de33b28d794b","id":"2bd20c8f-e97b-4afa-9a5b-de33b28d794b","name":"Documo - Fax API - User access only","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","users",":userId"],"host":["api","documo","com"],"query":[],"variable":[{"type":"any","value":"{{userId}}","key":"userId"}]}},"response":[],"_postman_id":"f4e4ac14-4791-43f0-9775-7930de3ad8a6"}],"id":"49c179b2-775f-4c5e-9715-39698b9831fa","_postman_id":"49c179b2-775f-4c5e-9715-39698b9831fa","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{API_KEY}}"}]},"isInherited":true,"source":{"_postman_id":"2bd20c8f-e97b-4afa-9a5b-de33b28d794b","id":"2bd20c8f-e97b-4afa-9a5b-de33b28d794b","name":"Documo - Fax API - User access only","type":"collection"}}}],"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{API_KEY}}"}]}},"event":[{"listen":"prerequest","script":{"id":"556c597b-05c5-4004-b42c-ea9fa61d9aee","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"29178d7c-9f96-4571-a2b5-04f022e1ca52","type":"text/javascript","exec":[""]}}]}