{"info":{"_postman_id":"8401a20c-5abe-4aa8-a9c0-7821321ec306","name":"Public API","description":"

Introduction

Welcome to Documint's official API!

\n\n\n\n\n

Rate limit

There are currently no rate limits however this will change once we move out of Beta.

Authorization

Documint uses API Keys in request headers to authenticate the request. Set the header key to api_key and value should be a valid API Key. You can create an API key by following the instructions in the documentation.

Add API Key to the header of each request:

\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Value
`api_key`	`f5b52c86-ef2b-4d8f-8881-b3b0d13fee14`

Query Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Description	URI	Default	Example
Page	Page number of results to return	`page=<value>`	`1`	`{url}?page=1`
Limit	Limit the number of records that are returned. Max = 200	`limit=<value>`	`100`	`{url}?limit=10`
Sort	Sort results of a list. (see Sorting section)	`sort=<field>`	none	`{url}?sort=createdAt`
Filter	Filter the records returned in results	`<operator>=<value>`	none	`{url}?name=/.test./ig`
Select	Comma separated list of fields to returned in each result. Use `-` to specifically exclude fields.	`select=<value>`	none	`{url}?select=name,description`

Filtering

Filter records using the following operators:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	URI	Example
Equals	`key=val`	`{url}?type=public`
Greater than	`key>val`	`{url}?count>5`
Greater than or equal to	`key>=val`	`{url}?rating>=9.5`
Less than	`key<val`	`{url}?createdAt<2016-01-01`
Less than or equal to	`key<=val`	`{url}?score<=-5`
Not equal to	`key!=val`	`{url}?status!=success`
Is in	`key=val1,val2`	`{url}?country=GB,US`
Is not in	`key!=val1,val2`	`{url}?lang!=fr,en`
Has field	`key`	`{url}?phone`
Does not have field	`!key`	`{url}?!email`
Regex	`key=/value/<opts>`	`{url}?email=/@gmail\\.com$/i`

Sorting

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	URI	Example
Ascending	`sort=field`	`{url}?sort=createdAt`
Descending	`sort=-field`	`{url}?sort=-createdAt`
Multiple	`sort=field,-field`	`{url}?sort=name,-createdAt`

","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Rate limit","slug":"rate-limit"},{"content":"Authorization","slug":"authorization"},{"content":"Query Parameters","slug":"query-parameters"}],"owner":"11741160","collectionId":"8401a20c-5abe-4aa8-a9c0-7821321ec306","publishedId":"TVK5cLxQ","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"009BFF"},"publishDate":"2023-07-09T22:48:58.000Z"},"item":[{"name":"Templates","item":[{"name":"Get a Template","id":"2378443f-b9cd-47c2-aae8-e938d2ec6445","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.documint.me/1/templates/:id?select","description":"

Get a single template by its Id

Get a list of your templates

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"api_key"},{"key":"value","value":"f5b52c86-ef2b-4d8f-8881-b3b0d13fee14"}]},"isInherited":true,"source":{"_postman_id":"8401a20c-5abe-4aa8-a9c0-7821321ec306","id":"8401a20c-5abe-4aa8-a9c0-7821321ec306","name":"Public API","type":"collection"}},"urlObject":{"path":["templates"],"host":["https://api.documint.me/1"],"query":[{"disabled":true,"key":"limit","value":"1"},{"disabled":true,"key":"select","value":"name, createdAt"}],"variable":[]}},"response":[{"id":"6356d7ea-d951-4ed0-a385-45694a3b737a","name":"List Templates Query","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.documint.me/1/templates?limit=5&select=name, createdAt","host":["https://api.documint.me/1"],"path":["templates"],"query":[{"key":"limit","value":"5"},{"key":"select","value":"name, createdAt"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"result\": [\n {\n \"id\": \"5f789476141dad16bc847bef\",\n \"name\": \"Sales Contract\",\n \"createdAt\": \"2020-10-03T15:10:46.252Z\"\n },\n {\n \"id\": \"5f860e9d38f0eb0017f70ba0\",\n \"name\": \"Sales Invoice\",\n \"createdAt\": \"2020-10-13T20:31:25.415Z\"\n },\n {\n \"id\": \"5f861bf738f0eb0017f70ba1\",\n \"name\": \"Bill of Lading\",\n \"createdAt\": \"2020-10-13T21:28:23.649Z\"\n },\n {\n \"id\": \"5f861edd38f0eb0017f70ba2\",\n \"name\": \"Quote\",\n \"createdAt\": \"2020-10-13T21:40:45.104Z\"\n },\n {\n \"id\": \"5f8a0ccd5d14ff074c39c7e0\",\n \"name\": \"Rental Agreement\",\n \"createdAt\": \"2020-10-16T21:12:45.520Z\"\n }\n ]\n}"}],"_postman_id":"0c2d2c5b-505c-4d70-bb95-767369a0bcc9"},{"name":"Update a Template","id":"a6574a19-00d2-4674-ad5d-96714dee33cd","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{}},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"name\":\"Updated Template\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.documint.me/1/templates/:id","description":"

Update single template

Permanently delete a single template. If you want to deactivate or trash a template, update the isActve or isTrashed properties respectively

Merge a data into a template to create a document

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"api_key"},{"key":"value","value":"f5b52c86-ef2b-4d8f-8881-b3b0d13fee14"}]},"isInherited":true,"source":{"_postman_id":"8401a20c-5abe-4aa8-a9c0-7821321ec306","id":"8401a20c-5abe-4aa8-a9c0-7821321ec306","name":"Public API","type":"collection"}},"urlObject":{"path":["templates",":id","content"],"host":["https://api.documint.me/1"],"query":[{"disabled":true,"key":"ignore_fields","value":""},{"disabled":true,"key":"watch_fields","value":null},{"key":"preview","value":"true"},{"key":"active","value":"true"}],"variable":[{"type":"any","value":null,"key":"id"}]}},"response":[{"id":"0d080cb0-aeaa-4e36-80f1-4ee028106a6a","name":"Merge Document","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"https://api.documint.me/1/templates/:id/content","host":["https://api.documint.me/1"],"path":["templates",":id","content"],"variable":[{"key":"id","value":"{{template_id}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"description":{"content":"","type":"text/plain"},"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"url\": \"https://s3.amazonaws.com/documint.dev/5f6520ccb21e0c6804cd4eaa/documents/new-template-576asd8a9-asd3-45f6-99c7-9112dd07a037.pdf\",\n \"name\": \"new-template-5760e8a9-e273-45f6-99c7-9112dd07a037\",\n \"fileExtension\": \"pdf\",\n \"timestamp\": 1606340440318,\n \"templateName\": \"New Template\",\n \"templateId\": \"5f861bf738f0eb0017f70ba1\"\n}"}],"_postman_id":"032798a4-6eb6-43cd-9c1b-9ba313f7d39c"}],"id":"ef7c8769-aeca-40b8-9bde-8247278a8276","_postman_id":"ef7c8769-aeca-40b8-9bde-8247278a8276","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"api_key"},{"key":"value","value":"f5b52c86-ef2b-4d8f-8881-b3b0d13fee14"}]},"isInherited":true,"source":{"_postman_id":"8401a20c-5abe-4aa8-a9c0-7821321ec306","id":"8401a20c-5abe-4aa8-a9c0-7821321ec306","name":"Public API","type":"collection"}}}],"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"api_key"},{"key":"value","value":"f5b52c86-ef2b-4d8f-8881-b3b0d13fee14"}]}},"event":[{"listen":"prerequest","script":{"id":"12249362-c840-45d5-8def-07c75b59879f","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"bf695d8f-1914-40c8-8c77-dd6462565669","type":"text/javascript","exec":[""]}}],"variable":[{"key":"base_url","value":"https://api.documint.me/1"},{"key":"reset_token","value":"9df041507c3639bc6c75cd5038d8fa94105ae06c"},{"key":"api_key","value":"f5b52c86-ef2b-4d8f-8881-b3b0d13fee14","type":"string"}]}