{"docsConfig":{"theme":"willow","$schema":"https://mintlify.com/docs.json","name":"Enso Docs","colors":{"primary":"#0074BA","light":"#0074BA","dark":"#0074BA"},"logo":{"light":"https://mintcdn.com/enso-73586f89/gP3zEwNaDWBW6Qg6/logo/logo-light.png?fit=max\u0026auto=format\u0026n=gP3zEwNaDWBW6Qg6\u0026q=85\u0026s=620c67b412b16de03ee6476a33ac499a","dark":"https://mintcdn.com/enso-73586f89/gP3zEwNaDWBW6Qg6/logo/logo-dark.avif?fit=max\u0026auto=format\u0026n=gP3zEwNaDWBW6Qg6\u0026q=85\u0026s=f10cb98cefe49460719e86d61981bee9"},"favicon":{"light":"https://mintcdn.com/enso-73586f89/gP3zEwNaDWBW6Qg6/favicon-light.png?fit=max\u0026auto=format\u0026n=gP3zEwNaDWBW6Qg6\u0026q=85\u0026s=d336e929ec398ab1d80e9bbff6dcb12a","dark":"https://mintcdn.com/enso-73586f89/gP3zEwNaDWBW6Qg6/favicon-dark.png?fit=max\u0026auto=format\u0026n=gP3zEwNaDWBW6Qg6\u0026q=85\u0026s=2efb5a3c137f8f35334eed16c0203d20"},"navbar":{"links":[{"href":"mailto:support@getenso.ai","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.getenso.ai"}},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/getenso"}},"styling":{"latex":true},"navigation":{"global":{"anchors":[{"anchor":"Website","icon":"link","href":"https://getenso.ai"},{"anchor":"Postman collection","icon":"code","href":"/api-reference/openapi.json"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"enso-73586f89","hasAudioNarration":false,"actualSubdomain":"enso-73586f89","customDomains":["docs.getenso.ai"],"gitSource":{"type":"github","owner":"getensoai","repo":"enso-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6aa139641ecc9c143d18e0f6","clientVersion":"0.0.4111","searchFilterCounts":[{"language":"default","tag":"API Reference","count":206},{"language":"default","tag":"Invoices","count":21},{"language":"default","tag":"Guides","count":19},{"language":"default","tag":"Contracts","count":18},{"language":"default","tag":"Entities","count":16},{"language":"default","tag":"Events","count":10},{"language":"default","tag":"Metering","count":10},{"language":"default","tag":"Billing","count":9},{"language":"default","tag":"Catalog","count":9},{"language":"default","tag":"Apps","count":8}]},"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":"llms-txt-v2","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}],"googleFontsInlined":true},"customCss":[],"page":{"pagePath":"api-reference/introduction","slug":"/api-reference/introduction","pageMetadata":{"title":"Getting started","description":"Welcome to the Enso API guidelines. These best practices ensure your integration is secure, consistent, and easy to maintain.","href":"/api-reference/introduction"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Welcome to the Enso API guidelines. These best practices ensure your integration is secure, consistent, and easy to maintain.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"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={a:`a`,code:`code`,li:`li`,ol:`ol`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,..._provideComponents(),...props.components},{CodeBlock,Heading}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);return _jsxs(_Fragment,{children:[_jsx(Heading,{level:`2`,id:`base-url`,children:`Base URL`}),`\n`,_jsx(_components.p,{children:`All API requests should be made to:`}),`\n`,_jsx(CodeBlock,{numberOfLines:`2`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`https://api.getenso.ai/`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),`\n`,_jsx(Heading,{level:`2`,id:`pre-requisites`,children:`Pre-requisites`}),`\n`,_jsxs(_components.ol,{children:[`\n`,_jsx(_components.li,{children:`You must have an active admin account on Enso`}),`\n`,_jsxs(_components.li,{children:[`You must have valid `,_jsx(_components.a,{href:`https://docs.getenso.ai/api-reference/api-keys`,children:`API keys `}),`to authenticate with Enso`]}),`\n`]}),`\n`,_jsx(Heading,{level:`2`,id:`authentication`,children:_jsx(_components.strong,{children:`Authentication`})}),`\n`,_jsxs(_components.p,{children:[`Enso uses `,_jsx(_components.strong,{children:`JWT-based Bearer Tokens`}),` for API access.`]}),`\n`,_jsx(Heading,{level:`3`,id:`exchange-credentials-for-a-jwt-token`,children:`Exchange Credentials for a JWT Token`}),`\n`,_jsx(_components.p,{children:`To begin using the API, use your client credentials to obtain a short-lived JWT token:`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`2`,language:`http`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`http`,children:_jsxs(_components.code,{language:`http`,numberOfLines:`2`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`POST`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` /auth/system-login`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:`Content-Type`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` application/json`})]}),`\n`]})})}),`\n`,_jsx(_components.p,{children:_jsx(_components.strong,{children:`Request body`})}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`4`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`4`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"clientKey\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"any\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"clientSecret\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"any\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsx(_components.p,{children:_jsx(_components.strong,{children:`Successful Response`})}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`7`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`7`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"status\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"success\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"message\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Success\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"data\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"accessToken\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"eyJhbGciOiJIUzI1NiIsInR5c...\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsx(Heading,{level:`3`,id:`make-an-authenticated-api-call`,children:`Make an authenticated API call`}),`\n`,_jsx(_components.p,{children:`Include the token in the Authorization header:`}),`\n`,_jsx(CodeBlock,{numberOfLines:`2`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Authorization: Bearer \u003cyour-jwt-token>`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})})]})}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":"Getting started","description":"Welcome to the Enso API guidelines. These best practices ensure your integration is secure, consistent, and easy to maintain.","href":"/api-reference/introduction"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Base URL","slug":"base-url","depth":2,"children":[]},{"title":"Pre-requisites","slug":"pre-requisites","depth":2,"children":[]},{"title":"Authentication","slug":"authentication","depth":2,"children":[{"title":"Exchange Credentials for a JWT Token","slug":"exchange-credentials-for-a-jwt-token","depth":3,"children":[]},{"title":"Make an authenticated API call","slug":"make-an-authenticated-api-call","depth":3,"children":[]}]}],"codeExamples":{}},"jsLinks":[],"subdomain":"enso-73586f89","siteName":"Enso Docs","title":"Getting started - Enso Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-02-19T06:52:04.167Z","originalFileLocation":"api-reference/introduction.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;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=\"system\"}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=\"description\" content=\"Welcome to the Enso API guidelines. These best practices ensure your integration is secure, consistent, and easy to maintain.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Enso Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/enso-73586f89/2iAuT5NQGhV8jHJT/_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/enso-73586f89/2iAuT5NQGhV8jHJT/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/enso-73586f89/2iAuT5NQGhV8jHJT/_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/enso-73586f89/2iAuT5NQGhV8jHJT/_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/enso-73586f89/2iAuT5NQGhV8jHJT/_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/enso-73586f89/2iAuT5NQGhV8jHJT/_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/enso-73586f89/2iAuT5NQGhV8jHJT/_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/enso-73586f89/2iAuT5NQGhV8jHJT/_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/enso-73586f89/2iAuT5NQGhV8jHJT/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Getting started - Enso Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Welcome to the Enso API guidelines. These best practices ensure your integration is secure, consistent, and easy to maintain.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Enso Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.getenso.ai/api-reference/introduction\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://enso-73586f89.mintlify.site/_mintlify/api/og/v2?division=API+Documentation\u0026amp;title=Getting+started\u0026amp;description=Welcome+to+the+Enso+API+guidelines.+These+best+practices+ensure+your+integration+is+secure%2C+consistent%2C+and+easy+to+maintain.\u0026amp;theme=6ee6009ae078ee7cfd7244a3\u0026amp;signature=2c067062144991fa184d4c4d11693e1fbbab163226361664206624c77e97d0fd\">\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=\"Getting started - Enso Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Welcome to the Enso API guidelines. These best practices ensure your integration is secure, consistent, and easy to maintain.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://enso-73586f89.mintlify.site/_mintlify/api/og/v2?division=API+Documentation\u0026amp;title=Getting+started\u0026amp;description=Welcome+to+the+Enso+API+guidelines.+These+best+practices+ensure+your+integration+is+secure%2C+consistent%2C+and+easy+to+maintain.\u0026amp;theme=6ee6009ae078ee7cfd7244a3\u0026amp;signature=2c067062144991fa184d4c4d11693e1fbbab163226361664206624c77e97d0fd\">\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/enso-73586f89/2iAuT5NQGhV8jHJT/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Enso Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0074BA\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.getenso.ai/api-reference/introduction\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/introduction.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.getenso.ai/#organization\",\"name\":\"Enso Docs\",\"url\":\"https://docs.getenso.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/enso-73586f89/gP3zEwNaDWBW6Qg6/logo/logo-light.png?fit=max\u0026auto=format\u0026n=gP3zEwNaDWBW6Qg6\u0026q=85\u0026s=620c67b412b16de03ee6476a33ac499a\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.getenso.ai#website\",\"name\":\"Enso Docs\",\"url\":\"https://docs.getenso.ai\",\"publisher\":{\"@id\":\"https://docs.getenso.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.getenso.ai/api-reference/introduction#webpage\",\"url\":\"https://docs.getenso.ai/api-reference/introduction\",\"name\":\"Getting started\",\"description\":\"Welcome to the Enso API guidelines. These best practices ensure your integration is secure, consistent, and easy to maintain.\",\"dateModified\":\"2026-02-19T06:52:04.167Z\",\"isPartOf\":{\"@id\":\"https://docs.getenso.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.getenso.ai/api-reference/introduction#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.getenso.ai/api-reference/introduction#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Enso Docs\",\"item\":\"https://docs.getenso.ai\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Getting started\",\"item\":\"https://docs.getenso.ai/api-reference/introduction\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.getenso.ai/api-reference/introduction#article\",\"headline\":\"Getting started\",\"name\":\"Getting started\",\"description\":\"Welcome to the Enso API guidelines. These best practices ensure your integration is secure, consistent, and easy to maintain.\",\"url\":\"https://docs.getenso.ai/api-reference/introduction\",\"mainEntityOfPage\":{\"@id\":\"https://docs.getenso.ai/api-reference/introduction#webpage\"},\"dateModified\":\"2026-02-19T06:52:04.167Z\",\"publisher\":{\"@id\":\"https://docs.getenso.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.getenso.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Enso Docs\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Enso Docs\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/introduction.md","siteName":"Enso Docs","nav":{"global":{"anchors":[{"anchor":"Website","icon":"link","href":"https://getenso.ai"},{"anchor":"Postman collection","icon":"code","href":"/api-reference/openapi.json"}]},"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":""}]},{"tab":"API Reference","groups":[{"group":"API Documentation","pages":[{"title":"Getting started","href":"/api-reference/introduction"},{"title":"API Keys","description":"To access the Enso API, you must first generate an API Token from the Enso dashboard. This token will allow you to authenticate your requests securely.","href":"/api-reference/api-keys"},{"title":"System User Permissions","href":"/api-reference/system-user-permissions"}]},{"group":"Authentication","pages":[{"title":"Login with email/password","openapi":"post /auth/login","href":"/api-reference/endpoint/post-auth-login"},{"title":"Get callback","openapi":"get /auth/callback","href":"/api-reference/endpoint/get-auth-callback"},{"title":"Get type","openapi":"get /auth/callback/{type}","href":"/api-reference/endpoint/get-auth-callback-type"},{"title":"Refresh an existing JWT access token before it expires","openapi":"post /auth/refresh","href":"/api-reference/endpoint/post-auth-refresh"},{"title":"Exchange client credentials for a JWT access token. This is the entry-point for","openapi":"post /auth/system-login","href":"/api-reference/endpoint/post-auth-system-login"}]},{"group":"Users","pages":[{"title":"API to get current user","openapi":"get /me","href":"/api-reference/endpoint/get-me"},{"title":"Get my policies","openapi":"get /policies","href":"/api-reference/endpoint/get-policies"},{"title":"List roles","openapi":"get /roles","href":"/api-reference/endpoint/get-roles"},{"title":"List users","openapi":"get /users","href":"/api-reference/endpoint/get-users"},{"title":"Create user","openapi":"post /users","href":"/api-reference/endpoint/post-users"},{"title":"Create system user","openapi":"post /users/system","href":"/api-reference/endpoint/post-users-system"},{"title":"Update user","openapi":"put /users/{id}","href":"/api-reference/endpoint/put-users-id"}]},{"group":"Entities","pages":[{"title":"List entities","openapi":"get /entities","href":"/api-reference/endpoint/get-entities"},{"title":"API to get entities by type","openapi":"get /entities/all","href":"/api-reference/endpoint/get-entities-all"},{"title":"Get entity by ID","openapi":"get /entities/{id}","href":"/api-reference/endpoint/get-entities-id"},{"title":"List entity addresses","openapi":"get /entities/{id}/addresses","href":"/api-reference/endpoint/get-entities-id-addresses"},{"title":"List entity taxes","openapi":"get /entities/{id}/taxes","href":"/api-reference/endpoint/get-entities-id-taxes"},{"title":"API to get entities by type with filters","openapi":"get /entities/list","href":"/api-reference/endpoint/get-entities-list"},{"title":"API to create an entity","openapi":"post /customers/{customerId}/entities","href":"/api-reference/endpoint/post-customers-customerid-entities"},{"title":"Create entities","openapi":"post /entities","href":"/api-reference/endpoint/post-entities"},{"title":"Create entity address","openapi":"post /entities/{id}/addresses","href":"/api-reference/endpoint/post-entities-id-addresses"},{"title":"Create entity taxes","openapi":"post /entities/{id}/taxes","href":"/api-reference/endpoint/post-entities-id-taxes"},{"title":"Update entity","openapi":"put /entities/{id}","href":"/api-reference/endpoint/put-entities-id"},{"title":"Update entity address","openapi":"put /entities/{id}/addresses/{addressId}","href":"/api-reference/endpoint/put-entities-id-addresses-addressid"},{"title":"Update entity tax","openapi":"put /entities/{id}/taxes/{taxId}","href":"/api-reference/endpoint/put-entities-id-taxes-taxid"},{"title":"API to delete an entity","openapi":"delete /entities/{id}","href":"/api-reference/endpoint/delete-entities-id"},{"title":"Delete entity address","openapi":"delete /entities/{id}/addresses/{addressId}","href":"/api-reference/endpoint/delete-entities-id-addresses-addressid"},{"title":"Delete entity tax","openapi":"delete /entities/{id}/taxes/{taxId}","href":"/api-reference/endpoint/delete-entities-id-taxes-taxid"}]},{"group":"Customers","pages":[{"title":"Get customers","openapi":"get /customers","href":"/api-reference/endpoint/get-customers"},{"title":"Create customers","openapi":"post /customers","href":"/api-reference/endpoint/post-customers"},{"title":"Update customer","openapi":"put /customers/{customerId}","href":"/api-reference/endpoint/put-customers-customerid"},{"title":"API to delete a customer","openapi":"delete /customers/{customerId}","href":"/api-reference/endpoint/delete-customers-customerid"}]},{"group":"Contact Groups","pages":[{"title":"List contact groups","openapi":"get /contact-groups","href":"/api-reference/endpoint/get-contact-groups"},{"title":"Resolve the effective contact for a target","openapi":"get /contact-groups/resolve","href":"/api-reference/endpoint/get-contact-groups-resolve"},{"title":"Create a contact group","openapi":"post /contact-groups","href":"/api-reference/endpoint/post-contact-groups"},{"title":"Update a contact group","openapi":"put /contact-groups/{id}","href":"/api-reference/endpoint/put-contact-groups-id"},{"title":"Delete a contact group","openapi":"delete /contact-groups/{id}","href":"/api-reference/endpoint/delete-contact-groups-id"},{"title":"Attach a contact group to a target","openapi":"post /contact-groups/{id}/attach","href":"/api-reference/endpoint/post-contact-groups-id-attach"},{"title":"Detach a contact group from a target","openapi":"delete /contact-groups/mappings/{mappingId}","href":"/api-reference/endpoint/delete-contact-groups-mappings-mappingid"}]},{"group":"Catalog","pages":[{"title":"List SKU groups","openapi":"get /catalog/groups","href":"/api-reference/endpoint/get-catalog-groups"},{"title":"API to get skus","openapi":"get /catalog/skus","href":"/api-reference/endpoint/get-catalog-skus"},{"title":"API to get a sku by id","openapi":"get /catalog/skus/{skuId}","href":"/api-reference/endpoint/get-catalog-skus-skuid"},{"title":"Create SKU group","openapi":"post /catalog/groups","href":"/api-reference/endpoint/post-catalog-groups"},{"title":"API to create a sku","openapi":"post /catalog/skus","href":"/api-reference/endpoint/post-catalog-skus"},{"title":"Update SKU group","openapi":"put /catalog/groups/{id}","href":"/api-reference/endpoint/put-catalog-groups-id"},{"title":"API to update a sku","openapi":"put /catalog/skus/{skuId}","href":"/api-reference/endpoint/put-catalog-skus-skuid"},{"title":"Delete SKU group","openapi":"delete /catalog/groups/{id}","href":"/api-reference/endpoint/delete-catalog-groups-id"},{"title":"Delete SKU","openapi":"delete /catalog/skus/{skuId}","href":"/api-reference/endpoint/delete-catalog-skus-skuid"}]},{"group":"Billing","pages":[{"title":"Get plan item config schema","openapi":"get /billing/items-config","href":"/api-reference/endpoint/get-billing-items-config"},{"title":"List plan types","openapi":"get /billing/plan-types","href":"/api-reference/endpoint/get-billing-plan-types"},{"title":"List billing plans","openapi":"get /billing/plans","href":"/api-reference/endpoint/get-billing-plans"},{"title":"List plan items","openapi":"get /billing/plans/{planId}/items","href":"/api-reference/endpoint/get-billing-plans-planid-items"},{"title":"Create billing plan","openapi":"post /billing/plans","href":"/api-reference/endpoint/post-billing-plans"},{"title":"API to create a billing plan item","openapi":"post /billing/plans/{planId}/items","href":"/api-reference/endpoint/post-billing-plans-planid-items"},{"title":"Update billing plan","openapi":"put /billing/plans/{id}","href":"/api-reference/endpoint/put-billing-plans-id"},{"title":"Delete billing plan","openapi":"delete /billing/plans/{id}","href":"/api-reference/endpoint/delete-billing-plans-id"},{"title":"API to delete a billing plan item","openapi":"delete /billing/plans/{planId}/items/{id}","href":"/api-reference/endpoint/delete-billing-plans-planid-items-id"}]},{"group":"Contracts","pages":[{"title":"Get contracts","openapi":"get /contracts","href":"/api-reference/endpoint/get-contracts"},{"title":"List contract milestones","openapi":"get /contracts/{contractId}/milestones","href":"/api-reference/endpoint/get-contracts-contractid-milestones"},{"title":"List contract plans","openapi":"get /contracts/{contractId}/plans","href":"/api-reference/endpoint/get-contracts-contractid-plans"},{"title":"Get id","openapi":"get /contracts/{id}","href":"/api-reference/endpoint/get-contracts-id"},{"title":"Create contract milestone","openapi":"post /contracts/{contractId}/milestones","href":"/api-reference/endpoint/post-contracts-contractid-milestones"},{"title":"Add plan to contract","openapi":"post /contracts/{contractId}/plans","href":"/api-reference/endpoint/post-contracts-contractid-plans"},{"title":"Generate invoices for contract plan","openapi":"post /contracts/{contractId}/plans/{contractPlanId}/invoices","href":"/api-reference/endpoint/post-contracts-contractid-plans-contractplanid-invoices"},{"title":"Create milestones","openapi":"post /contracts/{contractId}/plans/{contractPlanId}/milestones","href":"/api-reference/endpoint/post-contracts-contractid-plans-contractplanid-milestones"},{"title":"Add taxes to contract","openapi":"post /contracts/{contractId}/taxes","href":"/api-reference/endpoint/post-contracts-contractid-taxes"},{"title":"Import contract (single)","openapi":"post /contracts/import","href":"/api-reference/endpoint/post-contracts-import"},{"title":"Import contracts (bulk)","openapi":"post /contracts/import/bulk","href":"/api-reference/endpoint/post-contracts-import-bulk"},{"title":"Update contract plan","openapi":"put /contracts/{contractId}/plans/{contractPlanId}","href":"/api-reference/endpoint/put-contracts-contractid-plans-contractplanid"},{"title":"Change contract plan","openapi":"put /contracts/{contractId}/plans/{contractPlanId}/change","href":"/api-reference/endpoint/put-contracts-contractid-plans-contractplanid-change"},{"title":"Update contract tax","openapi":"put /contracts/{contractId}/taxes/{contractTaxId}","href":"/api-reference/endpoint/put-contracts-contractid-taxes-contracttaxid"},{"title":"Update contract","openapi":"put /contracts/{id}","href":"/api-reference/endpoint/put-contracts-id"},{"title":"Delete contractPlanId","openapi":"delete /contracts/{contractId}/plans/{contractPlanId}","href":"/api-reference/endpoint/delete-contracts-contractid-plans-contractplanid"},{"title":"Delete contractPlanItemMilestoneId","openapi":"delete /contracts/{contractId}/plans/{contractPlanId}/milestones/{contractPlanItemMilestoneId}","href":"/api-reference/endpoint/delete-contracts-contractid-plans-contractplanid-milestones-contractplanitemmilestoneid"},{"title":"Remove contract tax","openapi":"delete /contracts/{contractId}/taxes/{contractTaxId}","href":"/api-reference/endpoint/delete-contracts-contractid-taxes-contracttaxid"}]},{"group":"Invoices","pages":[{"title":"Get invoices","openapi":"get /invoices","href":"/api-reference/endpoint/get-invoices"},{"title":"List invoice payments","openapi":"get /invoices/{id}/payments","href":"/api-reference/endpoint/get-invoices-id-payments"},{"title":"API to get invoice details by ID","openapi":"get /invoices/{invoiceId}","href":"/api-reference/endpoint/get-invoices-invoiceid"},{"title":"List invoice templates","openapi":"get /invoices/templates","href":"/api-reference/endpoint/get-invoices-templates"},{"title":"Create invoices","openapi":"post /invoices","href":"/api-reference/endpoint/post-invoices"},{"title":"API to create a batch of invoices","openapi":"post /invoices/batch","href":"/api-reference/endpoint/post-invoices-batch"},{"title":"Record payment","openapi":"post /invoices/{id}/payments","href":"/api-reference/endpoint/post-invoices-id-payments"},{"title":"Upload invoice document","openapi":"post /invoices/{invoiceId}/document","href":"/api-reference/endpoint/post-invoices-invoiceid-document"},{"title":"API to create invoice item","openapi":"post /invoices/{invoiceId}/items","href":"/api-reference/endpoint/post-invoices-invoiceid-items"},{"title":"API to update invoice status and dates","openapi":"post /invoices/{invoiceId}/pdf","href":"/api-reference/endpoint/post-invoices-invoiceid-pdf"},{"title":"Sync invoice revenue","openapi":"post /invoices/{invoiceId}/revenue/sync","href":"/api-reference/endpoint/post-invoices-invoiceid-revenue-sync"},{"title":"API to sync an invoice with usage data","openapi":"post /invoices/{invoiceId}/sync","href":"/api-reference/endpoint/post-invoices-invoiceid-sync"},{"title":"Create invoice template","openapi":"post /invoices/templates","href":"/api-reference/endpoint/post-invoices-templates"},{"title":"Update payment","openapi":"put /invoices/{id}/payments/{paymentId}","href":"/api-reference/endpoint/put-invoices-id-payments-paymentid"},{"title":"Update invoice","openapi":"put /invoices/{invoiceId}","href":"/api-reference/endpoint/put-invoices-invoiceid"},{"title":"API to update invoice item","openapi":"put /invoices/{invoiceId}/items/{itemId}","href":"/api-reference/endpoint/put-invoices-invoiceid-items-itemid"},{"title":"Update invoice template","openapi":"put /invoices/templates/{id}","href":"/api-reference/endpoint/put-invoices-templates-id"},{"title":"Delete payment","openapi":"delete /invoices/{id}/payments/{paymentId}","href":"/api-reference/endpoint/delete-invoices-id-payments-paymentid"},{"title":"Delete payment file","openapi":"delete /invoices/{id}/payments/{paymentId}/files/{fileId}","href":"/api-reference/endpoint/delete-invoices-id-payments-paymentid-files-fileid"},{"title":"Delete invoice file","openapi":"delete /invoices/{invoiceId}/files/{fileId}","href":"/api-reference/endpoint/delete-invoices-invoiceid-files-fileid"},{"title":"Delete invoice template","openapi":"delete /invoices/templates/{id}","href":"/api-reference/endpoint/delete-invoices-templates-id"}]},{"group":"Revenue","pages":[{"title":"Get revenue","openapi":"get /revenue","href":"/api-reference/endpoint/get-revenue"},{"title":"Get revenue by invoice item","openapi":"get /revenue/{invoiceItemId}","href":"/api-reference/endpoint/get-revenue-invoiceitemid"},{"title":"Create revenue","openapi":"post /revenue","href":"/api-reference/endpoint/post-revenue"},{"title":"Edit or delete revenue","href":"/api-reference/endpoint/revenue-edit-delete"}]},{"group":"Payments","pages":[{"title":"List payment sources","openapi":"get /payment-sources","href":"/api-reference/endpoint/get-payment-sources"},{"title":"List all payments","openapi":"get /payments","href":"/api-reference/endpoint/get-payments"},{"title":"Create payment source","openapi":"post /payment-sources","href":"/api-reference/endpoint/post-payment-sources"},{"title":"Update payment source","openapi":"put /payment-sources/{id}","href":"/api-reference/endpoint/put-payment-sources-id"},{"title":"Delete payment source","openapi":"delete /payment-sources/{id}","href":"/api-reference/endpoint/delete-payment-sources-id"}]},{"group":"Metering","pages":[{"title":"Get meters","openapi":"get /meters","href":"/api-reference/endpoint/get-meters"},{"title":"Get usage","openapi":"get /usage","href":"/api-reference/endpoint/get-usage"},{"title":"Create meters","openapi":"post /meters","href":"/api-reference/endpoint/post-meters"},{"title":"API to create usage by meter","openapi":"post /meters/{id}/usage","href":"/api-reference/endpoint/post-meters-id-usage"},{"title":"API to sync usage for all meters in the current organisation","openapi":"post /meters/sync-all","href":"/api-reference/endpoint/post-meters-sync-all"},{"title":"Create usage","openapi":"post /usage","href":"/api-reference/endpoint/post-usage"},{"title":"Update meter","openapi":"put /meters/{id}","href":"/api-reference/endpoint/put-meters-id"},{"title":"Update usage by id","openapi":"put /usage/{id}","href":"/api-reference/endpoint/put-usage-id"},{"title":"Delete meter","openapi":"delete /meters/{id}","href":"/api-reference/endpoint/delete-meters-id"},{"title":"Delete usage by id","openapi":"delete /usage/{id}","href":"/api-reference/endpoint/delete-usage-id"}]},{"group":"Events","pages":[{"title":"Get events","openapi":"get /events","href":"/api-reference/endpoint/get-events"},{"title":"List event configs","openapi":"get /events/config","href":"/api-reference/endpoint/get-events-config"},{"title":"Create events","openapi":"post /events","href":"/api-reference/endpoint/post-events"},{"title":"Create batch","openapi":"post /events/batch","href":"/api-reference/endpoint/post-events-batch"},{"title":"Create remove duplicates","openapi":"post /events/remove-duplicates","href":"/api-reference/endpoint/post-events-remove-duplicates"},{"title":"Create event config","openapi":"post /events/config","href":"/api-reference/endpoint/post-events-config"},{"title":"Import events (file)","openapi":"post /events/import","href":"/api-reference/endpoint/post-events-import"},{"title":"Update event config","openapi":"put /events/config/{id}","href":"/api-reference/endpoint/put-events-config-id"},{"title":"Delete events","openapi":"delete /events","href":"/api-reference/endpoint/delete-events"},{"title":"Delete event config","openapi":"delete /events/config/{id}","href":"/api-reference/endpoint/delete-events-config-id"}]},{"group":"Jobs","pages":[{"title":"Get jobs","openapi":"get /jobs","href":"/api-reference/endpoint/get-jobs"},{"title":"API to get job details","openapi":"get /jobs/{jobId}","href":"/api-reference/endpoint/get-jobs-jobid"},{"title":"Create job","openapi":"post /jobs","href":"/api-reference/endpoint/post-jobs"},{"title":"API to parse contract details for an existing job","openapi":"post /jobs/{jobId}/parse-contract-details","href":"/api-reference/endpoint/post-jobs-jobid-parse-contract-details"},{"title":"API to retry job","openapi":"post /jobs/{jobId}/retry","href":"/api-reference/endpoint/post-jobs-jobid-retry"},{"title":"Update job","openapi":"put /jobs/{jobId}","href":"/api-reference/endpoint/put-jobs-jobid"},{"title":"API to delete job","openapi":"delete /jobs/{jobId}","href":"/api-reference/endpoint/delete-jobs-jobid"},{"title":"API to delete a specific file attached to a job","openapi":"delete /jobs/{jobId}/files/{fileId}","href":"/api-reference/endpoint/delete-jobs-jobid-files-fileid"}]},{"group":"Schedules","pages":[{"title":"List schedules","openapi":"get /schedules","href":"/api-reference/endpoint/get-schedules"},{"title":"Get schedule","openapi":"get /schedules/{id}","href":"/api-reference/endpoint/get-schedules-id"},{"title":"Create schedule","openapi":"post /schedules","href":"/api-reference/endpoint/post-schedules"},{"title":"Update schedule","openapi":"put /schedules/{id}","href":"/api-reference/endpoint/put-schedules-id"},{"title":"Delete schedule","openapi":"delete /schedules/{id}","href":"/api-reference/endpoint/delete-schedules-id"}]},{"group":"State Machine","pages":[{"title":"Transition object state","openapi":"post /objects/{type}/{id}/transition","href":"/api-reference/endpoint/post-objects-type-id-transition"}]},{"group":"Objects","pages":[{"title":"Poll deferred query","openapi":"get /objects/query/deferred/{requestId}","href":"/api-reference/endpoint/get-objects-query-deferred-requestid"},{"title":"Get objectName","openapi":"get /objects/schema/{objectName}","href":"/api-reference/endpoint/get-objects-schema-objectname"},{"title":"Create query","openapi":"post /objects/query","href":"/api-reference/endpoint/post-objects-query"}]},{"group":"Workflows","pages":[{"title":"List workflows","openapi":"get /workflows","href":"/api-reference/endpoint/get-workflows"},{"title":"List workflow configs (AWS state machines)","openapi":"get /workflows/config/all","href":"/api-reference/endpoint/get-workflows-config-all"},{"title":"Get workflow","openapi":"get /workflows/{id}","href":"/api-reference/endpoint/get-workflows-id"},{"title":"List workflow executions","openapi":"get /workflows/{id}/executions","href":"/api-reference/endpoint/get-workflows-id-executions"},{"title":"Create workflow","openapi":"post /workflows","href":"/api-reference/endpoint/post-workflows"},{"title":"Retry workflow execution","openapi":"post /workflows/executions/{id}","href":"/api-reference/endpoint/post-workflows-executions-id"},{"title":"Update workflow","openapi":"put /workflows/{id}","href":"/api-reference/endpoint/put-workflows-id"},{"title":"Delete workflow","openapi":"delete /workflows/{id}","href":"/api-reference/endpoint/delete-workflows-id"}]},{"group":"FX Rates","pages":[{"title":"Get fx rates","openapi":"get /fx-rates","href":"/api-reference/endpoint/get-fx-rates"},{"title":"Get FX rate","openapi":"get /fx-rates/{id}","href":"/api-reference/endpoint/get-fx-rates-id"},{"title":"Create fx rates","openapi":"post /fx-rates","href":"/api-reference/endpoint/post-fx-rates"},{"title":"API to update an FX rate","openapi":"put /fx-rates/{id}","href":"/api-reference/endpoint/put-fx-rates-id"},{"title":"Delete FX rate","openapi":"delete /fx-rates/{id}","href":"/api-reference/endpoint/delete-fx-rates-id"}]},{"group":"Collections","pages":[{"title":"Get collections","openapi":"get /collections","href":"/api-reference/endpoint/get-collections"}]},{"group":"Apps","pages":[{"title":"Get apps","openapi":"get /apps","href":"/api-reference/endpoint/get-apps"},{"title":"Get credentials","openapi":"get /apps/credentials","href":"/api-reference/endpoint/get-apps-credentials"},{"title":"Get credentials","openapi":"get /apps/{id}/credentials","href":"/api-reference/endpoint/get-apps-id-credentials"},{"title":"Create app","openapi":"post /apps","href":"/api-reference/endpoint/post-apps"},{"title":"Connect app (get OAuth URL)","openapi":"post /apps/{id}/connect","href":"/api-reference/endpoint/post-apps-id-connect"},{"title":"Create app credential","openapi":"post /apps/{id}/credentials","href":"/api-reference/endpoint/post-apps-id-credentials"},{"title":"Update credentialId","openapi":"put /apps/{id}/credentials/{credentialId}","href":"/api-reference/endpoint/put-apps-id-credentials-credentialid"},{"title":"Delete app","openapi":"delete /apps/{id}","href":"/api-reference/endpoint/delete-apps-id"}]},{"group":"Webhooks","pages":[{"title":"List webhooks","openapi":"get /webhooks","href":"/api-reference/endpoint/get-webhooks"},{"title":"Create webhook","openapi":"post /webhooks","href":"/api-reference/endpoint/post-webhooks"}]},{"group":"Attributes","pages":[{"title":"Get attributes","openapi":"get /attributes","href":"/api-reference/endpoint/get-attributes"},{"title":"Create attributes","openapi":"post /attributes","href":"/api-reference/endpoint/post-attributes"},{"title":"Validate required attributes","openapi":"post /attributes/validate-required-attributes","href":"/api-reference/endpoint/post-attributes-validate-required-attributes"},{"title":"API to update an attribute","openapi":"put /attributes/{id}","href":"/api-reference/endpoint/put-attributes-id"},{"title":"API to delete an attribute","openapi":"delete /attributes/{id}","href":"/api-reference/endpoint/delete-attributes-id"}]},{"group":"Filters","pages":[{"title":"List filters","openapi":"get /filters","href":"/api-reference/endpoint/get-filters"},{"title":"Create filter","openapi":"post /filters","href":"/api-reference/endpoint/post-filters"},{"title":"Delete filter","openapi":"delete /filters/{id}","href":"/api-reference/endpoint/delete-filters-id"}]},{"group":"Settings","pages":[{"title":"Get setting schema","openapi":"get /settings/schema/{key}","href":"/api-reference/endpoint/get-settings-schema-key"},{"title":"Create setting","openapi":"post /settings","href":"/api-reference/endpoint/post-settings"},{"title":"Delete setting","openapi":"delete /settings/{id}","href":"/api-reference/endpoint/delete-settings-id"}]},{"group":"Reports","pages":[{"title":"List reconciliation reports","openapi":"get /reports/reconciliation/{model}","href":"/api-reference/endpoint/get-reports-reconciliation-model"},{"title":"Run reconciliation report","openapi":"post /reports/reconciliation/{reportId}/fetch","href":"/api-reference/endpoint/post-reports-reconciliation-reportid-fetch"}]},{"group":"Chatbot","pages":[{"title":"Get chatbot capabilities","openapi":"get /chatbot/capabilities","href":"/api-reference/endpoint/get-chatbot-capabilities"},{"title":"API to chat with the AI assistant","openapi":"post /chatbot/chat","href":"/api-reference/endpoint/post-chatbot-chat"}]},{"group":"Audit","pages":[{"title":"List audit versions","openapi":"get /versions","href":"/api-reference/endpoint/get-versions"}]},{"group":"Email","pages":[{"title":"List email templates","openapi":"get /email/templates","href":"/api-reference/endpoint/get-email-templates"},{"title":"Create email template","openapi":"post /email/templates","href":"/api-reference/endpoint/post-email-templates"},{"title":"Delete email template","openapi":"delete /email/templates/{name}","href":"/api-reference/endpoint/delete-email-templates-name"}]},{"group":"Email templates","pages":[{"title":"Send a test email to verify SMTP settings","openapi":"post /email/test","href":"/api-reference/endpoint/post-email-test"}]},{"group":"FSM (object lifecycle)","pages":[{"title":"API to get state machines","openapi":"get /objects/machines","href":"/api-reference/endpoint/get-objects-machines"},{"title":"API to get all actions for a model","openapi":"get /objects/{type}/{id}/actions","href":"/api-reference/endpoint/get-objects-type-id-actions"},{"title":"API to get all states for a model","openapi":"get /objects/{type}/states","href":"/api-reference/endpoint/get-objects-type-states"},{"title":"API to create a state machine","openapi":"post /objects/machines","href":"/api-reference/endpoint/post-objects-machines"},{"title":"API to get all available actions for multiple model instances","openapi":"post /objects/{type}/actions/bulk","href":"/api-reference/endpoint/post-objects-type-actions-bulk"},{"title":"API to undo the last transition on a model","openapi":"post /objects/{type}/{id}/transition/undo","href":"/api-reference/endpoint/post-objects-type-id-transition-undo"},{"title":"API to enqueue a bulk transition job on multiple model instances","openapi":"post /objects/{type}/transition/bulk","href":"/api-reference/endpoint/post-objects-type-transition-bulk"}]},{"group":"Masters","pages":[{"title":"API to get all currencies","openapi":"get /currencies","href":"/api-reference/endpoint/get-currencies"},{"title":"API to get all countries","openapi":"get /geo/countries","href":"/api-reference/endpoint/get-geo-countries"},{"title":"API to get all states for a country","openapi":"get /geo/countries/{countryId}/states","href":"/api-reference/endpoint/get-geo-countries-countryid-states"},{"title":"List units","openapi":"get /units","href":"/api-reference/endpoint/get-units"}]},{"group":"Organisation attributes","pages":[{"title":"Get model?","openapi":"get /organisation-attributes/{model}?","href":"/api-reference/endpoint/get-organisation-attributes-model"},{"title":"Create organisation attributes","openapi":"post /organisation-attributes","href":"/api-reference/endpoint/post-organisation-attributes"},{"title":"API to update an organisation attribute","openapi":"put /organisation-attributes/{id}","href":"/api-reference/endpoint/put-organisation-attributes-id"},{"title":"API to delete an organisation attribute","openapi":"delete /organisation-attributes/{id}","href":"/api-reference/endpoint/delete-organisation-attributes-id"}]},{"group":"Organisation settings","pages":[{"title":"Get settings","openapi":"get /settings","href":"/api-reference/endpoint/get-settings"},{"title":"Update id","openapi":"put /settings/{id}","href":"/api-reference/endpoint/put-settings-id"}]}]}]},"basePath":"","title":"Getting started - Enso Docs","buildId":"dpl_DqYu5MPb49gWBBbUGgpHQUmCHY3P","deploymentId":"dpl_DqYu5MPb49gWBBbUGgpHQUmCHY3P","dynamics":[],"chunks":[]}