Bad Request — Your request could not be parsed or is invalid.
401
Unauthorized — Your API key is missing or incorrect.
403
Forbidden — The resource requested is hidden for administrators only or doesn’t exist.
404
Not Found — The resource requested does not exist.
429
Too Many Requests — Try again later.
500
Internal Server Error — We had a problem with our server. Try again later or contact support.
502
Bad Gateway — Your request timed out (exceeded 10 seconds).
503
Service Unavailable — We’re temporarily offline for maintenance. Please try again later.
{"docsConfig":{"$schema":"https://mintlify.com/docs.json","theme":"mint","name":"Leafpress API","colors":{"primary":"#36af63","light":"#36af63","dark":"#36af63"},"favicon":"/logo.png","logo":{"light":"https://mintlify.s3-us-west-1.amazonaws.com/leafpress/logo.png","dark":"https://mintlify.s3-us-west-1.amazonaws.com/leafpress/logo.png"},"api":{"mdx":{"server":"https://app.leafpress.io","auth":{"method":"basic","name":null}}},"navbar":{"links":[{"label":"Support","href":"mailto:team@leafpress.io"}],"primary":null},"footer":{"socials":{"x":"https://x.com/mintlify","github":"https://github.com/mintlify","linkedin":"https://www.linkedin.com/company/mintsearch"}},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"leafpress","hasAudioNarration":false,"actualSubdomain":"leafpress","customDomains":["docs.leafpress.io"],"gitSource":{"type":"github","owner":"jiannaliu01","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a20c51112ef21155ee57a06","collectionId":"f2da125d-ef96-45f3-9987-ce28f28f346d","schemaVersion":"v2"},"entitlements":{},"buildId":"6a20c51112ef21155ee57a06:success","clientVersion":"0.0.3965","searchFilterCounts":[{"language":"default","tag":"API Reference","count":14},{"language":"default","tag":"Functionality Endpoints","count":6},{"language":"default","tag":"Data Endpoints","count":4},{"language":"default","tag":"Sync Endpoints","count":2},{"language":"default","tag":"Notification Endpoints","count":1},{"language":"default","tag":"API Documentation","count":1},{"language":"default","tag":"Documentation","count":1},{"language":"default","tag":"Get Started","count":1}]},"assistantConfig":{},"hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","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":"editor-v7-file-tree","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":"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":"pause-universal-search-reconcile","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":"per-site-search-delta","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":"editor-private-page-search","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":"editor-nav-generations","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":"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":"byok-sep-25","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":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","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}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"introduction","slug":"/introduction","pageMetadata":{"title":"Getting Started with Leafpress","description":"This page will help you get started with Leafpress.","href":"/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: \"This page will help you get started with Leafpress.\"\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`,p:`p`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,..._provideComponents(),...props.components},{Heading,Table}=_components;if(!Heading)_missingMdxReference(`Heading`,true);if(!Table)_missingMdxReference(`Table`,true);return _jsxs(_Fragment,{children:[_jsx(Heading,{level:`2`,id:`overview`,children:`Overview`}),`\n`,_jsxs(_components.p,{children:[`Welcome to the Leafpress API guide! Use this guide to query your utility data. Contact `,_jsx(_components.a,{href:`mailto:team@leafpress.io`,children:`team@leafpress.io`}),` to get started.`]}),`\n`,_jsx(Heading,{level:`2`,id:`root-url`,children:`Root URL`}),`\n`,_jsxs(_components.p,{children:[`Leafpress external API’s root URL is `,_jsx(_components.a,{href:`https://api.leafpress.io/`,children:`https://api.leafpress.io/`}),`. Once you have your API keys from the Leafpress team, make your first request!`]}),`\n`,_jsx(Heading,{level:`2`,id:`errors`,children:`Errors`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Status`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`200`}),_jsx(_components.td,{children:`OK: Your request was successful`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`400`}),_jsx(_components.td,{children:`Bad Request — Your request could not be parsed or is invalid.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`401`}),_jsx(_components.td,{children:`Unauthorized — Your API key is missing or incorrect.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`403`}),_jsx(_components.td,{children:`Forbidden — The resource requested is hidden for administrators only or doesn’t exist.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`404`}),_jsx(_components.td,{children:`Not Found — The resource requested does not exist.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`429`}),_jsx(_components.td,{children:`Too Many Requests — Try again later.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`500`}),_jsx(_components.td,{children:`Internal Server Error — We had a problem with our server. Try again later or contact support.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`502`}),_jsx(_components.td,{children:`Bad Gateway — Your request timed out (exceeded 10 seconds).`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:`503`}),_jsx(_components.td,{children:`Service Unavailable — We’re temporarily offline for maintenance. Please try again later.`})]})]})]})]})}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 with Leafpress","description":"This page will help you get started with Leafpress.","href":"/introduction"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Overview","slug":"overview","depth":2,"children":[]},{"title":"Root URL","slug":"root-url","depth":2,"children":[]},{"title":"Errors","slug":"errors","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"leafpress","siteName":"Leafpress API","title":"Getting Started with Leafpress - Leafpress API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"originalFileLocation":"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=\"This page will help you get started with Leafpress.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Leafpress API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/leafpress/_generated/favicon/apple-touch-icon.png?v=3\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/leafpress/_generated/favicon/favicon-32x32.png?v=3\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/leafpress/_generated/favicon/favicon-16x16.png?v=3\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/leafpress/_generated/favicon/favicon.ico?v=3\">\u003cmeta data-mint-head property=\"og:title\" content=\"Getting Started with Leafpress - Leafpress API\">\u003cmeta data-mint-head property=\"og:description\" content=\"This page will help you get started with Leafpress.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Leafpress API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.leafpress.io/introduction\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://leafpress.mintlify.app/_mintlify/api/og/v2?division=Get+Started\u0026amp;title=Getting+Started+with+Leafpress\u0026amp;description=This+page+will+help+you+get+started+with+Leafpress.\u0026amp;theme=585014141eb31b9059dade7c\u0026amp;signature=0805dd0d01968196de07180f651a6b11f50d79995637f310a4ccf190a8906510\">\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 with Leafpress - Leafpress API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"This page will help you get started with Leafpress.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://leafpress.mintlify.app/_mintlify/api/og/v2?division=Get+Started\u0026amp;title=Getting+Started+with+Leafpress\u0026amp;description=This+page+will+help+you+get+started+with+Leafpress.\u0026amp;theme=585014141eb31b9059dade7c\u0026amp;signature=0805dd0d01968196de07180f651a6b11f50d79995637f310a4ccf190a8906510\">\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=\"https://mintlify.s3.us-west-1.amazonaws.com/leafpress/_generated/favicon/browserconfig.xml?v=3\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Leafpress API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#36af63\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.leafpress.io/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.leafpress.io/#organization\",\"name\":\"Leafpress API\",\"url\":\"https://docs.leafpress.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintlify.s3-us-west-1.amazonaws.com/leafpress/logo.png\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.leafpress.io#website\",\"name\":\"Leafpress API\",\"url\":\"https://docs.leafpress.io\",\"publisher\":{\"@id\":\"https://docs.leafpress.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.leafpress.io/introduction#webpage\",\"url\":\"https://docs.leafpress.io/introduction\",\"name\":\"Getting Started with Leafpress\",\"description\":\"This page will help you get started with Leafpress.\",\"isPartOf\":{\"@id\":\"https://docs.leafpress.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.leafpress.io/introduction#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.leafpress.io/introduction#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Leafpress API\",\"item\":\"https://docs.leafpress.io\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Getting Started with Leafpress\",\"item\":\"https://docs.leafpress.io/introduction\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.leafpress.io/introduction#article\",\"headline\":\"Getting Started with Leafpress\",\"name\":\"Getting Started with Leafpress\",\"description\":\"This page will help you get started with Leafpress.\",\"url\":\"https://docs.leafpress.io/introduction\",\"mainEntityOfPage\":{\"@id\":\"https://docs.leafpress.io/introduction#webpage\"},\"publisher\":{\"@id\":\"https://docs.leafpress.io/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.leafpress.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Leafpress API\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Leafpress API","nav":{"global":null,"tabs":[{"tab":"Documentation","groups":[{"group":"Get Started","pages":[{"title":"Getting Started with Leafpress","href":"/introduction"}]}]},{"tab":"API Reference","pages":[{"title":"API Reference","href":"/api-reference/introduction"}]}]},"title":"Getting Started with Leafpress - Leafpress API","buildId":"dpl_849ArpqvBiCczQiT1Y1stNGpbqHT","deploymentId":"dpl_849ArpqvBiCczQiT1Y1stNGpbqHT","dynamics":[],"chunks":[]}
