Each key is scoped to one environment and to the companies it was issued for. It
can act on any location belonging to those companies, and no others.Sparqle supplies the API key for your integration — it is not something you
create or retrieve from the dashboard. Contact your Sparqle account manager, or
[email protected], to receive a key for the test
and/or live environment. If you lose a key, ask us to issue a replacement and
revoke the old one.
Treat your API key like a password. Never embed it in client-side code, mobile
apps, or public repositories. Make all Sparqle API calls from your backend.
Test vs. live keys
You get a separate key per environment. A test key only works against the test
base URL, and a live key only works against the live base URL. See
Environments for the URLs.
Environment
Header
Base URL
Test
api-key: <test key>
https://staging-v2.sparqle.tech
Live
api-key: <live key>
https://v2.sparqle.com
What a key can reach
A key is valid only on the endpoints listed under API
Reference. Any other endpoint returns 401 Unauthorized, even with a valid key.
Failed authentication
A missing, malformed, or revoked key returns 401 Unauthorized. Using a valid
key against a locationId, order, or label belonging to a company it wasn’t
issued for returns 403 Forbidden. See Errors for the full list.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Sparqle API","description":"Create deliveries, fetch labels, and track orders with the Sparqle API.","colors":{"primary":"#2C2A4C","light":"#94BFFF","dark":"#2C2A4C"},"logo":{"light":"https://mintcdn.com/sparqle/WNUWUpM65_OQ3roC/logo/surface.svg?fit=max\u0026auto=format\u0026n=WNUWUpM65_OQ3roC\u0026q=85\u0026s=1e0176396f723134028a362f094cc167","dark":"https://mintcdn.com/sparqle/WNUWUpM65_OQ3roC/logo/surface.svg?fit=max\u0026auto=format\u0026n=WNUWUpM65_OQ3roC\u0026q=85\u0026s=1e0176396f723134028a362f094cc167"},"favicon":"https://mintcdn.com/sparqle/WNUWUpM65_OQ3roC/logo/sparqle.png?fit=max\u0026auto=format\u0026n=WNUWUpM65_OQ3roC\u0026q=85\u0026s=fc316e24a85eb0df889780ae54fcc327","navbar":{"primary":{"type":"button","label":"Sparqle dashboard","href":"https://app.sparqle.com"}},"footer":{"socials":{"website":"https://www.sparqle.com"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"sparqle","hasAudioNarration":false,"actualSubdomain":"sparqle","customDomains":["docs.sparqle.com"],"gitSource":{"type":"github","owner":"sparqletech","repo":"sparqle","deployBranch":"production","contentDirectory":"docs","isPrivate":false,"mountPath":"","label":""},"entitlements":{},"buildId":"6aeddec7f99c6f493ac994a0","clientVersion":"0.0.4270","searchFilterCounts":[{"language":"default","tag":"Documentation","count":13},{"language":"default","tag":"API Reference","count":9},{"language":"default","tag":"Core concepts","count":8},{"language":"default","tag":"Get started","count":4},{"language":"default","tag":"Coverage","count":3},{"language":"default","tag":"Labels","count":2},{"language":"default","tag":"Overview","count":1},{"language":"default","tag":"Guides","count":1},{"language":"default","tag":"Cancellation","count":1},{"language":"default","tag":"Orders","count":1}]},"assistantConfig":{"enableStarterQuestions":false},"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":"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":"site-roles","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":"starter-pricing","enabled":true,"variant":{"name":"control","enabled":true,"payload":{"type":"string","value":"control"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[]}
{"page":{"pagePath":"authentication","slug":"/authentication","pageMetadata":{"title":"Authentication","description":"Authenticate every request with your Sparqle API key.","href":"/authentication"},"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: \"Authenticate every request with your Sparqle API key.\"\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`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,..._provideComponents(),...props.components},{CodeBlock,Heading,Table,Warning}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Table)_missingMdxReference(`Table`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`The Sparqle API authenticates requests with an `,_jsx(_components.strong,{children:`API key`}),` sent in the `,_jsx(_components.code,{children:`api-key`}),`\nHTTP header.`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`2`,language:`shellscript`,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:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`2`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` https://staging-v2.sparqle.tech/orders/label/SPQ-10293`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"api-key: YOUR_API_KEY\"`})]}),`\n`]})})}),`\n`,_jsx(_components.p,{children:`Each key is scoped to one environment and to the companies it was issued for. It\ncan act on any location belonging to those companies, and no others.`}),`\n`,_jsxs(_components.p,{children:[`Sparqle supplies the API key for your integration — it is not something you\ncreate or retrieve from the dashboard. Contact your Sparqle account manager, or\n`,_jsx(_components.a,{href:`mailto:[email protected]`,children:`[email protected]`}),`, to receive a key for the test\nand/or live environment. If you lose a key, ask us to issue a replacement and\nrevoke the old one.`]}),`\n`,_jsx(Warning,{children:_jsx(_components.p,{children:`Treat your API key like a password. Never embed it in client-side code, mobile\napps, or public repositories. Make all Sparqle API calls from your backend.`})}),`\n`,_jsx(Heading,{level:`2`,id:`test-vs-live-keys`,children:`Test vs. live keys`}),`\n`,_jsxs(_components.p,{children:[`You get a separate key per environment. A test key only works against the test\nbase URL, and a live key only works against the live base URL. See\n`,_jsx(_components.a,{href:`/environments`,children:`Environments`}),` for the URLs.`]}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Environment`}),_jsx(_components.th,{children:`Header`}),_jsx(_components.th,{children:`Base URL`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Test`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`api-key: \u003ctest key>`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`https://staging-v2.sparqle.tech`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Live`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`api-key: \u003clive key>`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`https://v2.sparqle.com`})})]})]})]}),`\n`,_jsx(Heading,{level:`2`,id:`what-a-key-can-reach`,children:`What a key can reach`}),`\n`,_jsxs(_components.p,{children:[`A key is valid only on the endpoints listed under `,_jsx(_components.a,{href:`/api-reference/introduction`,children:`API\nReference`}),`. Any other endpoint returns `,_jsx(_components.code,{children:`401 Unauthorized`}),`, even with a valid key.`]}),`\n`,_jsx(Heading,{level:`2`,id:`failed-authentication`,children:`Failed authentication`}),`\n`,_jsxs(_components.p,{children:[`A missing, malformed, or revoked key returns `,_jsx(_components.code,{children:`401 Unauthorized`}),`. Using a valid\nkey against a `,_jsx(_components.code,{children:`locationId`}),`, order, or label belonging to a company it wasn’t\nissued for returns `,_jsx(_components.code,{children:`403 Forbidden`}),`. See `,_jsx(_components.a,{href:`/errors`,children:`Errors`}),` for the full list.`]})]})}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":"Authentication","description":"Authenticate every request with your Sparqle API key.","href":"/authentication"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Test vs. live keys","slug":"test-vs-live-keys","depth":2,"children":[]},{"title":"What a key can reach","slug":"what-a-key-can-reach","depth":2,"children":[]},{"title":"Failed authentication","slug":"failed-authentication","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"sparqle","siteName":"Sparqle API","title":"Authentication - Sparqle API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-09-09T11:12:07.015Z","originalFileLocation":"authentication.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=\"Authenticate every request with your Sparqle API key.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Sparqle API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/sparqle/Zlh0X8kYdkhZR95b/_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/sparqle/Zlh0X8kYdkhZR95b/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/sparqle/Zlh0X8kYdkhZR95b/_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/sparqle/Zlh0X8kYdkhZR95b/_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/sparqle/Zlh0X8kYdkhZR95b/_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/sparqle/Zlh0X8kYdkhZR95b/_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/sparqle/Zlh0X8kYdkhZR95b/_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/sparqle/Zlh0X8kYdkhZR95b/_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/sparqle/Zlh0X8kYdkhZR95b/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Authentication - Sparqle API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Authenticate every request with your Sparqle API key.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Sparqle API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.sparqle.com/authentication\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://sparqle.mintlify.site/_mintlify/api/og/v2?division=Get+started\u0026amp;title=Authentication\u0026amp;description=Authenticate+every+request+with+your+Sparqle+API+key.\u0026amp;theme=a1fc2de7fc95e7de4b27e6d9\u0026amp;signature=57c650f8acb8557de6907c5522f916002817b8e41a8c16c8554488b161d68a55\">\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=\"Authentication - Sparqle API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Authenticate every request with your Sparqle API key.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://sparqle.mintlify.site/_mintlify/api/og/v2?division=Get+started\u0026amp;title=Authentication\u0026amp;description=Authenticate+every+request+with+your+Sparqle+API+key.\u0026amp;theme=a1fc2de7fc95e7de4b27e6d9\u0026amp;signature=57c650f8acb8557de6907c5522f916002817b8e41a8c16c8554488b161d68a55\">\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/sparqle/Zlh0X8kYdkhZR95b/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Sparqle API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#2C2A4C\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.sparqle.com/authentication\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/authentication.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.sparqle.com/#organization\",\"name\":\"Sparqle API\",\"url\":\"https://docs.sparqle.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/sparqle/WNUWUpM65_OQ3roC/logo/surface.svg?fit=max\u0026auto=format\u0026n=WNUWUpM65_OQ3roC\u0026q=85\u0026s=1e0176396f723134028a362f094cc167\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.sparqle.com#website\",\"name\":\"Sparqle API\",\"url\":\"https://docs.sparqle.com\",\"publisher\":{\"@id\":\"https://docs.sparqle.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.sparqle.com/authentication#webpage\",\"url\":\"https://docs.sparqle.com/authentication\",\"name\":\"Authentication\",\"description\":\"Authenticate every request with your Sparqle API key.\",\"dateModified\":\"2026-09-09T11:12:07.015Z\",\"isPartOf\":{\"@id\":\"https://docs.sparqle.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.sparqle.com/authentication#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.sparqle.com/authentication#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Get started\",\"item\":\"https://docs.sparqle.com/introduction\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Authentication\",\"item\":\"https://docs.sparqle.com/authentication\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.sparqle.com/authentication#article\",\"headline\":\"Authentication\",\"name\":\"Authentication\",\"description\":\"Authenticate every request with your Sparqle API key.\",\"url\":\"https://docs.sparqle.com/authentication\",\"mainEntityOfPage\":{\"@id\":\"https://docs.sparqle.com/authentication#webpage\"},\"dateModified\":\"2026-09-09T11:12:07.015Z\",\"publisher\":{\"@id\":\"https://docs.sparqle.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.sparqle.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Sparqle API\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Sparqle API\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/authentication.md","siteName":"Sparqle API","nav":{"global":null,"tabs":[{"tab":"Documentation","groups":[{"group":"Get started","pages":[{"title":"Sparqle API","href":"/introduction"},{"title":"Quickstart","description":"Create your first Sparqle delivery and print its label.","href":"/quickstart"},{"title":"Authentication","href":"/authentication"},{"title":"Environments","description":"Test and live base URLs for the Sparqle API.","href":"/environments"}]},{"group":"Core concepts","pages":[{"title":"Order lifecycle","href":"/concepts/order-lifecycle"},{"title":"Routing \u0026 fallback","href":"/concepts/routing"},{"title":"Pickup points","href":"/concepts/pickup-points"},{"title":"Labels","href":"/concepts/labels"},{"title":"Order bundling","href":"/concepts/order-bundling"},{"title":"Multiple brands","href":"/concepts/multiple-brands"},{"title":"Webhooks","href":"/webhooks"},{"title":"Errors \u0026 rate limits","href":"/errors"}]},{"group":"Guides","pages":[{"title":"Upload orders from a spreadsheet","href":"/guides/manual-order-upload"}]}]},{"tab":"API Reference","pages":[{"title":"API Reference","href":"/api-reference/introduction"}]}]},"basePath":"","title":"Authentication - Sparqle API","deploymentId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","buildId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","dynamics":[],"chunks":[]}