We periodically release new, dated versions of the API whenever we make breaking changes. Although we try to only make backward-compatible changes, sometimes we have to make a breaking change to iterate on the API.We consider the following changes backward compatible:
Adding new API endpoints
Adding new optional parameters to existing endpoints
Adding new data elements to existing responses
Adding new errors
Our current version is 2024-01-01The Chart-API-Version header must be set for every single request to our API.
Was this page helpful?
{"docsConfig":{"$schema":"https://mintlify.com/docs.json","theme":"mint","name":"Chart","colors":{"primary":"#293321","light":"#A5EB71","dark":"#679346"},"favicon":"/favicon.svg","logo":{"light":"https://mintcdn.com/chart/5V9iU9vWdtuPCGDj/logo/light.svg?fit=max\u0026auto=format\u0026n=5V9iU9vWdtuPCGDj\u0026q=85\u0026s=238400f728c1bf345d9af806ffab5c92","dark":"https://mintcdn.com/chart/5V9iU9vWdtuPCGDj/logo/dark.svg?fit=max\u0026auto=format\u0026n=5V9iU9vWdtuPCGDj\u0026q=85\u0026s=7db7ca9437accc98232dc83e534bf04f"},"navbar":{"links":[{"label":"Sign Up","href":"https://auth.trychart.com/sign-up"}],"primary":{"type":"button","label":"Sign In","href":"https://auth.trychart.com"}},"footer":{"socials":{"twitter":"https://twitter.com/try_chart_api","linkedin":"https://www.linkedin.com/company/chart-api","website":"https://trychart.com"}},"navigation":{"global":{"anchors":[{"anchor":"API Status","href":"https://chartapi.statuspage.io","icon":{"name":"signal-bars","style":"solid"}},{"anchor":"Changelog","href":"https://developer.trychart.com/developer/changelog","icon":{"name":"megaphone","style":"solid"}}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"chart","hasAudioNarration":false,"actualSubdomain":"chart","customDomains":["developer.trychart.com"],"gitSource":{"type":"github","owner":"getcharteditor","repo":"chart-docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"feedback":{"thumbs":true},"entitlements":{},"buildId":"6ae91f1aabde022f2c1f0a1f:success","clientVersion":"0.0.4088","searchFilterCounts":[{"language":"default","tag":"API Reference","count":14},{"language":"default","tag":"Documentation","count":13},{"language":"default","tag":"Management","count":5},{"language":"default","tag":"Developer Resources","count":5},{"language":"default","tag":"Implementation Guide","count":5},{"language":"default","tag":"Taxpayer","count":4},{"language":"default","tag":"Connect","count":3},{"language":"default","tag":"How Chart Works","count":3},{"language":"default","tag":"IRS Forms","count":2},{"language":"default","tag":"Records","count":2}]},"assistantConfig":{},"basePath":"","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":"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},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"developer/api-versioning","slug":"/developer/api-versioning","pageMetadata":{"title":"API Versioning","description":null,"href":"/developer/api-versioning"},"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={code:`code`,li:`li`,p:`p`,strong:`strong`,ul:`ul`,..._provideComponents(),...props.components};return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`We periodically release new, dated versions of the API whenever we make breaking changes. Although we try to only make backward-compatible changes, sometimes we have to make a breaking change to iterate on the API.`}),`\n`,_jsx(_components.p,{children:_jsx(_components.strong,{children:`We consider the following changes backward compatible:`})}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Adding new API endpoints`}),`\n`,_jsx(_components.li,{children:`Adding new optional parameters to existing endpoints`}),`\n`,_jsx(_components.li,{children:`Adding new data elements to existing responses`}),`\n`,_jsx(_components.li,{children:`Adding new errors`}),`\n`]}),`\n`,_jsxs(_components.p,{children:[`Our current version is `,_jsx(_components.strong,{children:`2024-01-01`})]}),`\n`,_jsxs(_components.p,{children:[`The `,_jsx(_components.code,{children:`Chart-API-Version`}),` header must be set for every single request to our API.`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"API Versioning","description":null,"href":"/developer/api-versioning"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"subdomain":"chart","siteName":"Chart","title":"API Versioning - Chart","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2025-08-19T23:37:31.076Z","originalFileLocation":"developer/api-versioning.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=\"application-name\" content=\"Chart\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/chart/7tUBHNL5lT6XIZxQ/_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/chart/7tUBHNL5lT6XIZxQ/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/chart/7tUBHNL5lT6XIZxQ/_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/chart/7tUBHNL5lT6XIZxQ/_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/chart/7tUBHNL5lT6XIZxQ/_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/chart/7tUBHNL5lT6XIZxQ/_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/chart/7tUBHNL5lT6XIZxQ/_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/chart/7tUBHNL5lT6XIZxQ/_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/chart/7tUBHNL5lT6XIZxQ/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"API Versioning - Chart\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Chart\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developer.trychart.com/developer/api-versioning\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://chart.mintlify.site/_mintlify/api/og/v2?division=Developer+Resources\u0026amp;title=API+Versioning\u0026amp;theme=47518fbce33870c7ee121925\u0026amp;signature=9bfb8ad8b82db8dbe15561f942d47c4fcd05e3553aa6cce82056810e488daf34\">\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=\"API Versioning - Chart\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://chart.mintlify.site/_mintlify/api/og/v2?division=Developer+Resources\u0026amp;title=API+Versioning\u0026amp;theme=47518fbce33870c7ee121925\u0026amp;signature=9bfb8ad8b82db8dbe15561f942d47c4fcd05e3553aa6cce82056810e488daf34\">\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/chart/7tUBHNL5lT6XIZxQ/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Chart\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#293321\">\u003clink data-mint-head rel=\"canonical\" href=\"https://developer.trychart.com/developer/api-versioning\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/developer/api-versioning.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://developer.trychart.com/#organization\",\"name\":\"Chart\",\"url\":\"https://developer.trychart.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/chart/5V9iU9vWdtuPCGDj/logo/light.svg?fit=max\u0026auto=format\u0026n=5V9iU9vWdtuPCGDj\u0026q=85\u0026s=238400f728c1bf345d9af806ffab5c92\"}},{\"@type\":\"WebSite\",\"@id\":\"https://developer.trychart.com#website\",\"name\":\"Chart\",\"url\":\"https://developer.trychart.com\",\"publisher\":{\"@id\":\"https://developer.trychart.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://developer.trychart.com/developer/api-versioning#webpage\",\"url\":\"https://developer.trychart.com/developer/api-versioning\",\"name\":\"API Versioning\",\"dateModified\":\"2025-08-19T23:37:31.076Z\",\"isPartOf\":{\"@id\":\"https://developer.trychart.com#website\"},\"breadcrumb\":{\"@id\":\"https://developer.trychart.com/developer/api-versioning#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developer.trychart.com/developer/api-versioning#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Chart\",\"item\":\"https://developer.trychart.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"API Versioning\",\"item\":\"https://developer.trychart.com/developer/api-versioning\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://developer.trychart.com/developer/api-versioning#article\",\"headline\":\"API Versioning\",\"name\":\"API Versioning\",\"url\":\"https://developer.trychart.com/developer/api-versioning\",\"mainEntityOfPage\":{\"@id\":\"https://developer.trychart.com/developer/api-versioning#webpage\"},\"dateModified\":\"2025-08-19T23:37:31.076Z\",\"publisher\":{\"@id\":\"https://developer.trychart.com/#organization\"},\"isPartOf\":{\"@id\":\"https://developer.trychart.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Chart\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Chart","nav":{"global":{"anchors":[{"anchor":"API Status","href":"https://chartapi.statuspage.io","icon":{"name":"signal-bars","style":"solid"}},{"anchor":"Changelog","href":"https://developer.trychart.com/developer/changelog","icon":{"name":"megaphone","style":"solid"}}]},"tabs":[{"tab":"Documentation","groups":[{"group":"How Chart Works","pages":[{"title":"Quickstart","href":"/overview/quickstart"},{"title":"What is Chart?","href":"/overview/chart-overview"},{"title":"Connect a Taxpayer","href":"/overview/connect"}]},{"group":"Implementation Guide","pages":[{"title":"Chart API Implementation Guide","href":"/implementation/guide"},{"group":"Connect","pages":[{"title":"Create a Chart Developer Account","href":"/implementation/connect/create-dev-account"},{"title":"Set Up Chart Connect","href":"/implementation/connect/set-up-chart-connect"},{"title":"Retrieve Access Token","href":"/implementation/connect/retrieve-access-token"}]},{"group":"Secure","pages":[{"title":"Store Tokens","description":"Explore our best practices for storing access tokens securely. Chart requires developers to store tokens on the backend server for improved security controls.","href":"/implementation/secure/store"}]}]},{"group":"Developer Resources","pages":[{"title":"API Versioning","href":"/developer/api-versioning"},{"title":"SDKs","description":"Explore our frontend and backend (_coming soon_) SDK repositories.","href":"/developer/sdk"},{"title":"Events","href":"/developer/events"},{"title":"Webhooks","href":"/developer/webhooks"},{"title":"Changelog","href":"/developer/changelog"}]}]},{"tab":"API Reference","pages":[{"title":"API Reference","href":"/api-reference/records/get_all"}]}]},"basePath":"","title":"API Versioning - Chart","buildId":"dpl_DTau1J5HqS9UTgVSDwGksstFWtPa","deploymentId":"dpl_DTau1J5HqS9UTgVSDwGksstFWtPa","dynamics":[],"chunks":[]}