Programmatic access uses API keys issued for your organization. Create and manage keys from the in-app settings where your administrators allow it. Send requests with:
Published API reference pages cover only endpoints that have been checked against the current codebase. If you need an endpoint that is not listed yet, contact your Headlight administrator or support.
⌘I
{"docsConfig":{"theme":"maple","$schema":"https://mintlify.com/docs.json","name":"Headlight","description":"API and embed documentation for Headlight, the operating system for trust and estate administration.","colors":{"primary":"#ee5459","light":"#fe8a88","dark":"#b3363d"},"logo":{"light":"https://mintcdn.com/headlight/afKkMYDwjgi10s-7/images/logo-light.svg?fit=max\u0026auto=format\u0026n=afKkMYDwjgi10s-7\u0026q=85\u0026s=3a3e1cdd51ec631da5c80841b09c1406","dark":"https://mintcdn.com/headlight/afKkMYDwjgi10s-7/images/logo-dark.svg?fit=max\u0026auto=format\u0026n=afKkMYDwjgi10s-7\u0026q=85\u0026s=9010ed2d44ddf925d473462cab49551b","href":"https://withheadlight.com"},"favicon":"https://mintcdn.com/headlight/afKkMYDwjgi10s-7/images/favicon.svg?fit=max\u0026auto=format\u0026n=afKkMYDwjgi10s-7\u0026q=85\u0026s=3f0f263000eea7ee2ada98810660825c","appearance":{"default":"system"},"navbar":{"links":[{"href":"https://app.withheadlight.com","label":"App"}],"primary":{"type":"button","label":"Open Headlight","href":"https://app.withheadlight.com"}},"footer":{"links":[{"header":"Headlight","items":[{"label":"Website","href":"https://withheadlight.com"},{"label":"App","href":"https://app.withheadlight.com"}]}]},"search":{"prompt":"Search Headlight docs"},"seo":{"metatags":{"og:locale":"en_US"}},"fonts":{"family":"Satoshi","weight":400,"source":"fonts/Satoshi-Regular.woff2","format":"woff2"},"icons":{"library":"lucide"},"contextual":{"options":["copy","view","chatgpt","claude"],"display":"header"},"thumbnails":{"appearance":"dark","background":"https://mintcdn.com/headlight/RgWsGJtn97tewFL2/images/og-background.png?fit=max\u0026auto=format\u0026n=RgWsGJtn97tewFL2\u0026q=85\u0026s=f6cfac22289f9384e97e55a4c001bbf0"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"headlight","hasAudioNarration":false,"actualSubdomain":"headlight","customDomains":["docs.withheadlight.com"],"gitSource":{"type":"github","owner":"headlight-technologies","repo":"headlight","deployBranch":"develop","contentDirectory":"docs-site","isPrivate":true,"mountPath":"","label":""},"chroma":{"latestBuiltDeploymentHistoryId":"6ad64e7cf018c792bed55b63","collectionId":"ba3548d2-06ad-4396-955a-1b1514eb2520","liveDeploymentHistoryId":"6ad64e7cf018c792bed55b63","schemaVersion":"v3"},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6ad64e7cf018c792bed55b63","clientVersion":"0.0.3894","searchFilterCounts":[{"language":"default","tag":"Documentation","count":12},{"language":"default","tag":"Embed chart","count":9},{"language":"default","tag":"API reference","count":4},{"language":"default","tag":"Relationships","count":4},{"language":"default","tag":"Getting started","count":3}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"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":"editor-branches-v2-autocommit","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-branches-v2","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":"teamspace","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":"vite-origin","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":"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":"revalidation-jwt","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":"client-snapshot-docs-config","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}],"isAtlas":false,"googleFontsInlined":false},"customCss":[{"filePath":"styles.css","content":"img.nav-logo{height:1.75rem!important;width:auto!important;max-width:none!important}h1,h2,h3,h4,h5,h6{letter-spacing:-.025em!important;font-weight:700!important}h2,h3,h4,h5,h6{letter-spacing:-.02em!important}h3,h4,h5,h6{letter-spacing:-.015em!important}h4,h5,h6{letter-spacing:-.01em!important}.mdx-content,.mdx-content li,.mdx-content p,a,body,button,h1+p,h5,h6,html,li,p{letter-spacing:0!important}.eyebrow{letter-spacing:.08em!important}html.dark{color-scheme:dark}html.dark #navbar,html.dark #sidebar{background-color:#2b2b2b;border-color:rgba(255,255,255,.08)}html.dark #content-area,html.dark #content-container{background-color:#2b2b2b;color:#f7f7f7}html.dark .prose,html.dark .prose li,html.dark .prose p{color:#d4d4d4}html.dark .prose h1,html.dark .prose h2,html.dark .prose h3,html.dark .prose h4,html.dark .prose h5,html.dark .prose h6,html.dark .prose strong{color:#f7f7f7}html.dark a:not([class]){color:#fe8a88}html.dark code:not([class]){background-color:rgba(255,255,255,.06);border-color:rgba(255,255,255,.1)}"}],"page":{"pagePath":"quickstart","slug":"/quickstart","pageMetadata":{"title":"Quickstart","description":"Get oriented with Headlight","icon":"rocket","href":"/quickstart"},"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: \"Get oriented with Headlight\"\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`,p:`p`,pre:`pre`,span:`span`,..._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:`sign-in`,children:`Sign in`}),`\n`,_jsxs(_components.p,{children:[`Open the Headlight app at `,_jsx(_components.a,{href:`https://app.withheadlight.com`,children:`app.withheadlight.com`}),` and complete sign-in with your organization credentials.`]}),`\n`,_jsx(Heading,{level:`2`,id:`api-access`,children:`API access`}),`\n`,_jsx(_components.p,{children:`Programmatic access uses API keys issued for your organization. Create and manage keys from the in-app settings where your administrators allow it. Send requests with:`}),`\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 idx_...`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),`\n`,_jsxs(_components.p,{children:[`See `,_jsx(_components.a,{href:`/authentication`,children:`Authentication`}),` for more detail.`]}),`\n`,_jsx(Heading,{level:`2`,id:`docs-scope`,children:`Docs scope`}),`\n`,_jsx(_components.p,{children:`Published API reference pages cover only endpoints that have been checked against the current codebase. If you need an endpoint that is not listed yet, contact your Headlight administrator or support.`})]})}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":"Quickstart","description":"Get oriented with Headlight","icon":"rocket","href":"/quickstart"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Sign in","slug":"sign-in","depth":2,"children":[]},{"title":"API access","slug":"api-access","depth":2,"children":[]},{"title":"Docs scope","slug":"docs-scope","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"headlight","siteName":"Headlight","title":"Quickstart - Headlight","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-08-31T18:44:32.815Z","originalFileLocation":"quickstart.mdx"},"headHtml":"\u003cmeta data-mint-head name=\"description\" content=\"Get oriented with Headlight\">\u003cmeta data-mint-head name=\"application-name\" content=\"Headlight\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/headlight/fk8S1U0Jd3hEeHyj/_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/headlight/fk8S1U0Jd3hEeHyj/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/headlight/fk8S1U0Jd3hEeHyj/_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/headlight/fk8S1U0Jd3hEeHyj/_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/headlight/fk8S1U0Jd3hEeHyj/_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/headlight/fk8S1U0Jd3hEeHyj/_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/headlight/fk8S1U0Jd3hEeHyj/_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/headlight/fk8S1U0Jd3hEeHyj/_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/headlight/fk8S1U0Jd3hEeHyj/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Quickstart - Headlight\">\u003cmeta data-mint-head property=\"og:description\" content=\"Get oriented with Headlight\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Headlight\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.withheadlight.com/quickstart\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Quickstart - Headlight\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Get oriented with Headlight\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/headlight/fk8S1U0Jd3hEeHyj/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Headlight\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#ee5459\">\u003cmeta data-mint-head name=\"og:locale\" content=\"en_US\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.withheadlight.com/quickstart\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/quickstart.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.withheadlight.com/#organization\",\"name\":\"Headlight\",\"url\":\"https://docs.withheadlight.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/headlight/afKkMYDwjgi10s-7/images/logo-light.svg?fit=max\u0026auto=format\u0026n=afKkMYDwjgi10s-7\u0026q=85\u0026s=3a3e1cdd51ec631da5c80841b09c1406\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.withheadlight.com#website\",\"name\":\"Headlight\",\"url\":\"https://docs.withheadlight.com\",\"publisher\":{\"@id\":\"https://docs.withheadlight.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.withheadlight.com/quickstart#webpage\",\"url\":\"https://docs.withheadlight.com/quickstart\",\"name\":\"Quickstart\",\"description\":\"Get oriented with Headlight\",\"dateModified\":\"2026-08-31T18:44:32.815Z\",\"isPartOf\":{\"@id\":\"https://docs.withheadlight.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.withheadlight.com/quickstart#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.withheadlight.com/quickstart#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Getting started\",\"item\":\"https://docs.withheadlight.com/index\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Quickstart\",\"item\":\"https://docs.withheadlight.com/quickstart\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.withheadlight.com/quickstart#article\",\"headline\":\"Quickstart\",\"name\":\"Quickstart\",\"description\":\"Get oriented with Headlight\",\"url\":\"https://docs.withheadlight.com/quickstart\",\"mainEntityOfPage\":{\"@id\":\"https://docs.withheadlight.com/quickstart#webpage\"},\"dateModified\":\"2026-08-31T18:44:32.815Z\",\"publisher\":{\"@id\":\"https://docs.withheadlight.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.withheadlight.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Headlight\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Headlight","nav":{"global":null,"tabs":[{"tab":"Documentation","groups":[{"group":"Getting started","pages":[{"title":"Welcome","description":"Headlight documentation","icon":"house","href":""},{"title":"Quickstart","icon":"rocket","href":"/quickstart"},{"title":"Authentication","description":"How Headlight authenticates API and web requests","icon":"key","href":"/authentication"}]},{"group":"Embed chart","pages":[{"title":null,"href":"/embed/quickstart"},{"title":"Embed with React","href":"/embed/react"},{"title":"Sample payload","href":"/embed/sample-payload"},{"title":null,"href":"/embed/schema-reference"},{"title":null,"href":"/embed/mapping-guide"},{"title":null,"href":"/embed/postmessage-protocol"},{"title":null,"href":"/embed/token-minting"},{"title":null,"href":"/embed/security-appendix"},{"title":null,"href":"/embed/known-footguns"}]}]},{"tab":"API reference","pages":[{"title":"API reference","href":"/api-reference/relationships/list-relationships"}]}]},"title":"Quickstart - Headlight","buildId":"dpl_8LJVMfxYNq6LJkohTrn2iyWT8umj","deploymentId":"dpl_8LJVMfxYNq6LJkohTrn2iyWT8umj","dynamics":[],"chunks":[]}