{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"8401a20c-5abe-4aa8-a9c0-7821321ec306","name":"Public API","description":"## Introduction\n\nWelcome to Documint's official API!\n\n<!--\n# Overview\nThings that the developers should know about\n-->\n\n<!-- # Error Codes\nWhat errors and status codes can a user expect? -->\n\n# Rate limit\n\nThere are currently no rate limits however this will change once we move out of Beta.\n\n# Authorization\n\nDocumint 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](https://support.documint.me/integrations/create-api-key) by following the instructions in the documentation.\n\nAdd API Key to the header of each request:\n\n| Key       | Value         |\n| --------- | ------------- |\n| `api_key` | `{{api_key}}` |\n\n# Query Parameters\n\n| Name   | Description                                                                                        | URI                  | Default | Example                         |\n| ------ | -------------------------------------------------------------------------------------------------- | -------------------- | ------- | ------------------------------- |\n| Page   | Page number of results to return                                                                   | `page=<value>`       | `1`     | `{url}?page=1`                  |\n| Limit  | Limit the number of records that are returned. Max = 200                                           | `limit=<value>`      | `100`   | `{url}?limit=10`                |\n| Sort   | Sort results of a list. (see Sorting section)                                                      | `sort=<field>`       | none    | `{url}?sort=createdAt`          |\n| Filter | Filter the records returned in results                                                             | `<operator>=<value>` | none    | `{url}?name=/.*test.*/ig`       |\n| Select | Comma separated list of fields to returned in each result. Use `-` to specifically exclude fields. | `select=<value>`     | none    | `{url}?select=name,description` |\n\n## Filtering\n\nFilter records using the following operators:\n\n| Name                     | URI                 | Example                       |\n| ------------------------ | ------------------- | ----------------------------- |\n| Equals                   | `key=val`           | `{url}?type=public`           |\n| Greater than             | `key>val`           | `{url}?count>5`               |\n| Greater than or equal to | `key>=val`          | `{url}?rating>=9.5`           |\n| Less than                | `key<val`           | `{url}?createdAt<2016-01-01`  |\n| Less than or equal to    | `key<=val`          | `{url}?score<=-5`             |\n| Not equal to             | `key!=val`          | `{url}?status!=success`       |\n| Is in                    | `key=val1,val2`     | `{url}?country=GB,US`         |\n| Is not in                | `key!=val1,val2`    | `{url}?lang!=fr,en`           |\n| Has field                | `key`               | `{url}?phone`                 |\n| Does not have field      | `!key`              | `{url}?!email`                |\n| Regex                    | `key=/value/<opts>` | `{url}?email=/@gmail\\.com$/i` |\n\n## Sorting\n\n| Name       | URI                 | Example                      |\n| ---------- | ------------------- | ---------------------------- |\n| Ascending  | `sort=field`        | `{url}?sort=createdAt`       |\n| Descending | `sort=-field`       | `{url}?sort=-createdAt`      |\n| Multiple   | `sort=field,-field` | `{url}?sort=name,-createdAt` |","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"11741160","team":1255695,"collectionId":"8401a20c-5abe-4aa8-a9c0-7821321ec306","publishedId":"TVK5cLxQ","public":true,"publicUrl":"https://documenter-api.postman.tech/view/11741160/TVK5cLxQ","privateUrl":"https://go.postman.co/documentation/11741160-8401a20c-5abe-4aa8-a9c0-7821321ec306","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"009BFF"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"009BFF"}}]}},"version":"8.10.1","publishDate":"2023-07-09T22:48:58.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/8e4aa1e69c55bf71de492a51a36ee09bf196c4659e8097455b07ff26952b10a3","favicon":"https://res.cloudinary.com/postman/image/upload/v1688941614/team/yegnsfwzqe80inqtyeet.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/TVK5cLxQ"}