{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"ErrorGolf Documentation","colors":{"primary":"#16A34A","light":"#07C983","dark":"#15803D"},"logo":{"light":"https://mintcdn.com/errorgolf/NGkNMcphWaf7RK6B/logo/light.png?fit=max\u0026auto=format\u0026n=NGkNMcphWaf7RK6B\u0026q=85\u0026s=f6e0c9a0d3570e0074155829ad78c83b","dark":"https://mintcdn.com/errorgolf/NGkNMcphWaf7RK6B/logo/dark.png?fit=max\u0026auto=format\u0026n=NGkNMcphWaf7RK6B\u0026q=85\u0026s=7aee99ad1489fe11869a2655a1e0b84a"},"favicon":"/favicon.png","navbar":{"links":[{"label":"Emotional Support","href":"mailto:support@errorgolf.com"}],"primary":{"type":"button","label":"Clobhouse","href":"https://errorgolf.com/clubhouse"}},"footer":{"socials":{"x":"https://x.com/teamerrorgolf","github":"https://github.com/errorgolf-devops","linkedin":"https://linkedin.com/company/errorgolf"}},"navigation":{"global":{"anchors":[{"anchor":"Docs","icon":"book-open-cover","href":"https://docs.errorgolf.com"},{"anchor":"Clubhouse Dashboard","icon":"martini-glass","href":"https://errorgolf.com/clubhouse"},{"anchor":"Start A Round","icon":"golf-club","href":"https://errorgolf.com/course"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"errorgolf","hasAudioNarration":false,"actualSubdomain":"errorgolf","customDomains":["docs.errorgolf.com"],"gitSource":{"type":"github","owner":"errorgolf-devops","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a21e728044dd579e9b58a9a","collectionId":"9d902a0c-f5de-48f6-b245-eae9ffb2be99","schemaVersion":"v2"},"entitlements":{},"buildId":"6a21e728044dd579e9b58a9a:success","clientVersion":"0.0.4044","searchFilterCounts":[{"language":"default","tag":"API, Kinda","count":11},{"language":"default","tag":"For Eejits","count":8},{"language":"default","tag":"Stuff Nobody Reads","count":8},{"language":"default","tag":"Settings","count":4},{"language":"default","tag":"Playback","count":3},{"language":"default","tag":"Account","count":3},{"language":"default","tag":"API Masheen","count":1}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/introduction","slug":"/api-reference/introduction","pageMetadata":{"title":"Introduction","description":"You shouldn't be using this API. But if you absolutely have to","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: \"You shouldn’t be using this API. But if you absolutely have to\"\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={p:`p`,..._provideComponents(),...props.components},{Heading,Note}=_components;if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);return _jsxs(_Fragment,{children:[_jsx(Note,{children:_jsx(_components.p,{children:`The API powers the main site. It’s not designed for the likes of you to be messing around with, but we’re adding it anyway because YOLO`})}),`\n`,_jsx(Heading,{level:`2`,id:`go-away`,children:`Go Away`}),`\n`,_jsx(_components.p,{children:`Do not use this`})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Introduction","description":"You shouldn't be using this API. But if you absolutely have to","href":"/api-reference/introduction"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Go Away","slug":"go-away","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"errorgolf","siteName":"ErrorGolf Documentation","title":"Introduction - ErrorGolf Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2025-08-12T03:58:19.094Z","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=\"You shouldn\u0026#x27;t be using this API. But if you absolutely have to\">\u003cmeta data-mint-head name=\"application-name\" content=\"ErrorGolf Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/errorgolf/5qo67aUbTLPrJ4ux/_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/errorgolf/5qo67aUbTLPrJ4ux/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/errorgolf/5qo67aUbTLPrJ4ux/_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/errorgolf/5qo67aUbTLPrJ4ux/_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/errorgolf/5qo67aUbTLPrJ4ux/_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/errorgolf/5qo67aUbTLPrJ4ux/_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/errorgolf/5qo67aUbTLPrJ4ux/_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/errorgolf/5qo67aUbTLPrJ4ux/_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/errorgolf/5qo67aUbTLPrJ4ux/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Introduction - ErrorGolf Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"You shouldn\u0026#x27;t be using this API. But if you absolutely have to\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"ErrorGolf Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.errorgolf.com/api-reference/introduction\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://errorgolf.mintlify.app/_mintlify/api/og/v2?division=API+Masheen\u0026amp;title=Introduction\u0026amp;description=You+shouldn%27t+be+using+this+API.+But+if+you+absolutely+have+to\u0026amp;theme=e15bd385830fc10afb8c3e68\u0026amp;signature=565e39cfd7f289bdda68a837198bc5d983926c576309d504394a541f2f83d1ad\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Introduction - ErrorGolf Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"You shouldn\u0026#x27;t be using this API. But if you absolutely have to\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://errorgolf.mintlify.app/_mintlify/api/og/v2?division=API+Masheen\u0026amp;title=Introduction\u0026amp;description=You+shouldn%27t+be+using+this+API.+But+if+you+absolutely+have+to\u0026amp;theme=e15bd385830fc10afb8c3e68\u0026amp;signature=565e39cfd7f289bdda68a837198bc5d983926c576309d504394a541f2f83d1ad\">\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/errorgolf/5qo67aUbTLPrJ4ux/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"ErrorGolf Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#16A34A\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.errorgolf.com/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.errorgolf.com/#organization\",\"name\":\"ErrorGolf Documentation\",\"url\":\"https://docs.errorgolf.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/errorgolf/NGkNMcphWaf7RK6B/logo/light.png?fit=max\u0026auto=format\u0026n=NGkNMcphWaf7RK6B\u0026q=85\u0026s=f6e0c9a0d3570e0074155829ad78c83b\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.errorgolf.com#website\",\"name\":\"ErrorGolf Documentation\",\"url\":\"https://docs.errorgolf.com\",\"publisher\":{\"@id\":\"https://docs.errorgolf.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.errorgolf.com/api-reference/introduction#webpage\",\"url\":\"https://docs.errorgolf.com/api-reference/introduction\",\"name\":\"Introduction\",\"description\":\"You shouldn't be using this API. But if you absolutely have to\",\"dateModified\":\"2025-08-12T03:58:19.094Z\",\"isPartOf\":{\"@id\":\"https://docs.errorgolf.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.errorgolf.com/api-reference/introduction#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.errorgolf.com/api-reference/introduction#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"ErrorGolf Documentation\",\"item\":\"https://docs.errorgolf.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Introduction\",\"item\":\"https://docs.errorgolf.com/api-reference/introduction\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.errorgolf.com/api-reference/introduction#article\",\"headline\":\"Introduction\",\"name\":\"Introduction\",\"description\":\"You shouldn't be using this API. But if you absolutely have to\",\"url\":\"https://docs.errorgolf.com/api-reference/introduction\",\"mainEntityOfPage\":{\"@id\":\"https://docs.errorgolf.com/api-reference/introduction#webpage\"},\"dateModified\":\"2025-08-12T03:58:19.094Z\",\"publisher\":{\"@id\":\"https://docs.errorgolf.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.errorgolf.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"ErrorGolf Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"ErrorGolf Documentation","nav":{"global":{"anchors":[{"anchor":"Docs","icon":"book-open-cover","href":"https://docs.errorgolf.com"},{"anchor":"Clubhouse Dashboard","icon":"martini-glass","href":"https://errorgolf.com/clubhouse"},{"anchor":"Start A Round","icon":"golf-club","href":"https://errorgolf.com/course"}]},"tabs":[{"tab":"For Eejits","pages":[{"title":"For Eejits","href":""}]},{"tab":"API, Kinda","groups":[{"group":"API Masheen","pages":[{"title":"Introduction","href":"/api-reference/introduction"}]},{"group":"Account","pages":[{"title":"Get Your Access Token","openapi":"POST /token","description":"## Login and Authentication\n\nExchange your email and password for a JWT token. It's like a backstage pass but for APIs.\n\n**Security features:**\n- Rate limiting prevents brute force (10 attempts then timeout)\n- Case-insensitive emails (we're reasonable people)\n- Tokens expire after 1 week (nothing good lasts forever)\n\n**Token usage:**\n- Include in Authorization header: `Bearer \u003ctoken>`\n- Refresh before expiry or start the login dance again\n","href":"/api-reference/endpoint/token"},{"title":"Refresh Your Token","openapi":"PUT /refresh","href":"/api-reference/endpoint/refresh"},{"title":"Get Account Data","openapi":"GET /me","href":"/api-reference/endpoint/me"}]},{"group":"Playback","pages":[{"title":"Send Email Invites","openapi":"POST /invite","href":"/api-reference/endpoint/invite"},{"title":"All Testing Records","openapi":"GET /playback","href":"/api-reference/endpoint/playback"},{"title":"Individual Analysis","openapi":"GET /playback/{id}","href":"/api-reference/endpoint/playback-detail"}]},{"group":"Settings","pages":[{"title":"Retrieve Settings","openapi":"GET /settings","href":"/api-reference/endpoint/settings"},{"title":"Update Settings","openapi":"PATCH /settings","href":"/api-reference/endpoint/update-settings"},{"title":"Pause Submissions","openapi":"POST /pause","href":"/api-reference/endpoint/pause"},{"title":"Resume Submissions","openapi":"DELETE /pause","href":"/api-reference/endpoint/unpause"}]}]}]},"basePath":"","title":"Introduction - ErrorGolf Documentation","buildId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","deploymentId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","dynamics":[],"chunks":[]}
