{"info":{"_postman_id":"95e7e1bb-b895-4314-a939-d6424c122e20","name":"DocspoAPI Public","description":"

This contains an overview of how to use the API with authentication and the most important routes to manage documents. If you find any bugs or have feedback please share them and we are happy to build a better service, thank you.

Sandbox

If you need a free sandbox account let us know and we will help you get started using the API. Reach out on the chat at https://app.docspo.com.

How to authenticate

Signup with a normal account in the browser for the service: https://app.docspo.com
You can then authenticate as a CompanyUser or use a apiKey. Routes that have the header Authorization can be used with a companyUserToken and routes with the header apiKey can be used with the apiKey. You only have to provide one of the two headers with the authentication you prefer.

Suggested flow to authenticate

If you dont have a account first signup with a normal account in the browser: https://app.docspo.com
Use the route POST /auth/companyUser with email and password to authenticate as a CompanyUser
From the response, copy token. This is a short lived companyUserToken
Create a CompanyApiKey by using the route POST /companyApiKey and provide the header Authentication with value JWT companyUserToken from step 2.
From the new apiKey you just created grab apiKey
You can now use most routes with a long lived apiKey, just provide the header apiKey with value {apiKey}

REST

It is useful to know that routes with the method POST are normaly used to create new resources. The method GET is used to read the resources. To update a resource we use the method PUT but normally only the specified paths are updated: Try it out but most API routes only updates the values you provide. The method DELETE is used to delete a resource and we use the method PATCH to undo a deletion.

Filters

Some routes support filters, note that there are two different format on filters (example project vs document) so please learn more in the examples.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"1358621","collectionId":"95e7e1bb-b895-4314-a939-d6424c122e20","publishedId":"UV5f6YWW","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"0095FF"},"publishDate":"2022-06-13T07:20:27.000Z"},"item":[{"name":"Authentication","item":[{"name":"/auth/companyUser","id":"4524846d-3d04-4e3e-ba7a-1c3d6a0ee904","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"email\": \"\",\n \"password\": \"\"\n}"},"url":"https://api.docspo.com/auth/companyUser","description":"

Authenticate as a CompanyUser.\nWhen authenticating with email/password you get a short lived JSON Web Token (JWT). The reason to authenticate as a companyUser directly to the API is mainly to be able to generate a CompanyApiKey.

To use the token

From the response grab the property token, that is what we call the companyUserToken.\nAdd a header to your request with name Authentication and value JWT {companyUserToken}

\n","urlObject":{"path":["auth","companyUser"],"host":["https://api.docspo.com"],"query":[],"variable":[]}},"response":[{"id":"8e0a96f6-653b-4cc1-9dde-c9ffc2cff04a","name":"/auth/companyUser","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\"email\": \"username@domain.com\",\n\"password\": \"mypassword\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.docspo.com/auth/companyUser"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.10.3 (Ubuntu)"},{"key":"Date","value":"Tue, 06 Jul 2021 06:51:22 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Security-Policy","value":"default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;frame-ancestors 'self';img-src 'self' data:;object-src 'self';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"Expect-CT","value":"max-age=0"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubdomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"X-XSS-Protection","value":"0"},{"key":"Vary","value":"Origin, Accept-Encoding"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Expose-Headers","value":"X-Total-Count,X-Project-Count-draft,X-Project-Count-sent,X-Project-Count-accepted,X-Project-Count-denied,X-Project-Count-active,X-Project-Count-complete,X-Project-Count-archived"},{"key":"ETag","value":"W/\"1842-wFn6b0UEwXZYXGxgLA9L+/U6wew\""},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"token\": \"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6MTQsImV4cGlyZXMiOiIyMDIxLTA3LTA2VDA3OjA2OjIxLjk4MFoifQ.HPZmUCIMpFmfbF9qK1pzMdF3rKKqr3uxZaOA8qRKZSg\",\n \"tokenExpires\": \"2021-07-06T07:06:21.980Z\",\n \"companyUser\": {\n \"fullName\": \"Roger Kent\",\n \"id\": 14,\n \"publicId\": \"gbmv8hfzpk1vtu1r0\",\n \"email\": \"username@domain.com\",\n \"firstname\": \"Roger\",\n \"lastname\": \"Kent\",\n \"cellphone\": \"073123456\",\n \"language\": \"sv\",\n \"locale\": \"sv-SE\",\n \"createdAt\": \"2017-07-25T13:27:48.000Z\",\n \"updatedAt\": \"2021-06-28T20:09:48.000Z\",\n \"deletedAt\": null,\n \"CompanyId\": 14,\n \"AvatarPublicId\": null,\n \"slaveToCompanyUserId\": null\n },\n \"company\": {\n \"vatNumber\": null,\n \"smsSender\": \"KentInc\",\n \"id\": 14,\n \"publicId\": \"gbmv8hfzpk1vttypz\",\n \"name\": \"Kent Inc\",\n \"companyType\": \"aktiebolag\",\n \"organisationNumber\": null,\n \"email\": \"username@domain.com\",\n \"website\": \"cling.se\",\n \"instagramUrl\": null,\n \"facebookUrl\": null,\n \"recoUrl\": null,\n \"googleUrl\": null,\n \"linkedinUrl\": null,\n \"phone\": \"073123456\",\n \"showPublicProfile\": false,\n \"region\": \"SE\",\n \"brand\": \"cling\",\n \"createdAt\": \"2017-07-25T13:27:48.000Z\",\n \"updatedAt\": \"2020-04-08T14:12:59.000Z\",\n \"LogotypePublicId\": \"375fe7eh6ojfb4e1xk\"\n },\n \"refreshToken\": \"\"\n}"}],"_postman_id":"4524846d-3d04-4e3e-ba7a-1c3d6a0ee904"}],"id":"1fa0f577-00d3-4a67-ad5d-49e661a844eb","description":"

Shows how to authenticate with the API.

\n","event":[{"listen":"prerequest","script":{"id":"9686b6ee-c43e-4753-93a3-ebb2c211235a","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"46558392-b106-4489-a8fa-4339125528c6","type":"text/javascript","exec":[""]}}],"_postman_id":"1fa0f577-00d3-4a67-ad5d-49e661a844eb"},{"name":"CompanyApiKey","item":[{"name":"/companyApiKey","id":"b259ce41-a657-45ac-abfb-6d3156c4e874","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"","type":"text"}],"url":"https://api.docspo.com/companyApiKey","description":"

Get all existing companyApiKeys

\n","urlObject":{"path":["companyApiKey"],"host":["https://api.docspo.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"b259ce41-a657-45ac-abfb-6d3156c4e874"},{"name":"/companyApiKey","id":"59939291-2e0e-4d31-ac23-ecc832278a8e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"scope\": \"api\",\n\t\"expiresAt\": \"2022-01-01 10:00:00\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.docspo.com/companyApiKey","description":"

Create a new apiKey. Specify the scope as api and when the key will expire.

\n","urlObject":{"path":["companyApiKey"],"host":["https://api.docspo.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"59939291-2e0e-4d31-ac23-ecc832278a8e"},{"name":"/companyApiKey/:id","id":"95f64eaa-c0d2-4a81-995b-7fa9ce1c9584","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"","type":"text"}],"url":"https://api.docspo.com/companyApiKey/:id","description":"

View one companyApiKey by id

\n","urlObject":{"path":["companyApiKey",":id"],"host":["https://api.docspo.com"],"query":[],"variable":[{"id":"eaa5cc9f-2728-4dff-83dc-f9c67a8a5dc0","description":{"content":"

Required

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"95f64eaa-c0d2-4a81-995b-7fa9ce1c9584"},{"name":"/companyApiKey/:id","id":"a9c405df-9ddf-43eb-a8c8-6a016420f939","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","type":"text","value":""}],"body":{"mode":"raw","raw":"{\n\t\"expiresAt\": \"2022-06-01 10:00:00\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.docspo.com/companyApiKey/:id","description":"

Update a companyApiKey by id

\n","urlObject":{"path":["companyApiKey",":id"],"host":["https://api.docspo.com"],"query":[],"variable":[{"id":"5e9f0642-cdda-4bab-9954-e89879d3d5b8","description":{"content":"

Required

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"a9c405df-9ddf-43eb-a8c8-6a016420f939"},{"name":"/companyApiKey/:id","id":"35b26af8-8d15-4341-bd3b-5e5f784b46e1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","type":"text","value":""}],"url":"https://api.docspo.com/companyApiKey/:id","description":"

Delete a companyApiKey by id

\n","urlObject":{"path":["companyApiKey",":id"],"host":["https://api.docspo.com"],"query":[],"variable":[{"id":"4c4a9ca5-cacb-42a1-b26a-53ccb4cad452","description":{"content":"

Required

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"35b26af8-8d15-4341-bd3b-5e5f784b46e1"},{"name":"/companyApiKey/:id","id":"7506ba99-df2d-47bc-92c9-2cba57166efa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Authorization","type":"text","value":""}],"url":"https://api.docspo.com/companyApiKey/:id","description":"

Restore a deleted companyApiKey so it again can be used.

\n","urlObject":{"path":["companyApiKey",":id"],"host":["https://api.docspo.com"],"query":[],"variable":[{"id":"7d0e23b4-d557-4c6c-bb45-18c89dcbd416","description":{"content":"

Required

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"7506ba99-df2d-47bc-92c9-2cba57166efa"}],"id":"ae8b2f1c-8ddf-48a5-8dac-20ababe30f9e","description":"

Routes to manage apiKeys. You must first authenticate as a companyUser to access these routes as they are protected. When you create a new apiKey you specify how long the key will be valid and we recommend to keep it as short lived as possible and renew it when needed.

A companyApiKey belongs to the CompanyUser that created it, with that users permissions. So make sure you create your apiKey under an admin user. That is to allow default data when using the apiKey to create resources. If you wish to create resources under another companyUser you can always specify that on the resource (as you probably are an admin). If a companyUser that owns apiKeys is deleted the apiKey is no longer valid to use.

\n","event":[{"listen":"prerequest","script":{"id":"84a7f361-8d36-4747-aee2-7de4abc2a68f","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"0bdcc1a4-fd8c-4a15-84a7-5f3249fbf9e3","type":"text/javascript","exec":[""]}}],"_postman_id":"ae8b2f1c-8ddf-48a5-8dac-20ababe30f9e"},{"name":"Document","item":[{"name":"/document","id":"8cfddefd-430f-4879-9290-823af63cac8c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"","type":"text"},{"key":"apiKey","value":"","type":"text"}],"url":"https://api.docspo.com/document?limit=10&sort=-createdAt&status=accepted","description":"

Get all existing documents. There are some query params that can be used to define return type but the most useful is that result can be limited, skipped, sorted and filtered.

\n","urlObject":{"path":["document"],"host":["https://api.docspo.com"],"query":[{"disabled":true,"key":"includeVersions","value":"false"},{"disabled":true,"key":"includeTemplate","value":"true"},{"disabled":true,"key":"includeEvents","value":"true"},{"disabled":true,"key":"returnType","value":"minimal"},{"disabled":true,"key":"returnType","value":"full"},{"disabled":true,"description":{"content":"

Skip results often used with limit

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

Limit no of results

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

Sort on property (- for desc)

\n","type":"text/plain"},"key":"sort","value":"-createdAt"},{"description":{"content":"

Filter on values

\n","type":"text/plain"},"key":"status","value":"accepted"}],"variable":[]}},"response":[],"_postman_id":"8cfddefd-430f-4879-9290-823af63cac8c"},{"name":"/document","id":"13a0e873-34c6-4de8-afd6-5e161da79ceb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","type":"text","value":""},{"key":"apiKey","type":"text","value":""}],"body":{"mode":"raw","raw":"{\n \"endCustomerId\": 10,\n \"data\": {\n \"name\": \"Proposal from API\"\n },\n \"templateId\": \"60db0cc283b378006b8e0067\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.docspo.com/document","description":"

Create a new document. This route is probably one of the most complex ones but the example body is a way to create a new document by just specifying a endCustomerId and a templateId to use and optionally a custom title for the document.

If no projectId is assigned a new project is created with the document.

\n","urlObject":{"path":["document"],"host":["https://api.docspo.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"13a0e873-34c6-4de8-afd6-5e161da79ceb"},{"name":"/document/:id","id":"f363f2c6-62f6-45cc-b7d2-e2925c7edadc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","type":"text","value":""},{"key":"apiKey","type":"text","value":""}],"url":"https://api.docspo.com/document/:id","description":"

View one document by id

\n","urlObject":{"path":["document",":id"],"host":["https://api.docspo.com"],"query":[],"variable":[{"id":"c62e8c14-4713-4e9e-92bb-7e7fc99a0a41","description":{"content":"

Required

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"f363f2c6-62f6-45cc-b7d2-e2925c7edadc"},{"name":"/document/:id","id":"38b79d33-78ec-4706-8b7e-2efbf031daf9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","value":"","type":"text"},{"key":"apiKey","value":"","type":"text"}],"body":{"mode":"raw","raw":"{\n\n}","options":{"raw":{"language":"json"}}},"url":"https://api.docspo.com/document/:id","description":"

Update a document by id.\nThe properties on the body root are updated, for example it is possible to just update the property companyUserId by calling PUT /document/:id with JSON:

{\n    \"companyUserId\": 1\n}\n

Then only that property would be updated.

If is also possible to update property paths if you specify the query param type=paths, example:

PUT /document/:id?type=paths with JSON:

{\n    \"data.name\": \"New document name\"\n}\n

would only update the name of the document and not changing any other property of data. You can specify multiple paths in the JSON if you wish.

\n","urlObject":{"path":["document",":id"],"host":["https://api.docspo.com"],"query":[],"variable":[{"id":"ba701f54-91a5-42ed-8db1-ce0a4aa25702","description":{"content":"

Required

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"38b79d33-78ec-4706-8b7e-2efbf031daf9"},{"name":"/document/:id","id":"f000d9b7-d8b6-4675-912c-d1082b56284d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"","type":"text"},{"key":"apiKey","value":"","type":"text"}],"url":"https://api.docspo.com/document/:id","description":"

Delete a document by id

\n","urlObject":{"path":["document",":id"],"host":["https://api.docspo.com"],"query":[],"variable":[{"id":"d6579688-7cc2-4ac4-8153-17a3a91e8815","description":{"content":"

Required

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"f000d9b7-d8b6-4675-912c-d1082b56284d"},{"name":"/document/:id","id":"a642ab69-fb87-4d4e-bcad-42bc67d68bf5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Authorization","value":"","type":"text"},{"key":"apiKey","value":"","type":"text"}],"url":"https://api.docspo.com/document/:id","description":"

Restore a deleted document so it again can be used.\nPlease note that if the project is also deleted the document might not be visible when logged in so if you did delete the project that one should probably be patched instead of the document.

\n","urlObject":{"path":["document",":id"],"host":["https://api.docspo.com"],"query":[],"variable":[{"id":"063d9c67-3db4-4e17-a3c2-ad8a5447d428","description":{"content":"

Required

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"a642ab69-fb87-4d4e-bcad-42bc67d68bf5"},{"name":"/document/:id/send","id":"dc77952c-1712-495b-87db-396a6cfe09e1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","type":"text","value":""},{"key":"apiKey","type":"text","value":""}],"url":"https://api.docspo.com/document/:id/send","description":"

Send a document to the clients and using default settings.

\n","urlObject":{"path":["document",":id","send"],"host":["https://api.docspo.com"],"query":[],"variable":[{"id":"aaf706cf-a7f4-4e77-bf6d-a34cb07ccc05","description":{"content":"

Required

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"dc77952c-1712-495b-87db-396a6cfe09e1"}],"id":"beb5f68e-da39-48b4-960c-c9aa882c6692","description":"

These routes are used to manage documents. Documents is one of the main resources in the API. A document mainly consists of a template that together with the document describes how the document should look and function.

\n","event":[{"listen":"prerequest","script":{"id":"1152643c-71d9-45a8-aaa8-941d0734279b","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"0ed7978a-d334-424c-b544-d28c0b241f0d","type":"text/javascript","exec":[""]}}],"_postman_id":"beb5f68e-da39-48b4-960c-c9aa882c6692"},{"name":"EndCustomer","item":[{"name":"/endCustomer","id":"a6278728-1e73-4157-ab6b-c2077ead211d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"","type":"text"},{"key":"apiKey","value":"","type":"text"}],"url":"https://api.docspo.com/endCustomer","description":"

Get all existing endCustomers.

\n","urlObject":{"path":["endCustomer"],"host":["https://api.docspo.com"],"query":[{"disabled":true,"key":"_start","value":"10"},{"disabled":true,"key":"_end","value":"20"},{"disabled":true,"description":{"content":"

Sort on property

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

ASC or DESC

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

To filter

\n","type":"text/plain"},"key":"_where","value":"or(name*=andersson)"}],"variable":[]}},"response":[],"_postman_id":"a6278728-1e73-4157-ab6b-c2077ead211d"},{"name":"/endCustomer","id":"5c350ca4-4cef-48c7-a88c-f3b1aab1ad92","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","type":"text","value":""},{"key":"apiKey","type":"text","value":""}],"body":{"mode":"raw","raw":"{\n \"customerType\": \"individual\",\n \"name\": \"Kent Andersson\",\n \"email\": \"kent.andersson@yourdomain.com\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.docspo.com/endCustomer","description":"

Create a new endCustomer.

\n","urlObject":{"path":["endCustomer"],"host":["https://api.docspo.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"5c350ca4-4cef-48c7-a88c-f3b1aab1ad92"},{"name":"/endCustomer/:id","id":"42ff776d-14db-4242-993e-e0681d5874af","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","type":"text","value":""},{"key":"apiKey","type":"text","value":""}],"url":"https://api.docspo.com/endCustomer/:id","description":"

View one endCustomer by id

\n","urlObject":{"path":["endCustomer",":id"],"host":["https://api.docspo.com"],"query":[],"variable":[{"id":"db562a65-c4c3-41dc-8808-31a5b11acf58","description":{"content":"

Required

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"42ff776d-14db-4242-993e-e0681d5874af"},{"name":"/endCustomer/:id","id":"5cc2659d-0a2f-4493-814e-2ac932b193f3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","type":"text","value":""},{"key":"apiKey","type":"text","value":""}],"body":{"mode":"raw","raw":"{\n \"cellphone\": \"073123456\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.docspo.com/endCustomer/:id","description":"

Update a endCustomer by id

\n","urlObject":{"path":["endCustomer",":id"],"host":["https://api.docspo.com"],"query":[],"variable":[{"id":"02911e72-859d-4cd2-85c8-6d1bf5f40081","description":{"content":"

Required

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"5cc2659d-0a2f-4493-814e-2ac932b193f3"},{"name":"/endCustomer/:id","id":"aebed855-a11c-4ae7-a47f-7ec31e7f2148","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","type":"text","value":""},{"key":"apiKey","type":"text","value":""}],"url":"https://api.docspo.com/endCustomer/:id","description":"

Delete a endCustomer by id.

\n","urlObject":{"path":["endCustomer",":id"],"host":["https://api.docspo.com"],"query":[],"variable":[{"id":"085103f8-12ae-48da-a009-d16c2a9b9a5f","description":{"content":"

Required

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"aebed855-a11c-4ae7-a47f-7ec31e7f2148"},{"name":"/endCustomer/:id","id":"ecfb6fef-e722-4066-aa0a-b1c287d020c9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Authorization","type":"text","value":""},{"key":"apiKey","type":"text","value":""}],"url":"https://api.docspo.com/endCustomer/:id","description":"

Restore a deleted endCustomer so it again can be used.

\n","urlObject":{"path":["endCustomer",":id"],"host":["https://api.docspo.com"],"query":[],"variable":[{"id":"25b36725-f3a3-4713-8f02-c225a58a5f0e","description":{"content":"

Required

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"ecfb6fef-e722-4066-aa0a-b1c287d020c9"}],"id":"7206c14f-987b-4d71-9776-f53eefe36dda","description":"

EndCustomers is your registry of clients. By creating a endCustomer you can re-use client information on multiple documents.

\n","event":[{"listen":"prerequest","script":{"id":"2654216c-8cf2-4ff2-b2fe-d4ebc1d4dde2","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"f8de7b3f-c9e6-4c1d-80d6-7136af3894f1","type":"text/javascript","exec":[""]}}],"_postman_id":"7206c14f-987b-4d71-9776-f53eefe36dda"},{"name":"Template","item":[{"name":"/template","id":"f7a0ecb5-1893-4e9d-bdc1-130179005ce6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","type":"text","value":""},{"key":"apiKey","type":"text","value":""}],"url":"https://api.docspo.com/template?limit=10&sort=-createdAt","description":"

Get all existing templates. There are some query params that can be used to define return type but the most useful is that result can be limited, skipped, sorted and filtered.

\n","urlObject":{"path":["template"],"host":["https://api.docspo.com"],"query":[{"disabled":true,"description":{"content":"

Skip results often used with limit

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

Limit no of results

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

Sort on property (- for desc)

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

Filter on values

\n","type":"text/plain"},"key":"language","value":"en"}],"variable":[]}},"response":[],"_postman_id":"f7a0ecb5-1893-4e9d-bdc1-130179005ce6"},{"name":"/template","id":"94047938-4a70-4b50-8b46-f57249b3ea07","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","type":"text","value":""},{"key":"apiKey","type":"text","value":""}],"body":{"mode":"raw","raw":"{\n}","options":{"raw":{"language":"json"}}},"url":"https://api.docspo.com/template","description":"

Create a new template

\n","urlObject":{"path":["template"],"host":["https://api.docspo.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"94047938-4a70-4b50-8b46-f57249b3ea07"},{"name":"/template/:id","id":"b0dda6c5-73d1-4e96-b0a7-c3019e3ee2e3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"","type":"text"},{"key":"apiKey","value":"","type":"text"}],"url":"https://api.docspo.com/template/:id","description":"

View one templates by id

\n","urlObject":{"path":["template",":id"],"host":["https://api.docspo.com"],"query":[],"variable":[{"id":"ed58edec-ecb0-44d8-8429-20b87ad4e1a6","description":{"content":"

Required

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"b0dda6c5-73d1-4e96-b0a7-c3019e3ee2e3"},{"name":"/template/:id","id":"ec414a68-f6ca-4aba-86c2-69a0ebfd5a75","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","type":"text","value":""},{"key":"apiKey","type":"text","value":""}],"body":{"mode":"raw","raw":"{\n \"name\": \"My template\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.docspo.com/template/:id","description":"

Update a templates by id

\n","urlObject":{"path":["template",":id"],"host":["https://api.docspo.com"],"query":[],"variable":[{"id":"a0ef0cc1-1ede-4615-afa7-aa0b5d28e9d6","description":{"content":"

Required

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"ec414a68-f6ca-4aba-86c2-69a0ebfd5a75"},{"name":"/template/:id","id":"ee49c26f-8f67-4b7d-a671-d7f61ecb9128","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","type":"text","value":""},{"key":"apiKey","type":"text","value":""}],"url":"https://api.docspo.com/template/:id","description":"

Delete a templates by id

\n","urlObject":{"path":["template",":id"],"host":["https://api.docspo.com"],"query":[],"variable":[{"id":"1e328d49-4513-4795-85c9-7c40a369088b","description":{"content":"

Required

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"ee49c26f-8f67-4b7d-a671-d7f61ecb9128"},{"name":"/template/:id","id":"bc726a56-0977-4f0f-9b98-bed8bf0c339c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Authorization","type":"text","value":""},{"key":"apiKey","type":"text","value":""}],"url":"https://api.docspo.com/template/:id","description":"

Restore a deleted templates so it again can be used.

\n","urlObject":{"path":["template",":id"],"host":["https://api.docspo.com"],"query":[],"variable":[{"id":"20c6a3fe-8081-4ad5-bc96-e19863a72033","description":{"content":"

Required

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"bc726a56-0977-4f0f-9b98-bed8bf0c339c"}],"id":"1e27f3e4-9919-48fc-b007-5c6bb98e43da","description":"

These routes are used to manage templates. A template is used to describe the format of a document.

\n","event":[{"listen":"prerequest","script":{"id":"6ff65a0c-9a2d-4b01-8528-5741459a39e4","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"0b200e97-2b13-4714-b237-524320d2a60e","type":"text/javascript","exec":[""]}}],"_postman_id":"1e27f3e4-9919-48fc-b007-5c6bb98e43da"},{"name":"Project","item":[{"name":"/project","id":"b24b438d-2880-4765-b558-3b788fcdcaf2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"","type":"text"},{"key":"apiKey","value":"","type":"text"}],"url":"https://api.docspo.com/project","description":"

Get all existing projects. There are some query params that can be used to define return type but the most useful is that result can be limited, skipped, sorted and filtered.

\n","urlObject":{"path":["project"],"host":["https://api.docspo.com"],"query":[{"disabled":true,"key":"_start","value":"10"},{"disabled":true,"key":"_end","value":"20"},{"disabled":true,"description":{"content":"

Sort on property

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

ASC or DESC

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

To filter projects

\n","type":"text/plain"},"key":"_where","value":"or(status=active,status=completed)"}],"variable":[]}},"response":[],"_postman_id":"b24b438d-2880-4765-b558-3b788fcdcaf2"},{"name":"/project","id":"83bde9b2-e5c5-4fb4-84ea-d534ade67656","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","type":"text","value":""},{"key":"apiKey","type":"text","value":""}],"body":{"mode":"raw","raw":"{\n \"name\": \"My project\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.docspo.com/project","description":"

Create a new project.\nThis route is optional as if you create a new document without specifying projectId a new project would automatically be created.

\n","urlObject":{"path":["project"],"host":["https://api.docspo.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"83bde9b2-e5c5-4fb4-84ea-d534ade67656"},{"name":"/project/:id","id":"104ab1b1-78a4-42c9-9b74-5cdc51e7ff27","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","type":"text","value":""},{"key":"apiKey","type":"text","value":""}],"url":"https://api.docspo.com/project/:id","description":"

View one project by id

\n","urlObject":{"path":["project",":id"],"host":["https://api.docspo.com"],"query":[],"variable":[{"id":"8698a394-141c-4e67-9c8b-276b34de1b6a","description":{"content":"

Required

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"104ab1b1-78a4-42c9-9b74-5cdc51e7ff27"},{"name":"/project/:id","id":"c638b244-6cef-4699-82cc-34c9748092bb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","value":"","type":"text"},{"key":"apiKey","value":"","type":"text"}],"body":{"mode":"raw","raw":"{\n \"status\": \"completed\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.docspo.com/project/:id","description":"

Update a project by id

\n","urlObject":{"path":["project",":id"],"host":["https://api.docspo.com"],"query":[],"variable":[{"id":"893b573e-b62e-4289-a7e9-5c1ab7988e22","description":{"content":"

Required

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"c638b244-6cef-4699-82cc-34c9748092bb"},{"name":"/project/:id","id":"64419941-1472-427a-8c2a-1c8372a98ae7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","type":"text","value":""},{"key":"apiKey","type":"text","value":""}],"url":"https://api.docspo.com/project/:id","description":"

Delete a project by id. If you wish to be able to view \"old\" projects a different approach is to set the project status as archived.

\n","urlObject":{"path":["project",":id"],"host":["https://api.docspo.com"],"query":[],"variable":[{"id":"9aaedd20-bae5-4ddb-9fe0-77ac4184937f","description":{"content":"

Required

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"64419941-1472-427a-8c2a-1c8372a98ae7"},{"name":"/project/:id","id":"e9ad0015-2327-4d9d-a223-ffacd24ea554","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Authorization","type":"text","value":""},{"key":"apiKey","type":"text","value":""}],"url":"https://api.docspo.com/project/:id","description":"

Restore a deleted project so it again can be used.\nNote that any documents that belongs to this project might be patched as well, and any overdue reminders could automatically be sent.

\n","urlObject":{"path":["project",":id"],"host":["https://api.docspo.com"],"query":[],"variable":[{"id":"f4d262b1-f62f-44f9-befe-157c8c9b0fdc","description":{"content":"

Required

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"e9ad0015-2327-4d9d-a223-ffacd24ea554"}],"id":"077d2a4b-810a-4b72-8efc-a6785cd76f8d","description":"

A project is used to hold resources. A project normally contains one document but it can hold multiple documents if the client requested another document. The documents belonging to a project is recommended to have the same client.

If a project is deleted the associated documents are also considered deleted.

\n","event":[{"listen":"prerequest","script":{"id":"e033160a-c1cb-43bf-933b-8e575623e862","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"6a599259-11de-4bfd-b342-c797368ff9f5","type":"text/javascript","exec":[""]}}],"_postman_id":"077d2a4b-810a-4b72-8efc-a6785cd76f8d"},{"name":"WebhookSubscription","item":[{"name":"/webhookSubscription","id":"00d6a109-1d1e-4e22-b01b-6592c4bc860f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"","type":"text"},{"key":"apiKey","value":"","type":"text"}],"url":"https://api.docspo.com/webhookSubscription","description":"

Get all webhook subscriptions.

\n","urlObject":{"path":["webhookSubscription"],"host":["https://api.docspo.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"00d6a109-1d1e-4e22-b01b-6592c4bc860f"},{"name":"/webhookSubscription","id":"8c7e34fb-d647-4083-b01b-3c14dd19e761","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":""},{"key":"apiKey","value":"","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"type\": \"document.created\",\n\t\"isActive\": true,\n\t\"url\": \"\"\n}"},"url":"https://api.docspo.com/webhookSubscription/","description":"

Create a new webhook subscription.

\n","urlObject":{"path":["webhookSubscription",""],"host":["https://api.docspo.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"8c7e34fb-d647-4083-b01b-3c14dd19e761"},{"name":"/webhookSubscription/:id","id":"91b4da34-0ab3-4134-bd35-850cfe99aa0b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"","type":"text"},{"key":"apiKey","value":"","type":"text"}],"url":"https://api.docspo.com/webhookSubscription/:id","description":"

Get one webhook subscription by id

\n","urlObject":{"path":["webhookSubscription",":id"],"host":["https://api.docspo.com"],"query":[],"variable":[{"id":"f519eb6b-cadb-4654-93d1-ade025451ce8","description":{"content":"

Required

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"91b4da34-0ab3-4134-bd35-850cfe99aa0b"},{"name":"/webhookSubscription/:id","id":"73925d55-d591-4fa1-b82f-62666cca29fb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","value":"","type":"text"},{"key":"apiKey","value":"","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"type\": \"document.updated\"\n}"},"url":"https://api.docspo.com/webhookSubscription/:id","description":"

Update one webhook subscription by id

\n","urlObject":{"path":["webhookSubscription",":id"],"host":["https://api.docspo.com"],"query":[],"variable":[{"id":"3eeb6faa-e330-4fe3-a56f-d47982f29911","description":{"content":"

Required

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"73925d55-d591-4fa1-b82f-62666cca29fb"},{"name":"/webhookSubscription/:id","id":"3ad07320-2d6f-4ff2-85cb-be7412c94b45","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"","type":"text"},{"key":"apiKey","value":"","type":"text"}],"url":"https://api.docspo.com/webhookSubscription/:id","description":"

Delete one webhook subscription by id

\n","urlObject":{"path":["webhookSubscription",":id"],"host":["https://api.docspo.com"],"query":[],"variable":[{"id":"24f18090-9f38-4b1d-9603-c8c0463ef73b","description":{"content":"

Required

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"3ad07320-2d6f-4ff2-85cb-be7412c94b45"},{"name":"/webhookSubscription/:id","id":"a8cebb30-14f1-4c86-b804-45f0c46d8331","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Authorization","value":"","type":"text"},{"key":"apiKey","value":"","type":"text"}],"url":"https://api.docspo.com/webhookSubscription/:id","description":"

Patch one webhook subscription by id

\n","urlObject":{"path":["webhookSubscription",":id"],"host":["https://api.docspo.com"],"query":[],"variable":[{"id":"01299906-e0a2-4c76-b5ee-ae41e09d7c78","description":{"content":"

Required

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"a8cebb30-14f1-4c86-b804-45f0c46d8331"}],"id":"5e708e31-2ef3-47aa-bbb4-ef7eef3b4e78","description":"

This endpoint allows you to manage webhook subscriptions. This makes it possible to send a webhook to an external URL when a specific event occurs. The supported types of webhook subscriptions are:

document.created
document.sent
document.viewed
document.accepted
document.acceptedPdf
document.denied

When a webhook is triggered we send a POST to the specified url, if the response is anything but a valid http status code the webhook is retried up to five times with a exponential backoff: 0, 30s, 90s, 210s, 450s...

\n","event":[{"listen":"prerequest","script":{"id":"16537274-c098-4977-b541-838cf3201cba","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"f77ffb1f-634b-4b9d-a356-570dbb86649c","type":"text/javascript","exec":[""]}}],"_postman_id":"5e708e31-2ef3-47aa-bbb4-ef7eef3b4e78"},{"name":"/health","id":"c360a45d-c3a6-488c-a6d4-6336cdc2813b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.docspo.com/health","description":"

Get the health status of the API to know if the API is up and running. Returns status 200 if OK, and 500 if there for any reasons would be any current problems.

\n","urlObject":{"path":["health"],"host":["https://api.docspo.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"c360a45d-c3a6-488c-a6d4-6336cdc2813b"}],"event":[{"listen":"prerequest","script":{"id":"bd05109c-8bdd-4335-8664-79a2824cf987","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"f9a97274-75f4-44db-a501-15b3d2ab6918","type":"text/javascript","exec":[""]}}],"variable":[{"key":"apiKey","value":""},{"key":"companyUserToken","value":""},{"key":"baseUrl","value":"https://api.docspo.com"},{"key":"appUrl","value":"https://app.docspo.com"}]}