Important Notice
Right now, this API is only available for Spanish customers.
If you’re reading this, chances are your company is either exploring or already using Cobee by Pluxee as its employee benefits platform. Good news — you’re in the right place.
staging (aka sandbox) – for testing and development purposes
To get access to either (or both), you’ll need to contact your Customer Success Manager. They’ll handle the setup and provide the necessary API credentials for each environment.Once you have your credentials, you can start integrating with the Cobee API!The API is designed to be intuitive and easy to use, so you can focus on building great features for your employees without getting bogged down in technical details.Check the API documentation.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Cobee by Pluxee - Public API Documentation","colors":{"primary":"#1B51DC","light":"#00EB5E","dark":"#1B51DC"},"logo":{"light":"https://mintcdn.com/cobee/9xUZcwN4NOUCTDuX/logo/cobee_light.svg?fit=max\u0026auto=format\u0026n=9xUZcwN4NOUCTDuX\u0026q=85\u0026s=4e50c283f6bcbf11e86cf1bca5c447f0","dark":"https://mintcdn.com/cobee/9xUZcwN4NOUCTDuX/logo/cobee_dark.svg?fit=max\u0026auto=format\u0026n=9xUZcwN4NOUCTDuX\u0026q=85\u0026s=3b5b8fff0c7c610e800fd749048670e1"},"favicon":"https://mintcdn.com/cobee/PCkU581NfM2tS8aK/favicon.png?fit=max\u0026auto=format\u0026n=PCkU581NfM2tS8aK\u0026q=85\u0026s=534054732dcb2f8f4da0e133cec140e2","api":{"playground":{"proxy":false}},"background":{"color":{"light":"#FFFFFF","dark":"#0E0C1D"}},"navbar":{"links":[]},"footer":{"socials":{"linkedin":"https://linkedin.com/company/cobee-espana"}},"metadata":{"timestamp":false},"styling":{"latex":false},"navigation":{"languages":[{"language":"en","href":"en/welcome"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"cobee","hasAudioNarration":false,"actualSubdomain":"cobee","customDomains":["docs.api.cobee.io"],"gitSource":{"type":"gitlab","owner":"cobee/companies","repo":"public-api","deployBranch":"master","contentDirectory":"docs/mintlify/publicApi","isPrivate":true,"projectId":68809709,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6acf38e6b7a70ebe915f1a35","collectionId":"fbf1ef61-fe32-49d8-bb2a-e26b3f7e47ed","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6acf38e6b7a70ebe915f1a35"},"entitlements":{},"buildId":"6acf38e6b7a70ebe915f1a35","clientVersion":"0.0.3971","searchFilterCounts":[{"language":"en","tag":"API Reference","count":25},{"language":"en","tag":"Employees","count":11},{"language":"en","tag":"Guides","count":9},{"language":"en","tag":"Consumption Reports","count":5},{"language":"en","tag":"Essentials","count":4},{"language":"en","tag":"Use Cases","count":3},{"language":"en","tag":"General","count":3},{"language":"en","tag":"Get Started","count":2},{"language":"en","tag":"Benefit Models","count":2},{"language":"en","tag":"Payroll Cycles","count":2}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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":"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":"editor-version-history-v2","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":"billing-page-v2","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":"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":"vite-origin","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":"billing-updated-9-15","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":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"en/get_started","slug":"/en/get_started","pageMetadata":{"title":"Get Started","icon":"rocket","description":null,"href":"/en/get_started"},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,li:`li`,p:`p`,strong:`strong`,ul:`ul`,..._provideComponents(),...props.components},{Heading,Warning}=_components;if(!Heading)_missingMdxReference(`Heading`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsx(Warning,{children:_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Important Notice`}),_jsx(`br`,{}),`\nRight now, this API is only available for Spanish customers.`]})}),`\n`,_jsxs(_components.p,{children:[`If you’re reading this, chances are your company is either exploring or already using `,_jsx(_components.strong,{children:`Cobee by Pluxee`}),` as its employee benefits platform. Good news — you’re in the right place.`]}),`\n`,_jsx(Heading,{level:`3`,id:`cobee-exposes-two-environments`,children:`Cobee exposes two environments:`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`production`}),` – for live data and real usage`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`staging`}),` (aka `,_jsx(_components.code,{children:`sandbox`}),`) – for testing and development purposes`]}),`\n`]}),`\n`,_jsxs(_components.p,{children:[`To get access to either (or both), you’ll need to contact your `,_jsx(_components.strong,{children:`Customer Success Manager`}),`. They’ll handle the setup and provide the necessary API credentials for each environment.`]}),`\n`,_jsx(_components.p,{children:`Once you have your credentials, you can start integrating with the Cobee API!`}),`\n`,_jsx(_components.p,{children:`The API is designed to be intuitive and easy to use, so you can focus on building great features for your employees without getting bogged down in technical details.`}),`\n`,_jsxs(_components.p,{children:[_jsx(`a`,{href:`api-reference/api_introduction`,target:`_self`,children:`Check the API documentation`}),`.`]})]})}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":"Get Started","icon":"rocket","description":null,"href":"/en/get_started"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Cobee exposes two environments:","slug":"cobee-exposes-two-environments","depth":3,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"cobee","siteName":"Cobee by Pluxee - Public API Documentation","title":"Get Started - Cobee by Pluxee - Public API Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"en":{"href":"/en/get_started","matchLevel":0}}},"lastModified":"2026-10-14T08:10:48.956Z","originalFileLocation":"en/get_started.mdx","locale":"en"},"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=\"Cobee by Pluxee - Public API 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/cobee/cthMQ0KJkKg2YCjS/_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/cobee/cthMQ0KJkKg2YCjS/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/cobee/cthMQ0KJkKg2YCjS/_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/cobee/cthMQ0KJkKg2YCjS/_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/cobee/cthMQ0KJkKg2YCjS/_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/cobee/cthMQ0KJkKg2YCjS/_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/cobee/cthMQ0KJkKg2YCjS/_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/cobee/cthMQ0KJkKg2YCjS/_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/cobee/cthMQ0KJkKg2YCjS/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get Started - Cobee by Pluxee - Public API Documentation\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Cobee by Pluxee - Public API Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.api.cobee.io/en/get_started\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://cobee.mintlify.app/_mintlify/api/og/v2?division=General\u0026amp;title=Get+Started\u0026amp;theme=292bab5e47a3136cc2ded749\u0026amp;signature=be3048d3025f6cbf5a80364f6ce70a9155f6125400965d05db0ccf53dcf6f153\">\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=\"Get Started - Cobee by Pluxee - Public API Documentation\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://cobee.mintlify.app/_mintlify/api/og/v2?division=General\u0026amp;title=Get+Started\u0026amp;theme=292bab5e47a3136cc2ded749\u0026amp;signature=be3048d3025f6cbf5a80364f6ce70a9155f6125400965d05db0ccf53dcf6f153\">\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/cobee/cthMQ0KJkKg2YCjS/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Cobee by Pluxee - Public API Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#1B51DC\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.api.cobee.io/en/get_started\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/en/get_started.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.api.cobee.io/#organization\",\"name\":\"Cobee by Pluxee - Public API Documentation\",\"url\":\"https://docs.api.cobee.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/cobee/9xUZcwN4NOUCTDuX/logo/cobee_light.svg?fit=max\u0026auto=format\u0026n=9xUZcwN4NOUCTDuX\u0026q=85\u0026s=4e50c283f6bcbf11e86cf1bca5c447f0\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.api.cobee.io#website\",\"name\":\"Cobee by Pluxee - Public API Documentation\",\"url\":\"https://docs.api.cobee.io\",\"publisher\":{\"@id\":\"https://docs.api.cobee.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.api.cobee.io/en/get_started#webpage\",\"url\":\"https://docs.api.cobee.io/en/get_started\",\"name\":\"Get Started\",\"dateModified\":\"2026-10-14T08:10:48.956Z\",\"isPartOf\":{\"@id\":\"https://docs.api.cobee.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.api.cobee.io/en/get_started#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.api.cobee.io/en/get_started#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"General\",\"item\":\"https://docs.api.cobee.io/en/welcome\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get Started\",\"item\":\"https://docs.api.cobee.io/en/get_started\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.api.cobee.io/en/get_started#article\",\"headline\":\"Get Started\",\"name\":\"Get Started\",\"url\":\"https://docs.api.cobee.io/en/get_started\",\"mainEntityOfPage\":{\"@id\":\"https://docs.api.cobee.io/en/get_started#webpage\"},\"dateModified\":\"2026-10-14T08:10:48.956Z\",\"publisher\":{\"@id\":\"https://docs.api.cobee.io/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.api.cobee.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Cobee by Pluxee - Public API Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Cobee by Pluxee - Public API Documentation","nav":{"global":null,"languages":[{"language":"en","tabs":[{"tab":"Guides","groups":[{"group":"General","pages":[{"title":"Welcome","icon":"hand-wave","description":null,"href":"/en/welcome"},{"title":"Get Started","icon":"rocket","href":"/en/get_started"},{"title":"Security","icon":"shield-check","description":null,"href":"/en/security"}]},{"group":"Essentials","pages":[{"title":"Glossary","icon":"book","href":"/en/essentials/glossary"},{"group":"Use Cases","icon":"arrows-to-circle","pages":[{"title":"Overview","icon":"circle-info","href":"/en/essentials/use-cases/overview"},{"title":"Employees","icon":"users","href":"/en/essentials/use-cases/employees"},{"title":"Consumptions","icon":"table-list","href":"/en/essentials/use-cases/consumptions"}]}]}]},{"tab":"API Reference","pages":[{"title":"API Reference","href":"/en/api-reference/api_introduction"}]}],"global":{"anchors":[{"anchor":"Cobee Homepage","icon":"c","href":"https://cobee.io/"}]}}]},"title":"Get Started - Cobee by Pluxee - Public API Documentation","buildId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","deploymentId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","dynamics":[],"chunks":[]}