Hi developer,Proposales™ is a web-powered standard to create, send and e-sign proposals & contracts.
The standard is a JSON schema which means 100% structured data at all times.Explore our modern APIs & webhooks, enabling you to build automated workflows and send data to any system.
Explore
Webhooks
Automate your workflow
Entities
Explore data entities
Endpoints
Access your data
{"docsConfig":{"$schema":"https://mintlify.com/docs.json","theme":"mint","name":"Proposales","colors":{"primary":"#000000","light":"#ffffff","dark":"#000000"},"favicon":"https://mintcdn.com/proposalesab/-5otOw2eXOA6LlgK/favicon.png?fit=max\u0026auto=format\u0026n=-5otOw2eXOA6LlgK\u0026q=85\u0026s=408ef645c944c9d8047d2a02c4cdc176","logo":{"light":"https://assets-global.website-files.com/64fa70d89846f59218c2ffad/660f4f0d82b47dda8b055665_logo-without%20trademark.svg","dark":"https://assets-global.website-files.com/64fa70d89846f59218c2ffad/660f4f1aa9f94598aa2bc011_logo-light-without-trademark.svg"},"api":{"openapi":"openapi.json","mdx":{"server":"https://api.proposales.com","auth":{"method":"bearer","name":null}}},"appearance":{"default":"dark","strict":true},"background":{"decoration":null,"color":{"light":"#000000","dark":"#000000"}},"navbar":{"links":[],"primary":{"type":"button","label":"Sign up","href":"https://proposales.com/signup"}},"footer":{"socials":{}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"proposalesab","hasAudioNarration":false,"actualSubdomain":"proposalesab","customDomains":["docs.proposales.com"],"gitSource":{"type":"github","owner":"proposales","repo":"proposales","deployBranch":"develop","contentDirectory":"packages/docs","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6aec8a13f73278e02598da5d","clientVersion":"0.0.4131","searchFilterCounts":[{"language":"default","tag":"API Reference","count":26},{"language":"default","tag":"Documentation","count":11},{"language":"default","tag":"Webhooks","count":9},{"language":"default","tag":"Entities","count":8},{"language":"default","tag":"Content","count":7},{"language":"default","tag":"Proposals","count":7},{"language":"default","tag":"Companies","count":2},{"language":"default","tag":"Get Started","count":2},{"language":"default","tag":"Attachments","count":1},{"language":"default","tag":"API Documentation","count":1}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"introduction","slug":"/introduction","pageMetadata":{"title":"Introduction","description":null,"href":"/introduction"},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={p:`p`,..._provideComponents(),...props.components},{Card,CardGroup,Heading}=_components;if(!Card)_missingMdxReference(`Card`,true);if(!CardGroup)_missingMdxReference(`CardGroup`,true);if(!Heading)_missingMdxReference(`Heading`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`Hi developer,`}),`\n`,_jsx(_components.p,{children:`Proposales™ is a web-powered standard to create, send and e-sign proposals \u0026 contracts.`}),`\n`,_jsx(`div`,{className:`mint-text-center`,children:_jsx(`img`,{className:`mint-inline mint-h-10 mint-w-10`,src:`https://mintcdn.com/proposalesab/-5otOw2eXOA6LlgK/images/hearts.png?fit=max\u0026auto=format\u0026n=-5otOw2eXOA6LlgK\u0026q=85\u0026s=f29c509dba0e5a889690ac8daad0df5b`,alt:`Smiling Face with Heart-Eyes`,noZoom:true,\"data-og-width\":`160`,width:`160`,\"data-og-height\":`160`,height:`160`,\"data-path\":`images/hearts.png`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/proposalesab/-5otOw2eXOA6LlgK/images/hearts.png?w=280\u0026fit=max\u0026auto=format\u0026n=-5otOw2eXOA6LlgK\u0026q=85\u0026s=cb6882fbda681681ad170960ea52f32e 280w, https://mintcdn.com/proposalesab/-5otOw2eXOA6LlgK/images/hearts.png?w=560\u0026fit=max\u0026auto=format\u0026n=-5otOw2eXOA6LlgK\u0026q=85\u0026s=43bbd943be06ef325950dca47a6ddd35 560w, https://mintcdn.com/proposalesab/-5otOw2eXOA6LlgK/images/hearts.png?w=840\u0026fit=max\u0026auto=format\u0026n=-5otOw2eXOA6LlgK\u0026q=85\u0026s=2d8c5dd979d24c48e3d389d3babf747d 840w, https://mintcdn.com/proposalesab/-5otOw2eXOA6LlgK/images/hearts.png?w=1100\u0026fit=max\u0026auto=format\u0026n=-5otOw2eXOA6LlgK\u0026q=85\u0026s=66af316bcaf783122106a9c1b4b75cfd 1100w, https://mintcdn.com/proposalesab/-5otOw2eXOA6LlgK/images/hearts.png?w=1650\u0026fit=max\u0026auto=format\u0026n=-5otOw2eXOA6LlgK\u0026q=85\u0026s=f237fb7217795f1b021a32e44a753b83 1650w, https://mintcdn.com/proposalesab/-5otOw2eXOA6LlgK/images/hearts.png?w=2500\u0026fit=max\u0026auto=format\u0026n=-5otOw2eXOA6LlgK\u0026q=85\u0026s=a392a56169a500786ca02e8e4080ed49 2500w`})}),`\n`,_jsx(_components.p,{children:`The standard is a JSON schema which means 100% structured data at all times.`}),`\n`,_jsx(_components.p,{children:`Explore our modern APIs \u0026 webhooks, enabling you to build automated workflows and send data to any system.`}),`\n`,_jsx(Heading,{level:`3`,id:`explore`,children:`Explore`}),`\n`,_jsxs(CardGroup,{cols:2,children:[_jsx(Card,{title:`Webhooks`,icon:`webhook`,href:`webhooks`,children:_jsx(_components.p,{children:`Automate your workflow`})}),_jsx(Card,{title:`Entities`,icon:`layer-group`,href:`api-reference/entities/`,children:_jsx(_components.p,{children:`Explore data entities`})}),_jsx(Card,{title:`Endpoints`,icon:`bolt`,href:`api-reference/introduction`,children:_jsx(_components.p,{children:`Access your data`})})]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Introduction","description":null,"href":"/introduction"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Explore","slug":"explore","depth":3,"children":[]}],"codeExamples":{}},"jsLinks":[],"dynamicCss":".mint-inline {\n display: inline\n}\n.mint-h-10 {\n height: 2.5rem\n}\n.mint-w-10 {\n width: 2.5rem\n}\n.mint-text-center {\n text-align: center\n}","subdomain":"proposalesab","siteName":"Proposales","title":"Introduction - Proposales","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-05T13:52:40.480Z","originalFileLocation":"introduction.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=\"dark\";if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"dark\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"application-name\" content=\"Proposales\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/proposalesab/pmwmJJ--lyoSQtMs/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/proposalesab/pmwmJJ--lyoSQtMs/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/proposalesab/pmwmJJ--lyoSQtMs/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/proposalesab/pmwmJJ--lyoSQtMs/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/proposalesab/pmwmJJ--lyoSQtMs/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/proposalesab/pmwmJJ--lyoSQtMs/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/proposalesab/pmwmJJ--lyoSQtMs/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/proposalesab/pmwmJJ--lyoSQtMs/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/proposalesab/pmwmJJ--lyoSQtMs/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Introduction - Proposales\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Proposales\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.proposales.com/introduction\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://proposalesab.mintlify.site/_mintlify/api/og/v2?division=Get+Started\u0026amp;title=Introduction\u0026amp;theme=17929bb6a46c6ea3865b024e\u0026amp;signature=025f5cea8d5f6283c22a263a2ac2647f4182daae3e4548dc3b5f546ed2575c0c\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Introduction - Proposales\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://proposalesab.mintlify.site/_mintlify/api/og/v2?division=Get+Started\u0026amp;title=Introduction\u0026amp;theme=17929bb6a46c6ea3865b024e\u0026amp;signature=025f5cea8d5f6283c22a263a2ac2647f4182daae3e4548dc3b5f546ed2575c0c\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/proposalesab/pmwmJJ--lyoSQtMs/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Proposales\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#000000\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.proposales.com/introduction\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/introduction.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.proposales.com/#organization\",\"name\":\"Proposales\",\"url\":\"https://docs.proposales.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://assets-global.website-files.com/64fa70d89846f59218c2ffad/660f4f0d82b47dda8b055665_logo-without%20trademark.svg\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.proposales.com#website\",\"name\":\"Proposales\",\"url\":\"https://docs.proposales.com\",\"publisher\":{\"@id\":\"https://docs.proposales.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.proposales.com/introduction#webpage\",\"url\":\"https://docs.proposales.com/introduction\",\"name\":\"Introduction\",\"dateModified\":\"2026-11-05T13:52:40.480Z\",\"isPartOf\":{\"@id\":\"https://docs.proposales.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.proposales.com/introduction#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.proposales.com/introduction#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Proposales\",\"item\":\"https://docs.proposales.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Introduction\",\"item\":\"https://docs.proposales.com/introduction\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.proposales.com/introduction#article\",\"headline\":\"Introduction\",\"name\":\"Introduction\",\"url\":\"https://docs.proposales.com/introduction\",\"mainEntityOfPage\":{\"@id\":\"https://docs.proposales.com/introduction#webpage\"},\"dateModified\":\"2026-11-05T13:52:40.480Z\",\"publisher\":{\"@id\":\"https://docs.proposales.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.proposales.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Proposales\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Proposales\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/introduction.md","siteName":"Proposales","nav":{"global":null,"anchors":[{"anchor":"Documentation","icon":"book-open","groups":[{"group":"Get Started","pages":[{"title":"Introduction","href":"/introduction"},{"title":"Integrations","description":"How to build a new integration towards Proposales","href":"/connections"}]},{"group":"Webhooks","pages":[{"title":"Integration Config Schema","href":"/webhooks/integration-config-schema"},{"title":"Content Import","href":"/webhooks/content-import"},{"title":"Content Availability","href":"/webhooks/content-availability"},{"title":"Content Details","href":"/webhooks/content-details"},{"title":"Proposal Status Update","href":"/webhooks/proposal-status-update"},{"title":"Proposal Invoice Update","href":"/webhooks/proposal-invoice-update"},{"title":"Proposal Data Widget","href":"/webhooks/data-widget"},{"title":"Proposal Editor Widget","href":"/webhooks/editor-widget"},{"title":"Recipients Search","href":"/webhooks/recipients-search"}]}]},{"anchor":"API Reference","icon":"square-terminal","pages":[{"title":"API Reference","href":"/api-reference/introduction"}]},{"anchor":"Status","href":"https://status.proposales.com","icon":"signal-bars"},{"anchor":"Help","href":"https://help.proposales.com","icon":"book-open-cover"}]},"basePath":"","title":"Introduction - Proposales","buildId":"dpl_5joLUXmnJgwqjrHAS4dxZrQTdxgh","deploymentId":"dpl_5joLUXmnJgwqjrHAS4dxZrQTdxgh","dynamics":[],"chunks":[]}