BSPK API uses a token based authentication which you have to include in the header of every request. Company admins can generate API keys and can have multiple valid tokens at the same time.To generate an API token, in the BSPK Portal web app go to API keys menu and click the CREATE A API KEY button.
Important: Developers with BSPK API keys will be granted full access to the data in each endpoint. Access to this data is binary: everything or nothing.
Requests that require authentication will return 403 Forbidden in case of invalid credential or your IP address is not allowed not present in our allowed list.The authorization header should be in the following format:
Access to Extraction API is IP restricted. Please contact bspk-support@bspk.com to provide a list of IP addresses you want to allow or your requests will be denied.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"BSPK Developers Portal","colors":{"primary":"#171717","light":"#d4a27f","dark":"#171717"},"logo":{"light":"https://mintcdn.com/bspk-e077910a/M_e-8v-SU7FdiAxW/logo/light.svg?fit=max\u0026auto=format\u0026n=M_e-8v-SU7FdiAxW\u0026q=85\u0026s=b5137e53c57326ab951b3cf58b3bd2b2","dark":"https://mintcdn.com/bspk-e077910a/r9DoYji8AsQ9Xhq5/logo/dark.png?fit=max\u0026auto=format\u0026n=r9DoYji8AsQ9Xhq5\u0026q=85\u0026s=8b586e85afe09eeb48dd8897216c20c0"},"favicon":"https://mintcdn.com/bspk-e077910a/r9DoYji8AsQ9Xhq5/favicon.png?fit=max\u0026auto=format\u0026n=r9DoYji8AsQ9Xhq5\u0026q=85\u0026s=53d517af69304679af79466ec82923c1","api":{"playground":{"display":"interactive"}},"background":{"color":{"light":"#fdfdf8","dark":"#09090b"}},"navbar":{"links":[{"href":"mailto:support@bspk.com","label":"Get Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://dashboard.mintlify.com"}},"footer":{"socials":{"github":"https://github.com/bspk-www","linkedin":"https://www.linkedin.com/company/bspkluxury"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"bspk-e077910a","hasAudioNarration":false,"actualSubdomain":"bspk-e077910a","customDomains":["developers.bspk.com"],"gitSource":{"type":"github","owner":"bspk-www","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"entitlements":{},"buildId":"6ac64d9b4c7e27d998eaaae8","clientVersion":"0.0.4143","searchFilterCounts":[{"language":"default","tag":"Documentation","count":117},{"language":"default","tag":"API Reference","count":57},{"language":"default","tag":"Platform API","count":22},{"language":"default","tag":"Core Data Integration Guide","count":19},{"language":"default","tag":"Import Files Specs","count":17},{"language":"default","tag":"Webhooks","count":12},{"language":"default","tag":"Extraction API","count":11},{"language":"default","tag":"Using the API","count":7},{"language":"default","tag":"Clients","count":7},{"language":"default","tag":"Shopper Addresses","count":6}]},"assistantConfig":{},"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":"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":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/authentication","slug":"/api-reference/authentication","pageMetadata":{"title":"Authentication","description":null,"href":"/api-reference/authentication"},"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`,..._provideComponents(),...props.components},{CodeBlock,Info,Warning}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Info)_missingMdxReference(`Info`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`BSPK API uses a token based authentication which you have to include in the header of every request. Company admins can generate API keys and can have multiple valid tokens at the same time.`}),`\n`,_jsxs(_components.p,{children:[`To generate an API token, in the BSPK Portal web app go to `,_jsx(_components.code,{children:`API keys`}),` menu and click the `,_jsx(_components.strong,{children:`CREATE A API KEY`}),` button.`]}),`\n`,_jsx(Info,{children:_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Important`}),`: Developers with BSPK API keys will be granted full access to the data in each endpoint. Access to this data is binary: everything or nothing.`]})}),`\n`,_jsxs(_components.p,{children:[`Requests that require authentication will return `,_jsx(_components.code,{children:`403 Forbidden`}),` in case of invalid credential or your IP address is not allowed not present in our allowed list.`]}),`\n`,_jsx(_components.p,{children:`The authorization header should be in the following format:`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`1`,language:`shellsession`,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:`shellsession`,children:_jsxs(_components.code,{language:`shellsession`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`$ curl -H `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Authorization: Bearer TOKEN\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` https://api.bspk.com/api/extraction/v1/appointments`})]}),`\n`]})})}),`\n`,_jsx(Warning,{children:_jsxs(_components.p,{children:[`Access to Extraction API is IP restricted. Please contact `,_jsx(_components.a,{href:`mailto:bspk-support@bspk.com`,children:`bspk-support@bspk.com`}),` to provide a list of IP addresses you want to allow or your requests will be denied.`]})})]})}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":null,"href":"/api-reference/authentication"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"subdomain":"bspk-e077910a","siteName":"BSPK Developers Portal","title":"Authentication - BSPK Developers Portal","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-09-18T21:01:42.245Z","originalFileLocation":"api-reference/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=\"application-name\" content=\"BSPK Developers Portal\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/bspk-e077910a/_u2uKaCzDSXK5Flz/_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/bspk-e077910a/_u2uKaCzDSXK5Flz/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/bspk-e077910a/_u2uKaCzDSXK5Flz/_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/bspk-e077910a/_u2uKaCzDSXK5Flz/_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/bspk-e077910a/_u2uKaCzDSXK5Flz/_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/bspk-e077910a/_u2uKaCzDSXK5Flz/_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/bspk-e077910a/_u2uKaCzDSXK5Flz/_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/bspk-e077910a/_u2uKaCzDSXK5Flz/_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/bspk-e077910a/_u2uKaCzDSXK5Flz/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Authentication - BSPK Developers Portal\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"BSPK Developers Portal\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developers.bspk.com/api-reference/authentication\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://bspk-e077910a.mintlify.site/_mintlify/api/og/v2?division=Using+the+API\u0026amp;title=Authentication\u0026amp;theme=5cf8190f47e772cf17b525cc\u0026amp;signature=3ff0198a88d5f15a1ec26f47736909b7ce9abd813633167601ece62c02c332c3\">\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 - BSPK Developers Portal\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://bspk-e077910a.mintlify.site/_mintlify/api/og/v2?division=Using+the+API\u0026amp;title=Authentication\u0026amp;theme=5cf8190f47e772cf17b525cc\u0026amp;signature=3ff0198a88d5f15a1ec26f47736909b7ce9abd813633167601ece62c02c332c3\">\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/bspk-e077910a/_u2uKaCzDSXK5Flz/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"BSPK Developers Portal\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#171717\">\u003clink data-mint-head rel=\"canonical\" href=\"https://developers.bspk.com/api-reference/authentication\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/authentication.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://developers.bspk.com/#organization\",\"name\":\"BSPK Developers Portal\",\"url\":\"https://developers.bspk.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/bspk-e077910a/M_e-8v-SU7FdiAxW/logo/light.svg?fit=max\u0026auto=format\u0026n=M_e-8v-SU7FdiAxW\u0026q=85\u0026s=b5137e53c57326ab951b3cf58b3bd2b2\"}},{\"@type\":\"WebSite\",\"@id\":\"https://developers.bspk.com#website\",\"name\":\"BSPK Developers Portal\",\"url\":\"https://developers.bspk.com\",\"publisher\":{\"@id\":\"https://developers.bspk.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://developers.bspk.com/api-reference/authentication#webpage\",\"url\":\"https://developers.bspk.com/api-reference/authentication\",\"name\":\"Authentication\",\"dateModified\":\"2026-09-18T21:01:42.245Z\",\"isPartOf\":{\"@id\":\"https://developers.bspk.com#website\"},\"breadcrumb\":{\"@id\":\"https://developers.bspk.com/api-reference/authentication#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developers.bspk.com/api-reference/authentication#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Using the API\",\"item\":\"https://developers.bspk.com/api-reference/getting-started\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Authentication\",\"item\":\"https://developers.bspk.com/api-reference/authentication\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://developers.bspk.com/api-reference/authentication#article\",\"headline\":\"Authentication\",\"name\":\"Authentication\",\"url\":\"https://developers.bspk.com/api-reference/authentication\",\"mainEntityOfPage\":{\"@id\":\"https://developers.bspk.com/api-reference/authentication#webpage\"},\"dateModified\":\"2026-09-18T21:01:42.245Z\",\"publisher\":{\"@id\":\"https://developers.bspk.com/#organization\"},\"isPartOf\":{\"@id\":\"https://developers.bspk.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"BSPK Developers Portal\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"BSPK Developers Portal\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/authentication.md","siteName":"BSPK Developers Portal","nav":{"global":null,"anchors":[{"anchor":"Documentation","icon":"book-open","tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/welcome"}]},{"tab":"API Reference","groups":[{"group":"Using the API","pages":[{"title":"Getting started","href":"/api-reference/getting-started"},{"title":"Schema and Versioning","description":null,"href":"/api-reference/schema-and-versioning"},{"title":"Authentication","href":"/api-reference/authentication"},{"title":"Requests and Responses","description":null,"href":"/api-reference/requests-and-responses"},{"title":"Pagination","href":"/api-reference/pagination"},{"title":"Rate limiting","href":"/api-reference/rate-limiting"},{"title":"Getting Support","href":"/api-reference/support"}]},{"group":"Platform API","pages":[{"title":"Introduction","href":"/api-reference/platform-api/introduction"},{"group":"Clients","pages":[{"openapi":"post /api/platform/v1/clients","title":"[Deprecated] Creates or updates a Client (Shopper) in BSPK","href":"/api-reference/platform-api/endpoints/clients/[deprecated]-creates-or-updates-a-client-shopper-in-bspk"},{"openapi":"post /api/platform/v1/clients/{id}/external_link","deprecated":true,"title":"[Deprecated] Links a BSPK Client with a Client in an external backend system","href":"/api-reference/platform-api/endpoints/clients/[deprecated]-links-a-bspk-client-with-a-client-in-an-external-backend-system"},{"openapi":"delete /api/platform/v1/clients/{id}/external_link","deprecated":true,"title":"[Deprecated] Removes the Link from a BSPK Client with a Client in an external backend system","href":"/api-reference/platform-api/endpoints/clients/[deprecated]-removes-the-link-from-a-bspk-client-with-a-client-in-an-external-backend-system"}]},{"group":"Shoppers","pages":[{"openapi":"post /api/platform/v1/shoppers","title":"Creates or updates a Shopper in BSPK","href":"/api-reference/platform-api/endpoints/shoppers/creates-or-updates-a-shopper-in-bspk"},{"openapi":"post /api/platform/v1/shoppers/{id}/external_link","title":"Links a BSPK Shopper with a Shopper in an external backend system","href":"/api-reference/platform-api/endpoints/shoppers/links-a-bspk-shopper-with-a-shopper-in-an-external-backend-system"},{"openapi":"delete /api/platform/v1/shoppers/{id}/external_link","title":"Removes the link from a BSPK Shopper with a Shopper in an external backend system","href":"/api-reference/platform-api/endpoints/shoppers/removes-the-link-from-a-bspk-shopper-with-a-shopper-in-an-external-backend-system"}]},{"group":"Shopper Metafields","pages":[{"openapi":"get /api/platform/v1/shoppers/{shopper_ref}/metafields","title":"List metafields for a shopper","href":"/api-reference/platform-api/endpoints/shopper-metafields/list-metafields-for-a-shopper"},{"openapi":"put /api/platform/v1/shoppers/{shopper_ref}/metafields","title":"Bulk upsert metafields for a shopper","href":"/api-reference/platform-api/endpoints/shopper-metafields/bulk-upsert-metafields-for-a-shopper"},{"openapi":"delete /api/platform/v1/shoppers/{shopper_ref}/metafields/{namespace}/{key}","title":"Delete a metafield","href":"/api-reference/platform-api/endpoints/shopper-metafields/delete-a-metafield"}]},{"group":"Shopper Addresses","pages":[{"openapi":"post /api/platform/v1/shoppers/{shopper_ref}/addresses.json","title":"Create an address for a shopper","href":"/api-reference/platform-api/endpoints/shopper-addresses/create-an-address-for-a-shopper"},{"openapi":"patch /api/platform/v1/shoppers/{shopper_ref}/addresses/{address_ref}.json","title":"Update a shopper address","href":"/api-reference/platform-api/endpoints/shopper-addresses/update-a-shopper-address"},{"openapi":"delete /api/platform/v1/shoppers/{shopper_ref}/addresses/{address_ref}.json","title":"Delete a shopper address","href":"/api-reference/platform-api/endpoints/shopper-addresses/delete-a-shopper-address"}]},{"group":"Products","pages":[{"openapi":"post /api/platform/v1/products/inventories/batches","title":"Creates or updates inventory quantities in batch","href":"/api-reference/platform-api/endpoints/products/creates-or-updates-inventory-quantities-in-batch"}]},{"group":"Webhooks","pages":[{"title":"Introduction","href":"/api-reference/platform-api/endpoints/webhooks/introduction"},{"title":"Events and Payloads","href":"/api-reference/platform-api/endpoints/webhooks/events-and-payloads"},{"title":"Secure your webhooks","href":"/api-reference/platform-api/endpoints/webhooks/security"},{"title":"Webhooks Retry Policy","href":"/api-reference/platform-api/endpoints/webhooks/retry-policy"},{"openapi":"post /api/platform/v1/webhook_endpoints","title":"Creates a webhook endpoint","href":"/api-reference/platform-api/endpoints/webhooks/creates-a-webhook-endpoint"},{"openapi":"delete /api/platform/v1/webhook_endpoints/{id}","title":"Delete a webhook endpoint","href":"/api-reference/platform-api/endpoints/webhooks/delete-a-webhook-endpoint"},{"openapi":"patch /api/platform/v1/webhook_endpoints/{id}","title":"Updates a webhook endpoint","href":"/api-reference/platform-api/endpoints/webhooks/updates-a-webhook-endpoint"},{"openapi":"get /api/platform/v1/webhook_endpoints","title":"List Webhook Endpoints","href":"/api-reference/platform-api/endpoints/webhooks/list-webhook-endpoints"}]}]},{"group":"Extraction API","pages":[{"title":"Introduction","href":"/api-reference/extraction-api/introduction"},{"title":"Extracting a delta","href":"/api-reference/extraction-api/extracting-a-delta"},{"group":"Appointments","pages":[{"openapi":"get /api/extraction/v1/appointments","title":"List Appointments","href":"/api-reference/extraction-api/endpoints/appointments/list-appointments"}]},{"group":"Calls","pages":[{"openapi":"get /api/extraction/v1/calls","title":"List Calls","href":"/api-reference/extraction-api/endpoints/calls/list-calls"}]},{"group":"Clients","pages":[{"openapi":"get /api/extraction/v1/clients","title":"List Clients","href":"/api-reference/extraction-api/endpoints/clients/list-clients"}]},{"group":"Emails","pages":[{"openapi":"get /api/extraction/v1/emails","title":"List Emails","href":"/api-reference/extraction-api/endpoints/emails/list-emails"}]},{"group":"Messages","pages":[{"openapi":"get /api/extraction/v1/messages","title":"List Messages","href":"/api-reference/extraction-api/endpoints/messages/list-messages"}]},{"group":"Notes","pages":[{"openapi":"get /api/extraction/v1/notes","title":"List Notes","href":"/api-reference/extraction-api/endpoints/notes/list-notes"}]},{"group":"Reminders","pages":[{"openapi":"get /api/extraction/v1/reminders","title":"List Reminders","href":"/api-reference/extraction-api/endpoints/reminders/list-reminders"}]},{"group":"Sales Associates","pages":[{"openapi":"get /api/extraction/v1/sales_associates","title":"List Sales Associates","href":"/api-reference/extraction-api/endpoints/sales-associates/list-sales-associates"}]},{"group":"Slices","pages":[{"openapi":"get /api/extraction/v1/slices","title":"List Slices","href":"/api-reference/extraction-api/endpoints/slices/list-slices"}]}]},{"group":"Clients","pages":[{"title":"[Deprecated] Links a BSPK Client with a Client in an external backend system","deprecated":true,"version":null,"openapi":"/api-reference/platform_v1.json post /api/platform/v1/clients/{id}/external_link","href":"/api-reference/clients/[deprecated]-links-a-bspk-client-with-a-client-in-an-external-backend-system"},{"title":"[Deprecated] Removes the Link from a BSPK Client with a Client in an external backend system","deprecated":true,"version":null,"openapi":"/api-reference/platform_v1.json delete /api/platform/v1/clients/{id}/external_link","href":"/api-reference/clients/[deprecated]-removes-the-link-from-a-bspk-client-with-a-client-in-an-external-backend-system"},{"title":"[Deprecated] Creates or updates a Client (Shopper) in BSPK","deprecated":null,"version":null,"openapi":"/api-reference/platform_v1.json post /api/platform/v1/clients","href":"/api-reference/clients/[deprecated]-creates-or-updates-a-client-shopper-in-bspk"}]},{"group":"Shoppers","pages":[{"title":"Creates or updates a Shopper in BSPK","deprecated":null,"version":null,"openapi":"/api-reference/platform_v1.json post /api/platform/v1/shoppers","href":"/api-reference/shoppers/creates-or-updates-a-shopper-in-bspk"},{"title":"Links a BSPK Shopper with a Shopper in an external backend system","deprecated":null,"version":null,"openapi":"/api-reference/platform_v1.json post /api/platform/v1/shoppers/{id}/external_link","href":"/api-reference/shoppers/links-a-bspk-shopper-with-a-shopper-in-an-external-backend-system"},{"title":"Removes the link from a BSPK Shopper with a Shopper in an external backend system","deprecated":null,"version":null,"openapi":"/api-reference/platform_v1.json delete /api/platform/v1/shoppers/{id}/external_link","href":"/api-reference/shoppers/removes-the-link-from-a-bspk-shopper-with-a-shopper-in-an-external-backend-system"}]},{"group":"Shopper Metafields","pages":[{"title":"List metafields for a shopper","deprecated":null,"version":null,"openapi":"/api-reference/platform_v1.json get /api/platform/v1/shoppers/{shopper_ref}/metafields","href":"/api-reference/shopper-metafields/list-metafields-for-a-shopper"},{"title":"Bulk upsert metafields for a shopper","deprecated":null,"version":null,"openapi":"/api-reference/platform_v1.json put /api/platform/v1/shoppers/{shopper_ref}/metafields","href":"/api-reference/shopper-metafields/bulk-upsert-metafields-for-a-shopper"},{"title":"Delete a metafield","deprecated":null,"version":null,"openapi":"/api-reference/platform_v1.json delete /api/platform/v1/shoppers/{shopper_ref}/metafields/{namespace}/{key}","href":"/api-reference/shopper-metafields/delete-a-metafield"}]},{"group":"Shopper Addresses","pages":[{"title":"Create an address for a shopper","deprecated":null,"version":null,"openapi":"/api-reference/platform_v1.json post /api/platform/v1/shoppers/{shopper_ref}/addresses.json","href":"/api-reference/shopper-addresses/create-an-address-for-a-shopper"},{"title":"Delete a shopper address","deprecated":null,"version":null,"openapi":"/api-reference/platform_v1.json delete /api/platform/v1/shoppers/{shopper_ref}/addresses/{address_ref}.json","href":"/api-reference/shopper-addresses/delete-a-shopper-address"},{"title":"Update a shopper address","deprecated":null,"version":null,"openapi":"/api-reference/platform_v1.json patch /api/platform/v1/shoppers/{shopper_ref}/addresses/{address_ref}.json","href":"/api-reference/shopper-addresses/update-a-shopper-address"}]},{"group":"Products","pages":[{"title":"Creates or updates inventory quantities in batch","deprecated":null,"version":null,"openapi":"/api-reference/platform_v1.json post /api/platform/v1/products/inventories/batches","href":"/api-reference/products/creates-or-updates-inventory-quantities-in-batch"}]},{"group":"Webhooks","pages":[{"title":"List Webhook Endpoints","deprecated":null,"version":null,"openapi":"/api-reference/platform_v1.json get /api/platform/v1/webhook_endpoints","href":"/api-reference/webhooks/list-webhook-endpoints"},{"title":"Creates a webhook endpoint","deprecated":null,"version":null,"openapi":"/api-reference/platform_v1.json post /api/platform/v1/webhook_endpoints","href":"/api-reference/webhooks/creates-a-webhook-endpoint"},{"title":"Delete a webhook endpoint","deprecated":null,"version":null,"openapi":"/api-reference/platform_v1.json delete /api/platform/v1/webhook_endpoints/{id}","href":"/api-reference/webhooks/delete-a-webhook-endpoint"},{"title":"Updates a webhook endpoint","deprecated":null,"version":null,"openapi":"/api-reference/platform_v1.json patch /api/platform/v1/webhook_endpoints/{id}","href":"/api-reference/webhooks/updates-a-webhook-endpoint"}]}]}]},{"anchor":"Get Support","icon":"envelope","href":"mailto:support@bspk.com"}]},"basePath":"","title":"Authentication - BSPK Developers Portal","buildId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","deploymentId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","dynamics":[],"chunks":[]}