{"info":{"_postman_id":"21a85f2d-de6e-4e68-b8bd-86a7e8450372","name":"Avokaado Partner API","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"description":"","owner":"19228237","collectionId":"21a85f2d-de6e-4e68-b8bd-86a7e8450372","publishedId":"UVsTpgv4","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"2ebd59"},"publishDate":"2022-03-24T07:41:42.000Z"},"item":[{"name":"v4","item":[{"name":"Get contract templates","id":"b0abb2ef-81d2-45e8-aa78-ac5a52df11c7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","description":"

API key

\n","type":"text"}],"url":"/api/v4/contract-templates?status=published","description":"

This method allows to get the complete list of available templates through the API.

For each available template, the id, title and status are retrieved.

[Optional] Status of the template. Possible values: draft, published

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

[Optional] Category of the template (check admin)

\n","type":"text/plain"},"key":"category","value":""},{"disabled":true,"description":{"content":"

[Optional] Jurisdiction of the template

\n","type":"text/plain"},"key":"jurisdiction","value":"universal"},{"disabled":true,"description":{"content":"

[Optional] Locale of the template

\n","type":"text/plain"},"key":"locale","value":"en"}],"variable":[]}},"response":[{"id":"2236e4e1-7801-4aa3-9173-c11333c9603b","name":"Get contract templates","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","description":"API key","type":"text"}],"url":{"raw":"/api/v4/contract-templates?status=published&category=&jurisdiction=universal&locale=en","host":[""],"path":["api","v4","contract-templates"],"query":[{"key":"status","value":"published","description":"[Optional] Status of the template. Possible values: draft, published"},{"key":"category","value":"","description":"[Optional] Category of the template (check admin)"},{"key":"jurisdiction","value":"universal","description":"[Optional] Jurisdiction of the template"},{"key":"locale","value":"en","description":"[Optional] Locale of the template"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.21.6"},{"key":"Date","value":"Wed, 06 Sep 2023 08:15:50 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"205"},{"key":"Connection","value":"keep-alive"},{"key":"Etag","value":"\"19f88d4559706b0fd13f04d8c435ed03ba3abaca\""},{"key":"Strict-Transport-Security","value":"max-age=31536000"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": 1,\n \"result\": [\n {\n \"title\": \"Employment contract\",\n \"contract_template_group_id\": 4,\n \"version\": 2,\n \"ext_id\": null,\n \"status\": \"published\",\n \"category\": null,\n \"jurisdiction\": \"universal\",\n \"locale\": \"en\"\n }\n ]\n}"}],"_postman_id":"b0abb2ef-81d2-45e8-aa78-ac5a52df11c7"},{"name":"Get contract template variables","id":"c08385f4-fa0b-4ae5-8325-a24849090b5e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"}],"url":"/api/v4/contract-template/:contract-template-group-id/variables","description":"

Returns the list of available blocks, choices and variables.

Contract template group ID

\n","type":"text/plain"},"type":"any","value":"40","key":"contract-template-group-id"}]}},"response":[{"id":"b8fcb4b4-1579-411f-84b1-937da81b7081","name":"Get contract template variables","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"}],"url":{"raw":"/api/v4/contract-template/:contract_template_group_id/variables","host":[""],"path":["api","v4","contract-template",":contract_template_group_id","variables"],"variable":[{"key":"contract_template_group_id","value":"2"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.21.6"},{"key":"Date","value":"Thu, 24 Aug 2023 11:45:57 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"2135"},{"key":"Connection","value":"keep-alive"},{"key":"Etag","value":"\"fa0ece2b202f7bdc56c62509fcf214e90f63c2a4\""},{"key":"Strict-Transport-Security","value":"max-age=31536000"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": 1,\n \"result\": {\n \"blocks\": [\n {\n \"uuid\": \"5775754b-ab23-47f8-96ca-3e45bd8b2206\",\n \"title\": \"Title\",\n \"choices\": [\n {\n \"uuid\": \"872ed570-b0a7-42d7-9ab7-bf41d7fa3352\",\n \"contract_template_block_id\": 4,\n \"ext_id\": \"\",\n \"title\": \"Choice\",\n \"selected\": false,\n \"questions\": [\n {\n \"uuid\": \"4e8bc300-d14f-47df-89f2-84d501e9849c\",\n \"ext_id\": \"\",\n \"title\": \"Agreement number\",\n \"type\": \"text\",\n \"answer\": null\n }\n ]\n }\n ],\n \"conditions\": {}\n }\n ]\n }\n}"}],"_postman_id":"c08385f4-fa0b-4ae5-8325-a24849090b5e"},{"name":"Generate contract from template","id":"12093955-3ad5-4785-aca4-5d5ea7745d96","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"title\": \"Title of the created aDoc\",\n \"status\": \"Status of the created aDoc. Possible values: draft (default), sent_for_approval (requires approving collaborators), sent_for_signing (requires signing collaborators and no approving collaborators), ready_for_approval. Status sent_for_approval will automatically finish drafting and send the document to be approved, sent_for_signing will automatically send for signing. Status ready_for_approval will just finish drafting.\",\n \"collaborators\":[\n {\n \"email\": \"Collaborator email (required)\",\n \"first_name\": \"Required for new users\",\n \"last_name\": \"Required for new users\",\n\n \"login_method\": \"Login method for accessing the workspace. Possible values: password (default), sso (use Single sign-on), link, and smart (use Smart-ID). Optional, defaults to 'password' if not set.\",\n\n \"is_owner\": \"Value true/false whether the collaborator is owner. Only one collaborator should have this set\",\n \"is_signer\": \"Value true or false, is the user a signer\",\n \"is_approver\": \"Value true or false, is the user an approver\",\n \"is_editor\": \"Value true or false, is the user a editor\",\n \"is_viewer\": \"Value true or false, is the user a viewer\",\n\n \"approving_order\": \"Integer greater than 1 which specifies the place in the approving queue. Property is_approver must be true and all collaborator approving_order values must be unique. If at least one order is set, approving queue will be used\",\n \"signing_order\": \"Integer greater than 1 which specifies the place in the signing queue. Property is_signer must be true and all collaborator signing_order values must be unique. If at least one order is set, signing queue will be used\",\n\n \"message\": \"Optional invitation message to be included in the notification email\",\n \"user_workspace_language\": \"Specify the workspace language for the user. Allowed values are en, et, lv, lt. If something invalid is specified, no error is returned, but the value defaulted to en\"\n }\n ],\n \"variables\":{\n \"choices\":{\n \"ext_ids\": [\"External IDs of selected choices\"],\n \"uuids\": [\"UUIDs of selected choices\"]\n },\n \"questions\":{\n \"ext_ids\": {\n \"External ID\": {\n \"result\": \"Answer for text/number/date questions\",\n \"ext_ids\": [\"Selected option ext_ids for option/multioption questions\"],\n \"uuids\": [\"Selected option UUIDs for option/multioption questions\"],\n \"custom\": [\"Custom option answers for option/multioption questions\"]\n }\n },\n \"uuids\": {\n \"UUID\": {\n \"result\": \"Answer for text/number/date questions\",\n \"ext_ids\": [\"Selected option ext_ids for option/multioption questions\"],\n \"uuids\": [\"Selected option UUIDs for option/multioption questions\"],\n \"custom\": [\"Custom option answers for option/multioption questions\"]\n }\n }\n }\n },\n \"adoc_meta\": {\n \"meta_key\": \"meta_value\"\n },\n \"folder_id\": \"ID of destination folder (optional)\",\n \"folder_ext_id\": \"External ID of destination folder (optional)\",\n \"signing\": { // Required only when status is set to 'sent_for_signing'\n \"method\": \"Signing method to be used. Possible values: dokobit-est, dokobit-universal, signnow, eideasy.\",\n \"file_type\": \"File type to be used for Dokobit signing. Possible values: ASICE, PDF, EDOC, BDOC. Required if any Dokobit signing method or eID Easy (supports ASICE and PDF) is chosen\"\n },\n \"return_collaborators\": \"Value true/false whether to return added collaborator data. Defaults to false\",\n \"human_readable\": \"Value true/false whether to return occurred errors in human readable format. Defaults to false\"\n}","options":{"raw":{"language":"json"}}},"url":"/api/v4/contract-from-template/:contract-template-group-id","description":"

An endpoint to create an aDoc from a contract template.

Exactly one included collaborator has to have the role \"owner\" assigned to them.
New users must have \"first_name\" and \"last_name\" set for them.

NB! Make sure that the template you are using is shared with the account manager/document owner of that workspace/subspace.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"21a85f2d-de6e-4e68-b8bd-86a7e8450372","id":"21a85f2d-de6e-4e68-b8bd-86a7e8450372","name":"Avokaado Partner API","type":"collection"}},"urlObject":{"path":["api","v4","contract-from-template",":contract-template-group-id"],"host":[""],"query":[],"variable":[{"type":"any","value":"62","key":"contract-template-group-id"}]}},"response":[{"id":"6d539dfd-db97-41ef-b831-021169b6a0c5","name":"Generate contract from template","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"title\": \"Title of the created aDoc\",\n \"status\": \"Status of the created aDoc. Possible values: draft (default), sent_for_approval (requires approving collaborators), sent_for_signing (requires signing collaborators and no approving collaborators), ready_for_approval. Status sent_for_approval will automatically finish drafting and send the document to be approved, sent_for_signing will automatically send for signing. Status ready_for_approval will just finish drafting.\",\n \"collaborators\":[\n {\n \"email\": \"Collaborator email (required)\",\n \"first_name\": \"Required for new users\",\n \"last_name\": \"Required for new users\",\n\n \"login_method\": \"Login method for accessing the workspace. Possible values: password (default), sso (use Single sign-on), link, and smart (use Smart-ID). Optional, defaults to 'password' if not set.\",\n\n \"is_owner\": \"Value true/false whether the collaborator is owner. Only one collaborator should have this set\",\n \"is_signer\": \"Value true or false, is the user a signer\",\n \"is_approver\": \"Value true or false, is the user an approver\",\n \"is_editor\": \"Value true or false, is the user a editor\",\n \"is_viewer\": \"Value true or false, is the user a viewer\",\n\n \"approving_order\": \"Integer greater than 1 which specifies the place in the approving queue. Property is_approver must be true and all collaborator approving_order values must be unique. If at least one order is set, approving queue will be used\",\n \"signing_order\": \"Integer greater than 1 which specifies the place in the signing queue. Property is_signer must be true and all collaborator signing_order values must be unique. If at least one order is set, signing queue will be used\",\n\n \"message\": \"Optional invitation message to be included in the notification email\"\n }\n ],\n \"variables\":{\n \"choices\":{\n \"ext_ids\": [\"External IDs of selected choices\"],\n \"uuids\": [\"UUIDs of selected choices\"]\n },\n \"questions\":{\n \"ext_ids\": {\n \"External ID\": {\n \"result\": \"Answer for text/number/date questions\",\n \"ext_ids\": [\"Selected option ext_ids for option/multioption questions\"],\n \"uuids\": [\"Selected option UUIDs for option/multioption questions\"],\n \"custom\": [\"Custom option answers for option/multioption questions\"]\n }\n },\n \"uuids\": {\n \"UUID\": {\n \"result\": \"Answer for text/number/date questions\",\n \"ext_ids\": [\"Selected option ext_ids for option/multioption questions\"],\n \"uuids\": [\"Selected option UUIDs for option/multioption questions\"],\n \"custom\": [\"Custom option answers for option/multioption questions\"]\n }\n }\n }\n },\n \"adoc_meta\": {\n \"meta_key\": \"meta_value\"\n },\n \"folder_id\": \"ID of destination folder (optional)\",\n \"folder_ext_id\": \"External ID of destination folder (optional)\",\n \"signing\": { // Required only when status is set to 'sent_for_signing'\n \"method\": \"Signing method to be used. Possible values: dokobit-est, dokobit-universal, signnow, eideasy.\",\n \"file_type\": \"File type to be used for Dokobit signing. Possible values: ASICE, PDF, EDOC, BDOC. Required if any Dokobit signing method or eID Easy (supports ASICE and PDF) is chosen\"\n },\n \"return_collaborators\": \"Value true/false whether to return added collaborator data. Defaults to false\",\n \"human_readable\": \"Value true/false whether to return occurred errors in human readable format. Defaults to false\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"/api/v4/contract-from-template/:contract-template-group-id","host":[""],"path":["api","v4","contract-from-template",":contract-template-group-id"],"variable":[{"key":"contract-template-group-id","value":""}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"7a6a304e-16d0-42b8-a92c-15dd210a0008","name":"Generate contract from template (object array)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"title\": \"Title of the created aDoc\",\n \"collaborators\":[\n {\n \"email\": \"Collaborator email (required)\"\n }\n ],\n \"variables\":{\n \"choices\":{\n \"ext_ids\": [\"External IDs of selected choices\"],\n \"uuids\": [\"UUIDs of selected choices\"]\n },\n \"questions\":{\n \"ext_ids\": [\n {\n \"ext_id\": \"External ID\",\n\n \"result\": \"Answer for text/number/date questions\",\n \"ext_ids\": [\"Selected option ext_ids for option/multioption questions\"],\n \"uuids\": [\"Selected option UUIDs for option/multioption questions\"],\n \"custom\": [\"Custom option answers for option/multioption questions\"]\n }\n ],\n \"uuids\": [\n {\n \"uuid\": \"UUID\",\n \n \"result\": \"Answer for text/number/date questions\",\n \"ext_ids\": [\"Selected option ext_ids for option/multioption questions\"],\n \"uuids\": [\"Selected option UUIDs for option/multioption questions\"],\n \"custom\": [\"Custom option answers for option/multioption questions\"]\n }\n ]\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"/api/v4/contract-from-template/:contract-template-group-id","host":[""],"path":["api","v4","contract-from-template",":contract-template-group-id"],"variable":[{"key":"contract-template-group-id","value":""}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"24fa63d6-c720-4f87-99ca-889044279fa5","name":"Generate contract from template SUCCESS","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"title\": \"Test contract\",\n \"collaborators\":[\n {\n \"email\": \"admin@avokaado.com\",\n \"is_owner\": true\n }\n ],\n \"variables\":{\n \"questions\":{\n \"ext_ids\": {\n \"q-first-name\": {\n \"result\": \"John\"\n },\n \"q-last-name\": {\n \"result\": \"Doe\"\n },\n \"q-options\": {\n \"ext_ids\": [\"q-options-opt2\"]\n },\n \"q-multi-options\": {\n \"ext_ids\": [\"q-multi-options-opt1\", \"q-multi-options-opt2\"]\n }\n }\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"/api/v4/contract-from-template/:contract-template-group-id","host":[""],"path":["api","v4","contract-from-template",":contract-template-group-id"],"variable":[{"key":"contract-template-group-id","value":"63"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.21.6"},{"key":"Date","value":"Mon, 01 Apr 2024 13:24:18 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"392"},{"key":"Connection","value":"keep-alive"},{"key":"Strict-Transport-Security","value":"max-age=31536000"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": 1,\n \"result\": {\n \"id\": 992,\n \"title\": \"Test contract\",\n \"url\": \"https://avokaado.local/app/task/sign/992?h=5836aca6c390b936b2904953fee0697ef2e7522a3f9933fcaefcb0e4320a1141749ea372f48dab6b92f42b3f53bc8142f72fb1b3d09cb0937f7247d5a6ef1933\",\n \"access_hash\": \"5836aca6c390b936b2904953fee0697ef2e7522a3f9933fcaefcb0e4320a1141749ea372f48dab6b92f42b3f53bc8142f72fb1b3d09cb0937f7247d5a6ef1933\"\n }\n}"}],"_postman_id":"12093955-3ad5-4785-aca4-5d5ea7745d96"},{"name":"Mark document as finished","id":"8da2197a-c1c8-437f-9b09-244be02a003f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"url":"/api/v4/adocs/:adoc_id/finish","description":"

An endpoint to create an aDoc from a contract template.

Exactly one included collaborator has to have the role \"owner\" assigned to them.
New users must have \"first_name\" and \"last_name\" set for them.

aDoc ID

\n","type":"text/plain"},"type":"any","value":"","key":"adoc_id"}]}},"response":[],"_postman_id":"8da2197a-c1c8-437f-9b09-244be02a003f"},{"name":"Get folders","id":"920e3ec6-3566-4867-ac67-393aba7840e6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer ","type":"text"}],"url":"/api/v4/folders?structure=flat&sort_by=name_asc","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"21a85f2d-de6e-4e68-b8bd-86a7e8450372","id":"21a85f2d-de6e-4e68-b8bd-86a7e8450372","name":"Avokaado Partner API","type":"collection"}},"urlObject":{"path":["api","v4","folders"],"host":[""],"query":[{"description":{"content":"

Structure of the returned folder data: flat/tree (defaults to flat)

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

Sort by, possible values: name_asc/name_desc/last_edit_asc/last_edit_desc/created_at_asc/created_at_desc

\n","type":"text/plain"},"key":"sort_by","value":"name_asc"}],"variable":[]}},"response":[{"id":"25550ce8-bd0b-484d-9e37-f2362e81efd2","name":"Flat folder structure","originalRequest":{"method":"GET","header":[],"url":{"raw":"/api/v4/folders?structure=flat&sort_by=name_asc","host":[""],"path":["api","v4","folders"],"query":[{"key":"structure","value":"flat","description":"Structure of the returned folder data: flat/tree (defaults to flat)","type":"text"},{"key":"sort_by","value":"name_asc","description":"Sort by, possible values: name_asc/name_desc/last_edit_asc/last_edit_desc/created_at_asc/created_at_desc","type":"text"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.21.6"},{"key":"Date","value":"Fri, 16 Feb 2024 07:00:07 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"657"},{"key":"Connection","value":"keep-alive"},{"key":"Etag","value":"\"c738151760f46ebf6dce5ea620f1feacdfbaa629\""},{"key":"Strict-Transport-Security","value":"max-age=31536000"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": 1,\n \"result\": [\n {\n \"id\": 2,\n \"name\": \"Folder 2\",\n \"folder_type\": \"default\",\n \"sort_order\": 1,\n \"parent_folder_id\": null,\n \"external_id\": null,\n \"created_at\": \"2023-08-21T06:53:52\"\n },\n {\n \"id\": 3,\n \"name\": \"Folder 3\",\n \"folder_type\": \"default\",\n \"sort_order\": 2,\n \"parent_folder_id\": 2,\n \"external_id\": null,\n \"created_at\": \"2023-08-21T06:54:29\"\n },\n {\n \"id\": 4,\n \"name\": \"Folder 4\",\n \"folder_type\": \"default\",\n \"sort_order\": 3,\n \"parent_folder_id\": 3,\n \"external_id\": null,\n \"created_at\": \"2023-08-21T07:51:21\"\n },\n {\n \"id\": 5,\n \"name\": \"Test folder 1\",\n \"folder_type\": \"default\",\n \"sort_order\": 1,\n \"parent_folder_id\": null,\n \"external_id\": null,\n \"created_at\": \"2023-11-09T18:23:19\"\n }\n ]\n}"},{"id":"7d302221-9a96-47a6-8188-8c6c9324f7d1","name":"Tree folder structure","originalRequest":{"method":"GET","header":[],"url":{"raw":"/api/v4/folders?structure=tree&sort_by=name_asc","host":[""],"path":["api","v4","folders"],"query":[{"key":"structure","value":"tree","description":"Structure of the returned folder data: flat/tree (defaults to flat)","type":"text"},{"key":"sort_by","value":"name_asc","description":"Sort by, possible values: name_asc/name_desc/last_edit_asc/last_edit_desc/created_at_asc/created_at_desc","type":"text"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.21.6"},{"key":"Date","value":"Fri, 16 Feb 2024 07:00:30 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"717"},{"key":"Connection","value":"keep-alive"},{"key":"Etag","value":"\"a14d6a9d343e81e3c7067b3a4c566a3ed1d1da46\""},{"key":"Strict-Transport-Security","value":"max-age=31536000"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": 1,\n \"result\": [\n {\n \"id\": 2,\n \"name\": \"Folder 2\",\n \"folder_type\": \"default\",\n \"sort_order\": 1,\n \"parent_folder_id\": null,\n \"external_id\": null,\n \"created_at\": \"2023-08-21T06:53:52\",\n \"children\": [\n {\n \"id\": 3,\n \"name\": \"Folder 3\",\n \"folder_type\": \"default\",\n \"sort_order\": 2,\n \"parent_folder_id\": 2,\n \"external_id\": null,\n \"created_at\": \"2023-08-21T06:54:29\",\n \"children\": [\n {\n \"id\": 4,\n \"name\": \"Folder 4\",\n \"folder_type\": \"default\",\n \"sort_order\": 3,\n \"parent_folder_id\": 3,\n \"external_id\": null,\n \"created_at\": \"2023-08-21T07:51:21\",\n \"children\": []\n }\n ]\n }\n ]\n },\n {\n \"id\": 5,\n \"name\": \"Test folder 1\",\n \"folder_type\": \"default\",\n \"sort_order\": 1,\n \"parent_folder_id\": null,\n \"external_id\": null,\n \"created_at\": \"2023-11-09T18:23:19\",\n \"children\": []\n }\n ]\n}"}],"_postman_id":"920e3ec6-3566-4867-ac67-393aba7840e6"},{"name":"Get aDoc documents","id":"33c8ebed-cfe9-4848-b1fc-6394204bd076","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/api/v4/adocs/:adoc_id/documents","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"21a85f2d-de6e-4e68-b8bd-86a7e8450372","id":"21a85f2d-de6e-4e68-b8bd-86a7e8450372","name":"Avokaado Partner API","type":"collection"}},"urlObject":{"path":["api","v4","adocs",":adoc_id","documents"],"host":[""],"query":[],"variable":[{"type":"any","value":"1071","key":"adoc_id"}]}},"response":[{"id":"4bf0465f-b409-4b86-a79f-3855236df265","name":"Get aDoc documents","originalRequest":{"method":"GET","header":[],"url":{"raw":"/api/v4/adocs/:adoc_id/documents","host":[""],"path":["api","v4","adocs",":adoc_id","documents"],"variable":[{"key":"adoc_id","value":"1071"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.21.6"},{"key":"Date","value":"Fri, 31 May 2024 07:27:34 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"551"},{"key":"Connection","value":"keep-alive"},{"key":"Etag","value":"\"0ff1e578897614f9f579e881236cda6e56252af1\""},{"key":"Strict-Transport-Security","value":"max-age=31536000"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": 1,\n \"result\": [\n {\n \"id\": 3862,\n \"title\": \"Services template V1\",\n \"file_name\": \"Services template V1.docx\",\n \"created_at\": \"2024-05-29T06:49:20\",\n \"mime_type\": \"application/vnd.openxmlformats-officedocument.wordprocessingml.document\",\n \"is_signed\": true,\n \"access_url\": \"https://avokaado.local/app/document/3862?id=1071&download=0\"\n },\n {\n \"id\": 3863,\n \"title\": \"Services template V1\",\n \"file_name\": \"Services template V1.pdf\",\n \"created_at\": \"2024-05-29T06:49:20\",\n \"mime_type\": \"application/pdf\",\n \"is_signed\": true,\n \"access_url\": \"https://avokaado.local/app/document/3863?id=1071&download=0\"\n }\n ]\n}"}],"_postman_id":"33c8ebed-cfe9-4848-b1fc-6394204bd076"},{"name":"Download aDoc document","id":"3cd59e88-3d01-4bb8-801b-424e750848d6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/api/v4/adocs/:adoc_id/documents/:doc_id/download?base64_encoded=0","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"21a85f2d-de6e-4e68-b8bd-86a7e8450372","id":"21a85f2d-de6e-4e68-b8bd-86a7e8450372","name":"Avokaado Partner API","type":"collection"}},"urlObject":{"path":["api","v4","adocs",":adoc_id","documents",":doc_id","download"],"host":[""],"query":[{"key":"base64_encoded","value":"0"}],"variable":[{"type":"any","value":"","key":"adoc_id"},{"type":"any","value":"","key":"doc_id"}]}},"response":[{"id":"bca80077-4647-49ad-aadf-f2dd859400fb","name":"Download aDoc document (base64)","originalRequest":{"method":"GET","header":[],"url":{"raw":"/api/v4/adocs/:adoc_id/documents/:doc_id/download?base64_encoded=1","host":[""],"path":["api","v4","adocs",":adoc_id","documents",":doc_id","download"],"query":[{"key":"base64_encoded","value":"1"}],"variable":[{"key":"adoc_id","value":"1073"},{"key":"doc_id","value":"3878"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.21.6"},{"key":"Date","value":"Fri, 31 May 2024 10:10:16 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"29968"},{"key":"Connection","value":"keep-alive"},{"key":"Etag","value":"\"f9cd9f6ec37024fa4cfe71bda15c322182f06749\""},{"key":"Strict-Transport-Security","value":"max-age=31536000"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": 1,\n \"result\": \"JVBERi0xLjcNCjQgMCBvYmoNCjw8L1R5cGUgL1BhZ2UvUGFyZW50IDMgMCBSL0NvbnRlbnRzIDUgMCBSL01lZGlhQm94IFswIDAgNTk1LjI1IDg0MS44NDk5NzU1OV0vUmVzb3VyY2VzPDwvRm9udDw8L0ZBQUFBSCA3IDAgUi9GQUFBQkEgMTAgMCBSPj4+Pi9Hcm91cCA8PC9UeXBlL0dyb3VwL1MvVHJhbnNwYXJlbmN5L0NTL0RldmljZVJHQj4...MTI1DQolJUVPRg0K\"\n}"}],"_postman_id":"3cd59e88-3d01-4bb8-801b-424e750848d6"},{"name":"Get aDoc data","id":"8b734019-cb02-4257-bc9d-2b4267a6b684","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/api/v4/adocs/:adoc_id","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"21a85f2d-de6e-4e68-b8bd-86a7e8450372","id":"21a85f2d-de6e-4e68-b8bd-86a7e8450372","name":"Avokaado Partner API","type":"collection"}},"urlObject":{"path":["api","v4","adocs",":adoc_id"],"host":[""],"query":[],"variable":[{"type":"any","value":"1074","key":"adoc_id"}]}},"response":[],"_postman_id":"8b734019-cb02-4257-bc9d-2b4267a6b684"},{"name":"GET adoc data-fields","id":"21b70f76-f6d6-4576-bc86-d710e3cba619","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"}],"body":{"mode":"raw","raw":"{\n \"template_group_id\": null,\n \"document_type_id\": null,\n \"adoc_id\": null,\n \"adoc_ids\": null,\n \"date_from\": null,\n \"date_to\": null,\n \"external_ids\": null,\n \"uuids\": null,\n \"file_type\": \"json\", \n \"page\": null,\n \"limit\": null\n}","options":{"raw":{"language":"json"}}},"url":"/api/v4/data-fields","description":"

Returns the data-fields for the related aDocs according to filters.

template_group_id: null | int (ex. template_group_id: 1)\ndocument_type_id: null | int (ex. document_type_id: 1)\nadoc_id: null | int (ex. adoc_id: 1)\nadoc_ids: null | [int] (ex. adoc_ids: [1, 2])\ndate_from: null | string (ex. date_from: \"2024-01-01\")\ndate_to: null | string (ex. date_from: \"2025-01-01\")\nexternal_ids: null | [] (ex. external_ids: [\"name\", \"id\"])\nuuids: null | [] (ex. uuids: [\"022d210a-3c5e-4782-b7a6-e01e987207a9\"])\nfile_type: null (in this case response is json) | string (enum XML, XLSX, CSV) (ex. file_type: \"CSV\")\npage: null | int (ex. page: 1)\nlimit: null | int (ex. limit: 50) (Default is 100, max is 500)\n\n

","urlObject":{"path":["api","v4","data-fields"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"21b70f76-f6d6-4576-bc86-d710e3cba619"},{"name":"Get adoc logs","id":"50389c8b-b15b-4233-b03d-2daf1151fb11","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"/api/v4/adocs/logs?adoc_ids=&response_file_type=json","description":"

Request returns the adoc log files in PDF or JSON format. If multiple adoc ids are provided, then the files are zipped.

The adoc id count is limited to 50. If provided more, an error will be returned.

\n","urlObject":{"path":["api","v4","adocs","logs"],"host":[""],"query":[{"description":{"content":"

Comma separated list of aDoc IDs, maximum of 50 IDs

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

PDF or JSON of the file type, default is JSON

\n","type":"text/plain"},"key":"response_file_type","value":"json"}],"variable":[]}},"response":[],"_postman_id":"50389c8b-b15b-4233-b03d-2daf1151fb11"}],"id":"51c99b2c-473c-4b69-9618-50f080c4a571","_postman_id":"51c99b2c-473c-4b69-9618-50f080c4a571","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"21a85f2d-de6e-4e68-b8bd-86a7e8450372","id":"21a85f2d-de6e-4e68-b8bd-86a7e8450372","name":"Avokaado Partner API","type":"collection"}}},{"name":"Postbacks","item":[{"name":"Signed Postback","id":"763e5d00-4f87-49a2-a92a-cfab4fb522cf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"","description":"

This is the request that is made towards the provided in the adoc_meta \"signed_postback\" key value.