1<!DOCTYPE html><html lang="en" style="" data-color-mode="system" class=" useReactApp "><head><meta charset="utf-8"><link rel="preconnect" href="https://cdn.readme.io"><link rel="preconnect" href="https://cdn.readme.io" crossorigin><meta name="readme-deploy" content="5.906.1"><meta name="readme-subdomain" content="employes"><meta name="readme-repo" content="employes-c29e7a8b9a4c"><meta name="readme-project-flags" content="SXLTIcL/Qqv3iBS0lxnCRw==:dI3erTTR0ZhUelqXYz/pK8HD7emdfZFV6nF0+LaZ7HANuBAHRVzgh43/jCgBTTxdfMLgRXpQie0O4chRzwAoaYJz2cuDIvyLxCi6VWdSq1egkd0xg0HqNmGKECQKt5JW"><meta name="readme-version" content="4.0"><title>Getting Started With the API</title><meta name="description" content="This page will help you get started with our public API" data-rh="true"><meta property="og:title" content="Getting Started With the API" data-rh="true"><meta property="og:description" content="This page will help you get started with our public API" data-rh="true"><meta property="og:site_name" content="Employes"><meta name="twitter:title" content="Getting Started With the API" data-rh="true"><meta name="twitter:description" content="This page will help you get started with our public API" data-rh="true"><meta name="twitter:card" content="summary_large_image"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta property="og:image" content="https://cdn.readme.io/og-image/create?type=docs&title=Getting%20Started%20With%20the%20API&projectTitle=Employes&description=This%20page%20will%20help%20you%20get%20started%20with%20our%20public%20API&logoUrl=https%3A%2F%2Ffiles.readme.io%2F84a1be1031d6e02357bd2ad201aed218d4bcbb469f948a87dc0a3e52c976f3ff-Employees_by_Shine_Logo_White_1.png&color=%23005148&variant=light" data-rh="true"><meta name="twitter:image" content="https://cdn.readme.io/og-image/create?type=docs&title=Getting%20Started%20With%20the%20API&projectTitle=Employes&description=This%20page%20will%20help%20you%20get%20started%20with%20our%20public%20API&logoUrl=https%3A%2F%2Ffiles.readme.io%2F84a1be1031d6e02357bd2ad201aed218d4bcbb469f948a87dc0a3e52c976f3ff-Employees_by_Shine_Logo_White_1.png&color=%23005148&variant=light" data-rh="true"><meta property="og:image:width" content="1200"><meta property="og:image:height" content="630"><meta name="dateModified" content="2025-05-26T11:21:52.000Z" data-rh="true"><meta property="article:modified_time" content="2025-05-26T11:21:52.000Z" data-rh="true"><meta property="og:updated_time" content="2025-05-26T11:21:52.000Z" data-rh="true">
1<script type="application/ld+json" data-rh="true">{"@context":"https://schema.org","@type":"TechArticle","headline":"Getting Started With the API","dateModified":"2025-05-26T11:21:52.000Z"}</script>
1<link id="favicon" rel="shortcut icon" href="https://files.readme.io/d8fafacc6c73905bcf382eea071848f35389b095a8e4594b05b0884b85f066b0-favicon.ico" type="image/x-icon"><link rel="canonical" href="https://employes.readme.io/docs/getting-started">
1<script src="https://cdn.readme.io/public/js/cash-dom.min.js?1790786438156"></script>
1<link data-chunk="Footer" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/Footer.769aa3e9fc194cc963d9.css"> 2<link data-chunk="components-AIDropdown" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/components-AIDropdown.99bc192bac06a6bceec5.css"> 3<link data-chunk="RMDXISH" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/RMDXISH.159422ed8463cae8cb3f.css"> 4<link data-chunk="RMDXISH" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/2985.fc1b3c92408dc05972b5.css"> 5<link data-chunk="Doc" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/Doc.f3d5f8eea2a1ed9379a5.css"> 6<link data-chunk="Header" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/Header.b0da985a5b2effd2ad0a.css"> 7<link data-chunk="Header" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/ui-styles.1125e39841f99a963bb7.css"> 8<link data-chunk="Containers-EndUserContainer" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/Containers-EndUserContainer.8f6dfebd66e7ce6dca76.css"> 9<link data-chunk="main" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/main.cb7f3f5f00c878e84679.css"> 10<link data-chunk="main" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/main.cc789f714ace3
106f66839.js"> 11<link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-SuperHub.529e1767765a70259c1d.js"> 12<link data-chunk="Containers-EndUserContainer" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/Containers-EndUserContainer.a39bb49787d00dc5a756.js"> 13<link data-chunk="Header" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/4011.98c6655a4c5d99e73da8.js"> 14<link data-chunk="Header" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/6269.ec68447c21baa0d006c4.js"> 15<link data-chunk="Header" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/444.9911d4434036a49d02be.js"> 16<link data-chunk="Header" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/4148.fbcb7b553d8b36a3535f.js"> 17<link data-chunk="Header" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/Header.a76de00df61db59a3b60.js"> 18<link data-chunk="routes-SuperHub-Routes" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-SuperHub-Routes.5212e2cc1e2393ed6ccd.js"> 19<link data-chunk="Doc" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/7137.6d393781d59245222014.js"> 20<link data-chunk="Doc" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/9977.a933c2a0ee96169ffef7.js"> 21<link data-chunk="Doc" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/6146.e0750bc6839fd326854d.js"> 22<link data-chunk="Doc" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/441.0bca8969b4854384884a.js"> 23<link data-chunk="Doc" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/1347.6265ddeff9b9202723b8.js"> 24<link data-chunk="Doc" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/8836.278c0fa83edd766823b0.js"> 25<link data-chunk="Doc" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/5446.66a863132dae0648c54c.js"> 26<link data-chunk="Doc" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/1306.50782c5e797f388d05de.js"> 27<link data-chunk="Doc" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/2966.7dda7fe8a5d98b4a3ffe.js"> 28<link data-chunk="Doc" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/8813.fa11b4c3ec4dd6845870.js"> 29<link data-chunk="Doc" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/4071.7611d1296eb10d1ab027.js"> 30<link data-chunk="Doc" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/7358.586fb9797e5f7461750b.js"> 31<link data-chunk="Doc" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/6383.fd233703db9be7c9fc84.js"> 32<link data-chunk="Doc" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/9127.bb4d560bc945b6900553.js"> 33<link data-chunk="Doc" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/Doc.5f97f0771ff731d59de3.js"> 34<link data-chunk="ConnectMetadata" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/ConnectMetadata.2d6f49b2cb0315a7ccd6.js"> 35<link data-chunk="RMDXISH" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/2712.4cdafc1e56a745cc323d.js"> 36<link data-chunk="RMDXISH" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/779.787e23290115569e9f85.js"> 37<link data-chunk="RMDXISH" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/97.5601dd7405fb2adb484c.js"> 38<link data-chunk="RMDXISH" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/1297.27dddfa8ccd2dd3bce10.js"> 39<link data-chunk="RMDXISH" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/2985.a3c9e5ecc4ac37e1db9b.js"> 40<link data-chunk="RMDXISH" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/RMDXISH.f4037585e9d9a19fb24f.js"> 41<link data-chunk="components-AIDropdown" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/4818.9a6592613ce853a623e4.js"> 42<link data-chunk="components-AIDropdown" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/components-AIDropdown.88def46aeefbfb1f9434.js"> 43<link data-chunk="Footer" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/F
43ooter.167664af72797a4cf2f8.js"> 44<link data-chunk="main" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/main.cb7f3f5f00c878e84679.css"> 45<link data-chunk="Containers-EndUserContainer" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/Containers-EndUserContainer.8f6dfebd66e7ce6dca76.css"> 46<link data-chunk="Header" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/ui-styles.1125e39841f99a963bb7.css"> 47<link data-chunk="Header" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/Header.b0da985a5b2effd2ad0a.css"> 48<link data-chunk="Doc" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/Doc.f3d5f8eea2a1ed9379a5.css"> 49<link data-chunk="RMDXISH" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/2985.fc1b3c92408dc05972b5.css"> 50<link data-chunk="RMDXISH" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/RMDXISH.159422ed8463cae8cb3f.css"> 51<link data-chunk="components-AIDropdown" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/components-AIDropdown.99bc192bac06a6bceec5.css"> 52<link data-chunk="Footer" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/Footer.769aa3e9fc194cc963d9.css"><!-- CUSTOM CSS--><style title="rm-custom-css">:root{--project-color-primary:#005148;--project-color-inverse:#fff;--recipe-button-color:#528afa;--recipe-button-color-hover:#064fdf;--recipe-button-color-active:#053dae;--recipe-button-color-focus:rgba(82, 138, 250, 0.25);--recipe-button-color-disabled:#ffffff}[id=enterprise] .ReadMeUI[is=AlgoliaSearch]{--project-color-primary:#005148;--project-color-inverse:#fff}a{color:var(--color-link-primary,#528afa)}a:hover{color:var(--color-link-primary-darken-5,#064fdf)}a.text-muted:hover{color:var(--color-link-primary,#528afa)}.btn.btn-primary{background-color:#528afa}.btn.btn-primary:hover{background-color:#064fdf}.theme-line #hub-landing-top h2{color:#528afa}#hub-landing-top .btn:hover{color:#528afa}.theme-line #hub-landing-top .btn:hover{color:#fff}.theme-solid header#hub-header #header-top{background-color:#005148}.theme-solid.header-gradient header#hub-header #header-top{background:linear-gradient(to bottom,#005148,#000404)}.theme-solid.header-custom header#hub-header #header-top{background-image:url("undefined")}.theme-line header#hub-header #header-top{border-bottom-color:#005148}.theme-line header#hub-header #header-top .btn{background-color:#005148}header#hub-header #header-top #header-logo{width:137px;height:40px;margin-top:0;background-image:url("https://files.readme.io/84a1be1031d6e02357bd2ad201aed218d4bcbb469f948a87dc0a3e52c976f3ff-Employees_by_Shine_Logo_White_1.png")}#hub-subheader-parent #hub-subheader .hub-subheader-breadcrumbs .dropdown-menu a:hover{background-color:#005148}#subheader-links a.active{color:#005148!important;box-shadow:inset 0 -2px 0 #005148}#subheader-links a:hover{color:#005148!important;box-shadow:inset 0 -2px 0 #005148;opacity:.7}.discussion .submit-vote.submit-vote-parent.voted a.submit-vote-button{background-color:#528afa}section#hub-discuss .discussion a .discuss-body h4{color:#528afa}section#hub-discuss .discussion a:hover .discuss-body h4{color:#064fdf}#hub-subheader-parent #hub-subheader.sticky-header.sticky{border-bottom-color:#528afa}#hub-subheader-parent #hub-subheader.sticky-header.sticky .search-box{border-bottom-color:#528afa}#hub-search-results h3 em{color:#528afa}.main_background,.tag-item{background:#528afa!important}.main_background:hover{background:#064fdf!important}.main_color{color:#005148!important}.border_bottom_main_color{border-bottom:2px solid #005148}.main_color_hover:hover{color:#005148!important}section#hub-discuss h1{color:#528afa}#hub-reference .hub-api .api-definition .api-try-it-out.active{border-color:#528afa;background-color:#528afa}#hub-reference .hub-api .api-definition .api-try-it-out.active:hover{background-color:#064fdf;border-color:#064fdf}#hub-reference .hub-api .api-definition .api-try-it-out:hover{border-color:#528afa;color:#528afa}#hub-reference .hub-reference .logs .logs-empty .logs-login-button,#hub-reference .hub-reference .logs .logs-login .logs-login-button{background-color:var(--project-color-primary,#528afa);border-color:var(--project-color-primary,#528afa)}#hub-reference .hub-reference .logs .logs-empty .logs-login-button:hover,#hub-reference .hub-reference .logs .logs-login .logs-login-button:hover{background-color:#064fdf;border-color:#064fdf}#hub-reference .hub-reference .logs .logs-empty>svg>path,#hub-reference .hub-reference .logs .logs-login>svg>path{fill:#528afa;
52fill:var(--project-color-primary,#528afa)}#hub-reference .hub-reference .logs:last-child .logs-empty,#hub-reference .hub-reference .logs:last-child .logs-login{margin-bottom:35px}#hub-reference .hub-reference .hub-reference-section .hub-reference-left header .hub-reference-edit:hover{color:#528afa}.main-color-accent{border-bottom:3px solid #005148;padding-bottom:8px}</style><meta name="loadedProject" content="employes">
52<script>(function () { 53 var scheme = 'system'; 54 var mode = scheme; 55 56 if (scheme === 'system') { 57 try { 58 mode = window.localStorage.getItem('color-scheme'); 59 } catch (e) { 60 // localStorage throws in some privacy modes 61 } 62 } 63 64 // anything else (null on a first visit, a stale poisoned value) falls back to the OS 65 if (mode !== 'light' && mode !== 'dark' && mode !== 'system') mode = 'system'; 66 67 document.documentElement.setAttribute('data-color-mode', mode); 68})();</script>
68<script id="config" type="application/json" data-json="{"algoliaIndex":"readme_search_v2","amplitude":{"apiKey":"8b550cf334a130e3d6ea41a88b894d8","enabled":"true","sessionReplay":{"enabled":"true","sampleRate":"0.1"}},"api":{"upload":{"fileSizeLimit":10485760,"fileSizeLimitFormatted":"10MB"}},"asset_url":"https://cdn.readme.io","dashDomain":"dash.readme.com","domain":"readme.io","domainFull":"https://dash.readme.com","encryptedLocalStorageKey":"ekfls-2025-03-27","fullstory":{"enabled":true,"orgId":"FSV9A"},"git":{"preview":"https://githug-prod.gitto.rdme.io","sync":{"bitbucket":{"installationLink":"https://developer.atlassian.com/console/install/310151e6-ca1a-4a44-9af6-1b523fea0561?signature=AYABeMn9vqFkrg%2F1DrJAQxSyVf4AAAADAAdhd3Mta21zAEthcm46YXdzOmttczp1cy13ZXN0LTI6NzA5NTg3ODM1MjQzOmtleS83MDVlZDY3MC1mNTdjLTQxYjUtOWY5Yi1lM2YyZGNjMTQ2ZTcAuAECAQB4IOp8r3eKNYw8z2v%2FEq3%2FfvrZguoGsXpNSaDveR%2FF%2Fo0BHUxIjSWx71zNK2RycuMYSgAAAH4wfAYJKoZIhvcNAQcGoG8wbQIBADBoBgkqhkiG9w0BBwEwHgYJYIZIAWUDBAEuMBEEDOJgARbqndU9YM%2FRdQIBEIA7unpCah%2BIu53NA72LkkCDhNHOv%2BgRD7agXAO3jXqw0%2FAcBOB0%2F5LmpzB5f6B1HpkmsAN2i2SbsFL30nkAB2F3cy1rbXMAS2Fybjphd3M6a21zOmV1LXdlc3QtMTo3MDk1ODc4MzUyNDM6a2V5LzQ2MzBjZTZiLTAwYzMtNGRlMi04NzdiLTYyN2UyMDYwZTVjYwC4AQICAHijmwVTMt6Oj3F%2B0%2B0cVrojrS8yZ9ktpdfDxqPMSIkvHAGT%2FMTvCxC3XwnwlulZe975AAAAfjB8BgkqhkiG9w0BBwagbzBtAgEAMGgGCSqGSIb3DQEHATAeBglghkgBZQMEAS4wEQQMMUUe9d1YmFOo373TAgEQgDuJo7TayM6NL19Sj9RPooRrl8rYxwKgvu9gkLNc3GuyyovWI1xA2qTr0LQzMRsf3imrAWsywzPcsjnvuAAHYXdzLWttcwBLYXJuOmF3czprbXM6dXMtZWFzdC0xOjcwOTU4NzgzNTI0MzprZXkvNmMxMjBiYTAtNGNkNS00OTg1LWI4MmUtNDBhMDQ5NTJjYzU3ALgBAgIAeLKa7Dfn9BgbXaQmJGrkKztjV4vrreTkqr7wGwhqIYs5AZR28Sibv2eBxSIg2MydtvEAAAB%2BMHwGCSqGSIb3DQEHBqBvMG0CAQAwaAYJKoZIhvcNAQcBMB4GCWCGSAFlAwQBLjARBAzzWhThsIgJwrr%2FY2ECARCAOxoaW9pob21lweyAfrIm6Fw7gd8D%2B%2F8LHk4rl3jjULDM35%2FVPuqBrqKunYZSVCCGNGB3RqpQJr%2FasASiAgAAAAAMAAAQAAAAAAAAAAAAAAAAAEokowLKsF1tMABEq%2BKNyJP%2F%2F%2F%2F%2FAAAAAQAAAAAAAAAAAAAAAQAAADJLzRcp6MkqKR43PUjOiRxxbxXYhLc6vFXEutK3%2BQ71yuPq4dC8pAHruOVQpvVcUSe8dptV8c7wR8BTJjv%2F%2FNe8r0g%3D&product=bitbucket"}}},"hubspot":{"portalId":"9401557"},"metrics":{"billingCronEnabled":"true","dashUrl":"https://m.readme.io","defaultUrl":"https://m.readme.io","exportMaxRetries":12,"wsUrl":"wss://m.readme.io"},"micro":{"baseUrl":"https://micro-beta.readme.com"},"novuNotification":{"appId":"ob_MiAPOPqgP","showUnreleasedWorkflows":false},"proxyUrl":"https://try.readme.io","readmeRecaptchaSiteKey":"6LesVBYpAAAAAESOCHOyo2kF9SZXPVb54Nwf3i2x","releaseVersion":"5.906.1","reservedWords":{"tools":["execute-request","get-endpoint","get-server-variables","list-endpoints","list-specs","search-endpoints","search","fetch"]},"sentry":{"dsn":"https://[email protected]/2052166","enabled":true},"shMigration":{"promoVideo":"","forceWaitlist":false,"migrationPreview":false},"sslBaseDomain":"readmessl.com","sslGenerationService":"ssl.readmessl.com","superHub":{"newProjectsEnabled":true},"tiptapCloud":{"appId":"8mzorjl9","url":"wss://8mzorjl9.collab.tiptap.cloud"},"wootric":{"accountToken":"NPS-122b75a4","enabled":true}}"></script>
68</head><body class="body-none theme-solid header-solid header-bg-size-auto header-bg-pos-cc header-overlay-triangles reference-layout-row lumosity-normal is-hub-themed"><div style="display:none" aria-hidden="true">For AI agents: visit https://employes.readme.io/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI. Append .md to any documentation page URL to get its markdown version.</div><div id="ssr-top"></div><div id="ssr-main"><div class="App ThemeContext ThemeContext_dark ThemeContext_classic ThemeContext_spacing_legacy ThemeContext_solid" style="--color-primary:#005148;--color-primary-inverse:#fff;--color-primary-alt:#000404;--color-primary-darken-10:#001e1b;--color-primary-darken-20:#000000;--color-primary-alpha-25:rgba(0, 81, 72, 0.25);--color-link-primary:#528afa;--color-link-primary-dark-override:#ffffff;--color-link-button:#528afa;--color-link-button-text:#fff;--color-link-button-border:rgba(255, 255, 255, 0.2);--color-link-button-darken-5:#3979f9;--color-link-button-darken-10:#2068f9;--color-link-button-alpha-50:rgba(82, 138, 250, 0.5);--color-link-button-alpha-25:rgba(82, 138, 250, 0.25);--color-link-primary-darken-5:#3979f9;--color-link-primary-darken-10:#2068f9;--color-link-primary-darken-20:#064fdf;--color-link-primary-alpha-50:rgba(82, 138, 250, 0.5);--color-link-primary-alpha-25:rgba(82, 138, 250, 0.25);--color-link-background:rgba(82, 138, 250, 0.09);--color-link-background-dark-override:rgba(255, 255, 255, 0.09);--color-link-text:#fff;--color-tab-active:#005148;--color-login-link:#528afa;--color-login-link-text:#fff;--color-login-link-darken-10:#2068f9;--color-login-link-primary-alpha-50:rgba(82, 138, 250, 0.5)"><div class="SuperHub2RNxzk6HzHiJ rm-ReadMe"><div class="ContentWithOwlbotx4PaFDoA1KMz"><div class="ContentWithOwlbot-content2X1XexaN8Lf2"><header class="Header3zzata9F_ZPQ rm-Header_classic Header_collapsible3n0YXfOvb_Al rm-Header"><div class="rm-Header-top Header-topuTMpygDG4e1V Header-top_classic3g7Q6zoBy8zh"><div class="rm-Container rm-Container_flex"><div style="outline:none" tabindex="-1"><a href="#content" target="_self" class="Button Button_md rm-JumpTo Header-jumpTo3IWKQXmhSI5D Button_primary">Jump to Content</a></div><div class="rm-Header-left Header-leftADQdGVqx1wqU"><a class="rm-Logo Header-logo1Xy41PtkzbdG" href="/docs" target="_self"><img alt="Employes" class="rm-Logo-img rm-Logo-img_lg Header-logo-img3YvV4lcGKkeb" src="https://files.readme.io/84a1be1031d6e02357bd2ad201aed218d4bcbb469f948a87dc0a3e52c976f3ff-Employees_by_Shine_Logo_White_1.png" style="aspect-ratio:auto 3200 / 940"/></a></div><div class="rm-Header-left Header-leftADQdGVqx1wqU Header-left_mobile1RG-X93lx6PF"><div><button aria-label="Toggle navigation menu" class="icon-menu menu3d6DYNDa3tk5" type="button"></button><div class=""><div class="Flyout95xhYIIoTKtc undefined rm-Flyout" data-testid="flyout"><div class="MobileFlyout1hHJpUd-nYkd"><a aria-current="page" class="rm-MobileFlyout-item NavItem-item1gDDTqaXGhm1 NavItem-item_mobile1qG3gd-Mkck- active" href="/docs" target="_self"><span class="NavItem-textSlZuuL489uiw">Guides</span></a><a class="rm-MobileFlyout-item NavItem-item1gDDTqaXGhm1 NavItem-item_mobile1qG3gd-Mkck- " href="/reference" target="_self"><span class="NavItem-textSlZuuL489uiw">API Reference</span></a><a class="rm-MobileFlyout-item NavItem-item1gDDTqaXGhm1 NavItem-item_mobile1qG3gd-Mkck- " href="/changelog" target="_self"><span class="NavItem-textSlZuuL489uiw">Changelog</span></a><a class="rm-MobileFlyout-item NavItem-item1gDDTqaXGhm1 NavItem-item_mobile1qG3gd-Mkck- " href="/discuss" target="_self"><span class="NavItem-textSlZuuL489uiw">Discussions</span></a><div class="NavItem-item1gDDTqaXGhm1 NavItem-item_inactiveMQoyhN045qAn">v4.0</div><hr class="MobileFlyout-divider10xf7R2X1MeW"/><a class="rm-MobileFlyout-item NavItem-item1gDDTqaXGhm1 NavItem-item_mobile1qG3gd-Mkck- NavItem_dropdown-muted1xJVuczwGc74" href="/login?redirect_uri=/docs/getting-started" target="_self" to="/login?redirect_uri=/docs/getting-started">Log In</a><a class="MobileFlyout-logo3Lq1eTlk1K76 Header-logo1Xy41PtkzbdG rm-Logo" href="/docs" target="_self"><img alt="Employes" class="Header-logo-img3YvV4lcGKkeb rm-Logo-img" src="https://files.readme.io/84a1be1031d6e02357bd2ad201aed218d4bcbb469f948a87dc0a3e52c976f3ff-Employees_by_Shine_Logo_White_1.png"/></a></div></div></div></div><div class="Header-left-nav2xWPWMNHOGf_"><i aria-hidden="true" class="icon-guides Header-left-nav-icon10glJKFwewOv"></i>Guides</div></div><div class="rm-Header-right Header-right21PC2XTT6aMg"><span class="Header-right_desktop14ja01RUQ7HE"><a class="Header-link2tXYTgXq85zW NavItem2xSfFaVqfRjy Button Button_md Button_slate_text rm-Header-top-link rm-Header-top-link_login" href="/login?redirect_uri=/docs/getting-started" target="_self">Log In</a></span><div class="Header-searchtb6Foi0-D9Vx"><button aria-label="Search âk" class="rm-SearchToggle" data-symbol
68="â"><div class="rm-SearchToggle-icon icon-search1"></div></button></div><div class="ThemeToggle-wrapper1ZcciJoF3Lq3 Dropdown Dropdown_closed" data-testid="dropdown-container"><button aria-label="Toggle color scheme" class="rm-ThemeToggle ThemeToggle2xLp9tbEJ0XB Button Button_md Button_slate_text Dropdown-toggle" id="ThemeToggle-button-Rip9cla" type="button" aria-haspopup="dialog"><svg aria-labelledby="ThemeToggle-button-Rip9cla" class="Icon ThemeToggle-Icon22I6nqvxacln ThemeToggle-Icon_active2ocLaPY47U28" role="img" viewBox="0 0 24 24"><path class="ThemeToggle-Icon-raysbSO3FKsq2hn" d="M12 2v2"></path><path d="M14.837 16.385a6 6 0 1 1-7.223-7.222c.624-.147.97.66.715 1.248a4 4 0 0 0 5.26 5.259c.589-.255 1.396.09 1.248.715"></path><path d="M16 12a4 4 0 0 0-4-4"></path><path class="ThemeToggle-Icon-raysbSO3FKsq2hn" d="m19 5-1.256 1.256"></path><path class="ThemeToggle-Icon-raysbSO3FKsq2hn" d="M20 12h2"></path></svg><svg aria-labelledby="ThemeToggle-button-Rip9cla" class="Icon ThemeToggle-Icon22I6nqvxacln ThemeToggle-Icon_dark3c1eP_qTU7uF" role="img" viewBox="0 0 24 24"><path d="M19 14.79C18.8427 16.4922 18.2039 18.1144 17.1582 19.4668C16.1126 20.8192 14.7035 21.8458 13.0957 22.4265C11.4879 23.0073 9.74798 23.1181 8.0795 22.7461C6.41102 22.3741 4.88299 21.5345 3.67423 20.3258C2.46546 19.117 1.62594 17.589 1.25391 15.9205C0.881876 14.252 0.992717 12.5121 1.57346 10.9043C2.1542 9.29651 3.18083 7.88737 4.53321 6.84175C5.8856 5.79614 7.5078 5.15731 9.21 5C8.21341 6.34827 7.73385 8.00945 7.85853 9.68141C7.98322 11.3534 8.70386 12.9251 9.8894 14.1106C11.0749 15.2961 12.6466 16.0168 14.3186 16.1415C15.9906 16.2662 17.6517 15.7866 19 14.79Z"></path><path class="ThemeToggle-Icon-star2kOSzvXrVCbT" d="M18.3707 1C18.3707 3.22825 16.2282 5.37069 14 5.37069C16.2282 5.37069 18.3707 7.51313 18.3707 9.74138C18.3707 7.51313 20.5132 5.37069 22.7414 5.37069C20.5132 5.37069 18.3707 3.22825 18.3707 1Z"></path></svg><svg aria-labelledby="ThemeToggle-button-Rip9cla" class="Icon ThemeToggle-Icon22I6nqvxacln" role="img" viewBox="0 0 24 24"><path class="ThemeToggle-Icon-raysbSO3FKsq2hn" d="M12 1V3"></path><path class="ThemeToggle-Icon-raysbSO3FKsq2hn" d="M18.36 5.64L19.78 4.22"></path><path class="ThemeToggle-Icon-raysbSO3FKsq2hn" d="M21 12H23"></path><path class="ThemeToggle-Icon-raysbSO3FKsq2hn" d="M18.36 18.36L19.78 19.78"></path><path class="ThemeToggle-Icon-raysbSO3FKsq2hn" d="M12 21V23"></path><path class="ThemeToggle-Icon-raysbSO3FKsq2hn" d="M4.22 19.78L5.64 18.36"></path><path class="ThemeToggle-Icon-raysbSO3FKsq2hn" d="M1 12H3"></path><path class="ThemeToggle-Icon-raysbSO3FKsq2hn" d="M4.22 4.22L5.64 5.64"></path><path d="M12 17C14.7614 17 17 14.7614 17 12C17 9.23858 14.7614 7 12 7C9.23858 7 7 9.23858 7 12C7 14.7614 9.23858 17 12 17Z"></path></svg></button></div></div></div></div><div class="Header-bottom2eLKOFXMEmh5 Header-bottom_classic rm-Header-bottom"><div class="rm-Container rm-Container_flex"><nav aria-label="Primary navigation" class="Header-leftADQdGVqx1wqU Header-subnavnVH8URdkgvEl Header-subnav_links1fSsYMNRxHdu" role="navigation"><span class="Truncate1OzxBYrNNfH3 VersionDropdown1GXDUTxJ1T95 VersionDropdown_inactive rm-Header-bottom-link" style="--Truncate-max-width:150px">v4.0</span><a aria-current="page" class="Button Button_md rm-Header-link rm-Header-bottom-link Button_slate_text Header-bottom-link_mobile active" href="/docs" target="_self"><span>Guides</span></a><a class="Button Button_md rm-Header-link rm-Header-bottom-link Button_slate_text Header-bottom-link_mobile " href="/reference" target="_self"><span>API Reference</span></a><a class="Button Button_md rm-Header-link rm-Header-bottom-link Button_slate_text Header-bottom-link_mobile " href="/changelog" target="_self"><span>Changelog</span></a><a class="Button Button_md rm-Header-link rm-Header-bottom-link Button_slate_text Header-bottom-link_mobile " href="/discuss" target="_self"><span>Discussions</span></a><div class="Header-subnav-tabyNLkcOA6xAra" style="transform:translateX(0px);width:0"></div></nav><button align="center" justify="between" style="--flex-gap:var(--xs)" class="Button Button_sm Flex Flex_row MobileSubnav1DsTfasXloM2 Button_secondary Button_secondary_outline" type="button"><span class="Button-label">Getting Started With the API</span><span class="IconWrapper Icon-wrapper2z2wVIeGsiUy"><svg fill="none" viewBox="0 0 24 24" class="Icon Icon3_D2ysxFZ_ll Icon-svg2Lm7f6G9Ly5a" data-name="chevron-up-down" role="img" style="--icon-color:inherit;--icon-size:inherit;--icon-stroke-width:2px"><path stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" d="m6 16 6 6 6-6M18 8l-6-6-6 6" class="icon-stroke-width"></path></svg></span></button></div></div><div class="hub-search-results--reactApp " id="hub-search-results"><div class="hub-container"><div class="modal-backdrop rm-SearchModal rm-SearchModal_classic" role="button" tabindex="0"></div></div></div></header><main class="SuperHubDoc3Z-1XSVTg-Q1 rm-Guides" id="content"><div class="SuperHubDoc-container2RY1FPE4Ewze rm-Container rm-Container_flex"><nav aria-label="Secondary navigation" class="rm-Sidebar hub-sidebar reference-redesign Nav3C5f8FcjkaHj rm-Sidebar_guides" id="hub-sidebar" role="navigation"><div class="Sidebar1t2G1ZJq-vU1 rm-Sidebar hub-sidebar-content"><section class="Sidebar-listWrapper6Q9_yUrG906C Sidebar-listWrapper_expandedvCieTVZJcoub rm-Sidebar-section"><h2 class="Sidebar-headingTRQyOa2pk0gh rm-Sidebar-heading">Getting started</h2><ul class="Sidebar-list_sidebarLayout3RaX72iQNOEI Sidebar-list3cZWQLaBf9k8 Sidebar-list_expandedWy9fQM8vmtOc rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a aria-current="page" class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link active" target="_self" href="/docs/getting-started"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Getting Started With the API</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/authentication"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Authentication</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/responses"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Responses</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/pagination"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Pagination</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/rate-limits"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Rate limits</span></span></a></li></ul></section><section class="Sidebar-listWrapper6Q9_yUrG906C rm-Sidebar-section"><h2 class="Sidebar-headingTRQyOa2pk0gh rm-Sidebar-heading">USEcases</h2><ul class="Sidebar-list_sidebarLayout3RaX72iQNOEI Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/importing-employees"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Add employees</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/importing-data-to-a-payrun"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Import data in a payrun</span></span></a></li></ul></section><section class="Sidebar-listWrapper6Q9_yUrG906C rm-Sidebar-section"><h2 class="Sidebar-headingTRQyOa2pk0gh rm-Sidebar-heading">Definitions</h2><ul class="Sidebar-list_sidebarLayout3RaX72iQNOEI Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/regulations"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">List of wage-components</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/list-of-nationalities"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">List of nationalities</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/list-of-countries"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">List of countries</span></span></a></li></ul></section><section class="Sidebar-listWrapper6Q9_yUrG906C rm-Sidebar-section"><h2 class="Sidebar-headingTRQyOa2pk0gh rm-Sidebar-heading">Other</h2><ul class="Sidebar-list_sidebarLayout3RaX72iQNOEI Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/future-updates"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Future updates</span></span></a></li></ul></section><div class="readme-logo" id="readmeLogo">Powered by<!-- -->Â <a aria-label="ReadMe" href="https://readme.com?ref_src=hub&project=employes" style="color:unset">
68<svg class="readme-logo-icon" height="50" viewBox="0 0 293 50" width="293"><path d="M114.851 9.35c-9.218 0-15.76 6.482-15.76 15.522 0 9.456 7.196 15.462 16.354 15.462 4.316 0 10.001-1.388 13.158-5.3a1 1 0 0 0-.062-1.345l-2.987-2.942a.978.978 0 0 0-1.37-.01c-2.438 2.415-5.548 3.352-8.382 3.352-4.401 0-8.089-2.438-8.564-7.374h22.231a.492.492 0 0 0 .49-.422c.077-.579.116-1.18.116-1.898 0-4.519-1.606-8.206-4.342-10.882-2.676-2.677-6.482-4.163-10.882-4.163Zm-7.554 12.429c.536-3.985 3.331-6.423 7.375-6.423 2.141 0 3.985.714 5.293 2.082 1.011 1.13 1.784 2.557 2.022 4.34h-14.69ZM286.422 13.513c-2.675-2.676-6.482-4.163-10.882-4.163-9.218 0-15.76 6.482-15.76 15.522 0 9.456 7.196 15.462 16.354 15.462 4.316 0 10.001-1.388 13.159-5.3a1.002 1.002 0 0 0-.062-1.345l-2.988-2.942a.978.978 0 0 0-1.37-.01c-2.437 2.415-5.548 3.352-8.382 3.352-4.401 0-8.088-2.438-8.563-7.374h22.23a.493.493 0 0 0 .491-.422c.076-.579.115-1.18.115-1.897 0-4.52-1.606-8.207-4.342-10.883Zm-18.436 8.266c.536-3.985 3.331-6.423 7.375-6.423 2.141 0 3.985.714 5.293 2.082 1.011 1.13 1.784 2.557 2.022 4.34h-14.69ZM167.264 33.54l.003-.039h-1.541V11.238c0-.682-.552-1.234-1.233-1.234h-4.561c-.682 0-1.234.553-1.234 1.234v2.146c-2.615-2.491-6.119-4.034-10.158-4.034-8.921 0-15.165 6.66-15.165 15.522 0 8.741 6.186 15.462 15.165 15.462 4.579 0 8.087-1.903 10.585-4.757v1.202a2.961 2.961 0 0 0 2.961 2.96h4.987c.681 0 1.234-.552 1.234-1.233v-3.77c0-.614-.456-1.1-1.043-1.196Zm-17.416-.164c-4.876 0-8.385-3.747-8.385-8.504 0-4.817 3.509-8.564 8.385-8.564 4.401 0 8.266 3.092 8.266 8.564 0 5.411-3.865 8.504-8.266 8.504ZM257.585 33.502h-2.222V22.077c0-7.613-4.817-12.727-12.192-12.727-4.459 0-7.909 1.843-10.228 4.58-2.021-2.915-5.293-4.58-9.515-4.58s-7.362 1.808-9.445 4.496v-2.667c0-.681-.552-1.234-1.233-1.234h-4.561c-.682 0-1.234.553-1.234 1.234v26.249a2.312 2.312 0 0 0 2.312 2.311h8.173c.681 0 1.233-.552 1.233-1.233v-3.77c0-.682-.552-1.234-1.233-1.234h-2.218v-10.77c0-3.866 2.497-6.305 6.124-6.305 3.569 0 5.65 2.438 5.65 6.304v14.697a2.312 2.312 0 0 0 2.312 2.311h7.307c.678 0 1.228-.55 1.228-1.228V34.73c0-.678-.55-1.228-1.228-1.228h-1.352v-10.77c0-3.866 2.557-6.304 6.125-6.304s5.709 2.438 5.709 6.304V33.5l.004 3.083v.843a2.311 2.311 0 0 0 2.311 2.312h8.173c.682 0 1.234-.552 1.234-1.234v-3.77c0-.681-.553-1.234-1.234-1.234ZM199.36.005h-6.647c-.681 0-1.233.553-1.233 1.234v3.77c0 .682.552 1.234 1.233 1.234h.353l-.001.007h.99v6.074c-2.438-1.844-5.471-2.974-8.921-2.974-8.919 0-15.164 6.66-15.164 15.522 0 8.741 6.185 15.462 15.164 15.462 4.328 0 7.688-1.712 10.153-4.307v2.478c0 .682.552 1.234 1.233 1.234h4.561c.682 0 1.234-.552 1.234-1.234V34.36l.006-.001V2.966a2.961 2.961 0 0 0-2.961-2.96Zm-12.917 33.371c-4.877 0-8.385-3.747-8.385-8.504 0-4.817 3.508-8.564 8.385-8.564 4.401 0 8.266 3.092 8.266 8.564 0 5.412-3.865 8.504-8.266 8.504ZM54.631 7.158H40.196c-5.072 0-9.307 3.551-10.375 8.3-1.068-4.749-5.304-8.3-10.375-8.3H5.01A5.01 5.01 0 0 0 0 12.168v25.4a5.01 5.01 0 0 0 5.01 5.01h9.579c9.99.031 13.266 2.377 14.844 7.172a.428.428 0 0 0 .388.255.424.424 0 0 0 .387-.255c1.578-4.795 4.854-7.14 14.844-7.171h9.58a5.01 5.01 0 0 0 5.01-5.01V12.167a5.01 5.01 0 0 0-5.01-5.01Zm-29.606 27.21c0 .294-.24.534-.534.534H8.175a.535.535 0 0 1-.535-.535v-2.03c0-.296.24-.535.535-.535H24.49c.295 0 .534.24.534.535v2.03Zm0-6.32c0 .294-.24.534-.534.534H8.175a.535.535 0 0 1-.535-.535v-2.03c0-.296.24-.535.535-.535H24.49c.295 0 .534.24.534.535v2.03Zm0-6.32c0 .294-.24.534-.534.534H8.175a.535.535 0 0 1-.535-.535v-2.03c0-.296.24-.535.535-.535H24.49c.295 0 .534.24.534.535v2.03Zm26.976 12.64c0 .294-.24.534-.535.534H35.151a.535.535 0 0 1-.535-.535v-2.03c0-.296.24-.535.535-.535h16.315c.296 0 .535.24.535.535v2.03Zm0-6.32c0 .294-.24.534-.535.534H35.151a.535.535 0 0 1-.535-.535v-2.03c0-.296.24-.535.535-.535h16.315c.296 0 .535.24.535.535v2.03Zm0-6.32c0 .294-.24.534-.535.534H35.151a.535.535 0 0 1-.535-.535v-2.03c0-.296.24-.535.535-.535h16.315c.296 0 .535.24.535.535v2.03ZM100.322 10.883c-.967-.651-3.238-1.75-7.368-1.533-3.743.196-6.661 1.963-8.623 5.114v-.594l-.002-.022v-.884a2.96 2.96 0 0 0-2.96-2.961h-6.45c-.68 0-1.233.552-1.233 1.234v3.896c0 .68.553 1.233 1.234 1.233h1.137-.48.664l.002.001h1.367v17.134h-2.216c-.675 0-1.222.547-1.222 1.222v3.794c0 .675.547 1.222 1.222 1.222h12.693c.674 0 1.22-.547 1.22-1.221v-3.795c0-.675-.546-1.222-1.22-1.222h-2.211v-9.759c0-4.163 2.444-6.996 6.363-7.196 1.825-.092 3.115.187 3.906.453.22.075.45-.037.548-.249a16.908 16.908 0 0 1 3.676-5.155.454.454 0 0 0-.048-.712h.
68001Z"></path></svg></a></div></div><button aria-label="Hide sidebar navigation" class="Nav-toggle-collapse39KxgTH727KL" type="button"></button></nav><article class="SuperHubDoc-article3ArTrEavUTKg rm-Article rm-Guides-SuperHub"><header id="content-head"><div class="row clearfix"><div class="col-xs-9"><h1>Getting Started With the API</h1><div class="excerpt"><div class="rm-Markdown markdown-body" data-testid="RDMD"><style data-tailwind-stylesheet="true"></style><p>This page will help you get started with our public API</p></div></div></div></div></header><div class="grid-container-fluid" id="content-container"><section class="content-body grid-75 "><div style="display:contents"><div class="rm-Markdown markdown-body rm-Markdown markdown-body ng-non-bindable" data-testid="RDMD" style="margin-left:31px"><style>/*! tailwindcss v4.1.17 | MIT License | https://tailwindcss.com */ 69@layer theme, base, components, utilities; 70@layer utilities; 71</style><p>The Employes API enables seamless interaction with an Employes account, providing a RESTful interface that utilizes JSON for data transport. This API serves various use cases, empowering you to:</p> 72<ul> 73<li>Seamlessly add new employees to your Employes administration directly from your application preventing double entry</li> 74<li>Synchronise core-HR data effortlessly from your own application or HR system, ensuring data consistency across platforms</li> 75<li>Automate manual input and prevent errors to run payroll by importing hours worked and other wage componets</li> 76</ul> 77<p>To assist you in getting started with our API, this documentation covers the essential aspects of making your initial requests. We highly recommend reading the entire API documentation to gain a comprehensive understanding of all the functionalities and features available.</p> 78<p>By leveraging the Employes API, you can seamlessly integrate and extend the capabilities of your own application, simplifying employee management and streamlining administrative tasks.</p> 79<h2 class="heading heading-2 header-scroll"><div class="heading-anchor anchor waypoint" id="resources"></div><div class="heading-text">Resources</div><a aria-label="Skip link to Resources" class="heading-anchor-icon fa fa-regular fa-anchor" href="#resources"></a></h2> 80<p>To access the resources and endpoints, you will utilize the base URL: <code class="rdmd-code lang- theme-undefined" data-lang="">connect.employes.nl/v4</code>. The base URL acts as the foundation for constructing your API requests and accessing the various functionalities provided by the API.</p> 81<p>When making API calls, prepend the specific endpoints to the base URL to target the desired resource. For example, to retrieve employee data, you would combine the base URL with the /employees endpoint, resulting in<code class="rdmd-code lang- theme-undefined" data-lang="">connect.employes.nl/v4/{company_id}/employees</code>.</p> 82<p>Please note that the /v4 segment in the base URL denotes the API version. As APIs evolve and improve over time, new versions may be introduced to introduce enhancements or changes. It's essential to keep track of the API version you are using to ensure compatibility and take advantage of the latest features.</p> 83<p>Remember to include the appropriate HTTP method (such as GET, POST, PUT, DELETE) and any necessary request parameters or headers to interact with the API effectively. Detailed information about each endpoint, its parameters, and the expected responses can be found in the API reference.</p> 84<h2 class="heading heading-2 header-scroll"><div class="heading-anchor anchor waypoint" id="sandbox-environment"></div><div class="heading-text">Sandbox environment</div><a aria-label="Skip link to Sandbox environment" class="heading-anchor-icon fa fa-regular fa-anchor" href="#sandbox-environment"></a></h2> 85<p>While we do not offer a dedicated sandbox environment for API testing, we recommend adding a test company within your Employes account for conducting experiments and ensuring a smooth integration process.</p> 86<p>By adding a test company, you can simulate real-world scenarios and interact with the API in a controlled environment. This allows you to thoroughly test your integration without affecting live data or disrupting actual operations.</p> 87<h2 class="heading heading-2 header-scroll"><div class="heading-anchor anchor waypoint" id="openapi"></div><div class="heading-text">OpenAPI</div><a aria-label="Skip link to OpenAPI" class="heading-anchor-icon fa fa-regular fa-anchor" href="#openapi"></a></h2> 88<p>
88You can import our api specs in your own favourite tool by using the OAS 3.0.1 definition here: <a href="https://developer.employes.nl/openapi/public-version-40.json" target="" title="">https://developer.employes.nl/openapi/public-version-40.json</a></p></div></div><div align="center" class="Flex Flex_row " justify="between" style="--flex-gap:var(--md)"><div class="UpdatedAt"><p class="DateLine "><i class="icon icon-watch"></i>Updated<!-- --> <!-- -->over 1 year ago<!-- --> </p></div></div><hr class="NextStepsDivider"/><nav aria-label="Pagination Controls" class="PaginationControlsjDYuqu8pBMUy rm-Pagination"><a class="PaginationControls-link254uPEbaP92i PaginationControls-link_right5lsfuICZqXYk" aria-label="Next Page: Authentication" href="/docs/authentication"><div class="PaginationControls-text3qEXHZU00znD PaginationControls-text_right3EIfWubgRVVP">Authentication</div><span class="PaginationControls-iconZbaZ3tgyhNmI icon-arrow-right2"></span></a></nav><div class="rm-PageThumbs PageThumbs"><div class="PageThumbs-helpful">Did this page help you?<div class="PageThumbs-cta"><div class="Dropdown Dropdown_closed" data-testid="dropdown-container"><button aria-label="Yes, this page helped me" aria-haspopup="dialog" class="Button Button_sm PageThumbs-button Dropdown-toggle Button_secondary Button_secondary_text" type="button"><i class="icon icon-thumbs-up-2"></i><span>Yes</span></button></div><div class="Dropdown Dropdown_closed" data-testid="dropdown-container">
88<button aria-label="No, this page did not help me" aria-haspopup="dialog" class="Button Button_sm PageThumbs-button Dropdown-toggle Button_secondary Button_secondary_text" type="button"><i class="icon icon-thumbs-down1"></i><span>No</span></button></div></div></div></div></section><section class="content-toc grid-25 rm-Aside rm-Aside_line "><div class="AIDropdownzmvdRdsNayZl rm-AIDropdown"><button class="Button Button_sm AIDropdown-splitButton2KQ9N2VEvBcT AIDropdown-splitButton_left2tTf2UmhJFyZ Button_secondary_ghost Button_secondary" type="button"><span class="IconWrapper Icon-wrapper2z2wVIeGsiUy"><svg fill="none" viewBox="0 0 24 24" class="Icon Icon3_D2ysxFZ_ll Icon-svg2Lm7f6G9Ly5a" data-name="copy" role="img" style="--icon-color:inherit;--icon-size:inherit;--icon-stroke-width:2px" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" d="M20 9h-9a2 2 0 0 0-2 2v9a2 2 0 0 0 2 2h9a2 2 0 0 0 2-2v-9a2 2 0 0 0-2-2Z" class="icon-stroke-width"></path><path stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" d="M5 15H4a2 2 0 0 1-2-2V4a2 2 0 0 1 2-2h9a2 2 0 0 1 2 2v1" class="icon-stroke-width"></path></svg></span><span>Copy Page</span></button><div class="Dropdown Dropdown_closed" data-testid="dropdown-container"><button aria-haspopup="dialog" class="Button Button_sm AIDropdown-splitButton2KQ9N2VEvBcT AIDropdown-splitButton_rightW_JEw7Q1_yEG Dropdown-toggle Button_secondary_ghost Button_secondary" type="button"><span class="IconWrapper Icon-wrapper2z2wVIeGsiUy"><svg fill="none" viewBox="0 0 24 24" class="Icon Icon3_D2ysxFZ_ll Icon-svg2Lm7f6G9Ly5a" data-name="chevron-down" role="img" style="--icon-color:inherit;--icon-size:inherit;--icon-stroke-width:2px" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" d="m6 9 6 6 6-6" class="icon-stroke-width"></path></svg></span></button></div></div><div><nav aria-label="Table of contents" class="rm-ToC"><ul class="toc-list"><li class="toc-children"><ul><li><a href="#resources">Resources</a></li><li><a href="#sandbox-environment">Sandbox environment</a></li><li><a href="#openapi">OpenAPI</a></li></ul></li></ul></nav></div></section></div></article></div></main><footer aria-label="Status banner" class="Footer2U8XAPoGhlgO AppFooter rm-Banners"></footer><div class="ModalWrapper" id="ChatGPT-modal"></div></div></div></div><div class="ModalWrapper" id="tutorialmodal-root"></div></div></div><div class="ng-non-bindable">
88<script id="ssr-props" type="application/x-ssr-props">{"sidebars":{},"apiBaseUrl":"/","baseUrl":"/","search":{"appId":"","searchApiKey":"","indexName":"readme_search_v2","projectsMeta":[{"modules":{"landing":false,"docs":true,"examples":true,"reference":true,"graphql":false,"changelog":true,"discuss":true,"suggested_edits":false,"logs":false,"custompages":false,"tutorials":false},"id":"646cb94d24e448000aa04195","name":"Employes","subdomain":"employes","subpath":"","nav_names":{"docs":"","reference":"","changelog":"","discuss":"","recipes":"","tutorials":""}}],"urlManagerOpts":{"lang":"en","parent":{"childrenProjects":[]},"project":{"subdomain":"employes"},"version":"4.0"}},"customBlocks":[],"document":{"allow_crawlers":"disabled","processing_status":null,"renderable":{"status":true},"slug":"getting-started","state":"current","title":"Getting Started With the API","type":"basic","updated_at":"2025-05-26T11:21:52.000Z","uri":"/branches/4.0/guides/getting-started","appearance":{"icon":{"name":null,"type":null},"table_of_contents":"default"},"category":{"uri":"/branches/4.0/categories/guides/Getting%20started"},"href":{"dash":"https://dash.readme.com/project/employes/v4.0/docs/getting-started","hub":"https://employes.readme.io/docs/getting-started","github_url":null},"links":{"project":"/projects/me"},"parent":{"uri":null},"privacy":{"view":"public"},"project":{"name":"Employes","subdomain":"employes","uri":"/projects/me"},"content":{"body":"The Employes API enables seamless interaction with an Employes account, providing a RESTful interface that utilizes JSON for data transport. This API serves various use cases, empowering you to:\n\n* Seamlessly add new employees to your Employes administration directly from your application preventing double entry\n* Synchronise core-HR data effortlessly from your own application or HR system, ensuring data consistency across platforms\n* Automate manual input and prevent errors to run payroll by importing hours worked and other wage componets\n\nTo assist you in getting started with our API, this documentation covers the essential aspects of making your initial requests. We highly recommend reading the entire API documentation to gain a comprehensive understanding of all the functionalities and features available.\n\nBy leveraging the Employes API, you can seamlessly integrate and extend the capabilities of your own application, simplifying employee management and streamlining administrative tasks.\n\n## Resources\n\nTo access the resources and endpoints, you will utilize the base URL: `connect.employes.nl/v4`. The base URL acts as the foundation for constructing your API requests and accessing the various functionalities provided by the API.\n\nWhen making API calls, prepend the specific endpoints to the base URL to target the desired resource. For example, to retrieve employee data, you would combine the base URL with the /employees endpoint, resulting in`connect.employes.nl/v4/{company_id}/employees`.\n\nPlease note that the /v4 segment in the base URL denotes the API version. As APIs evolve and improve over time, new versions may be introduced to introduce enhancements or changes. It's essential to keep track of the API version you are using to ensure compatibility and take advantage of the latest features.\n\nRemember to include the appropriate HTTP method (such as GET, POST, PUT, DELETE) and any necessary request parameters or headers to interact with the API effectively. Detailed information about each endpoint, its parameters, and the expected responses can be found in the API reference.\n\n## Sandbox environment\n\nWhile we do not offer a dedicated sandbox environment for API testing, we recommend adding a test company within your Employes account for conducting experiments and ensuring a smooth integration process.\n\nBy adding a test company, you can simulate real-world scenarios and interact with the API in a controlled environment. This allows you to thoroughly test your integration without affecting live data or disrupting actual operations.\n\n## OpenAPI\n\nYou can import our api specs
88in your own favourite tool by using the OAS 3.0.1 definition here: [https://developer.employes.nl/openapi/public-version-40.json](https://developer.employes.nl/openapi/public-version-40.json)","excerpt":"This page will help you get started with our public API","link":{"url":null,"new_tab":false},"next":{"description":null,"pages":[]}},"metadata":{"description":null,"keywords":null,"title":null,"x_import":null,"image":{"uri":null,"url":null}}},"meta":{"baseUrl":"/","description":"This page will help you get started with our public API","hidden":false,"image":[],"metaTitle":"Getting Started With the API","robots":"noindex","slug":"getting-started","title":"Getting Started With the API","type":"docs","updatedAt":"2025-05-26T11:21:52.000Z"},"rdmd":{"dehydrated":{"toc":"\u003cnav aria-label=\"Table of contents\" class=\"rm-ToC\">\u003cul class=\"toc-list\">\u003cli class=\"toc-children\">\u003cul>\u003cli>\u003ca href=\"#resources\">Resources\u003c/a>\u003c/li>\u003cli>\u003ca href=\"#sandbox-environment\">Sandbox environment\u003c/a>\u003c/li>\u003cli>\u003ca href=\"#openapi\">OpenAPI\u003c/a>\u003c/li>\u003c/ul>\u003c/li>\u003c/ul>\u003c/nav>","body":"\u003cstyle>/*! tailwindcss v4.1.17 | MIT License | https://tailwindcss.com */\n@layer theme, base, components, utilities;\n@layer utilities;\n\u003c/style>\u003cp>The Employes API enables seamless interaction with an Employes account, providing a RESTful interface that utilizes JSON for data transport. This API serves various use cases, empowering you to:\u003c/p>\n\u003cul>\n\u003cli>Seamlessly add new employees to your Employes administration directly from your application preventing double entry\u003c/li>\n\u003cli>Synchronise core-HR data effortlessly from your own application or HR system, ensuring data consistency across platforms\u003c/li>\n\u003cli>Automate manual input and prevent errors to run payroll by importing hours worked and other wage componets\u003c/li>\n\u003c/ul>\n\u003cp>To assist you in getting started with our API, this documentation covers the essential aspects of making your initial requests. We highly recommend reading the entire API documentation to gain a comprehensive understanding of all the functionalities and features available.\u003c/p>\n\u003cp>By leveraging the Employes API, you can seamlessly integrate and extend the capabilities of your own application, simplifying employee management and streamlining administrative tasks.\u003c/p>\n\u003ch2 class=\"heading heading-2 header-scroll\">\u003cdiv class=\"heading-anchor anchor waypoint\" id=\"resources\">\u003c/div>\u003cdiv class=\"heading-text\">Resources\u003c/div>\u003ca aria-label=\"Skip link to Resources\" class=\"heading-anchor-icon fa fa-regular fa-anchor\" href=\"#resources\">\u003c/a>\u003c/h2>\n\u003cp>To access the resources and endpoints, you will utilize the base URL: \u003ccode class=\"rdmd-code lang- theme-undefined\" data-lang=\"\">connect.employes.nl/v4\u003c/code>. The base URL acts as the foundation for constructing your API requests and accessing the various functionalities provided by the API.\u003c/p>\n\u003cp>When making API calls, prepend the specific endpoints to the base URL to target the desired resource. For example, to retrieve employee data, you would combine the base URL with the /employees endpoint, resulting in\u003ccode class=\"rdmd-code lang- theme-undefined\" data-lang=\"\">connect.employes.nl/v4/{company_id}/employees\u003c/code>.\u003c/p>\n\u003cp>Please note that the /v4 segment in the base URL denotes the API version. As APIs evolve and improve over time, new versions may be introduced to introduce enhancements or changes. It's essential to keep track of the API version you are using to ensure compatibility and take advantage of the latest features.\u003c/p>\n\u003cp>Remember to include the appropriate HTTP method (such as GET, POST, PUT, DELETE) and any necessary request parameters or headers to interact with the API effectively. Detailed information about each endpoint, its parameters, and the expected responses can be found in the API reference.\u003c/p>\n\u003ch2 class=\"heading heading-2 header-scroll\">\u003cdiv class=\"heading-anchor anchor waypoint\" id=\"sandbox-environment\">\u003c/div>\u003cdiv class=\"heading-text\">Sandbox environment\u003c/div>
88\u003ca aria-label=\"Skip link to Sandbox environment\" class=\"heading-anchor-icon fa fa-regular fa-anchor\" href=\"#sandbox-environment\">\u003c/a>\u003c/h2>\n\u003cp>While we do not offer a dedicated sandbox environment for API testing, we recommend adding a test company within your Employes account for conducting experiments and ensuring a smooth integration process.\u003c/p>\n\u003cp>By adding a test company, you can simulate real-world scenarios and interact with the API in a controlled environment. This allows you to thoroughly test your integration without affecting live data or disrupting actual operations.\u003c/p>\n\u003ch2 class=\"heading heading-2 header-scroll\">\u003cdiv class=\"heading-anchor anchor waypoint\" id=\"openapi\">\u003c/div>\u003cdiv class=\"heading-text\">OpenAPI\u003c/div>\u003ca aria-label=\"Skip link to OpenAPI\" class=\"heading-anchor-icon fa fa-regular fa-anchor\" href=\"#openapi\">\u003c/a>\u003c/h2>\n\u003cp>You can import our api specs in your own favourite tool by using the OAS 3.0.1 definition here: \u003ca href=\"https://developer.employes.nl/openapi/public-version-40.json\" target=\"\" title=\"\">https://developer.employes.nl/openapi/public-version-40.json\u003c/a>\u003c/p>","css":"/*! tailwindcss v4.1.17 | MIT License | https://tailwindcss.com */\n@layer theme, base, components, utilities;\n@layer utilities;\n"},"opts":{"hardBreaks":true,"alwaysThrow":false,"compatibilityMode":false,"copyButtons":true,"correctnewlines":false,"markdownOptions":{"fences":true,"commonmark":true,"gfm":true,"ruleSpaces":false,"listItemIndent":"1","spacedTable":true,"paddedTable":true},"normalize":true,"lazyImages":true,"reusableContent":{"tags":{},"disabled":false,"serialize":true,"wrap":true},"safeMode":false,"settings":{"position":true},"theme":"light","customBlocks":{},"componentTypes":{},"resourceID":"/branches/4.0/guides/getting-started","resourceType":"page","components":{},"baseUrl":"/","terms":[{"_id":"646cb94d24e448000aa04196","term":"parliament","definition":"Owls are generally solitary, but when seen together the group is called a 'parliament'!"}],"variables":{"user":{},"defaults":[{"source":"server","_id":"65367f1e2f105e0b9f0ed2b1","name":"basePath","default":"v4","apiSetting":"649d546fdd37060059110557","type":""},{"source":"security","_id":"65367f1e2f105e0b9f0ed2b0","name":"bearerAuth","type":"http","scheme":"bearer","apiSetting":"649d546fdd37060059110557"}]}}},"sidebar":[{"pages":[{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"getting-started","title":"Getting Started With the API","type":"basic","updatedAt":"2026-05-04T18:52:23.000Z","pages":[],"category":"/branches/4.0/categories/guides/Getting%20started","uri":"/branches/4.0/guides/getting-started","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"authentication","title":"Authentication","type":"basic","updatedAt":"2026-05-04T18:52:23.000Z","pages":[],"category":"/branches/4.0/categories/guides/Getting%20started","uri":"/branches/4.0/guides/authentication","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"responses","title":"Responses","type":"basic","updatedAt":"2026-05-04T18:52:23.000Z","pages":[],"category":"/branches/4.0/categories/guides/Getting%20started","uri":"/branches/4.0/guides/responses","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"pagination","title":"Pagination","type":"basic","updatedAt":"2026-05-04T18:52:23.000Z","pages":[],"category":"/branches/4.0/categories/guides/Getting%20started","uri":"/branches/4.0/guides/pagination","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"rate-limits","title":"Rate limits","type":"basic","updatedAt":"2026-05-04T18:52:23.000Z","pages":[],"category":"/branches/4.0/categories/guides/Getting%20started","uri":"/branches/4.0/guides/rate-limits","parent":null}],"title":"Getting started","uri":"/branches/4.0/categories/guides/Getting%20started"},{"pages":[{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"importing-employees","title":"Add employees","type":"basic","updatedAt":"2026-05-04T18:52:23.000Z","pages":[],"category":"/branches/4.0/categories/guides/USEcases","uri":"/branches/4.0/guides/importing-employees","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"importing-data-to-a-payrun","title":"Import data in a payrun","type":"basic","updatedAt":"2026-05-04T18:52:23.000Z","pages":[],"category":"/branches/4.0/categories/guides/USEcases","uri":"/branches/4.0/guides/importing-data-to-a-payrun","parent":null}],"title":"USEcases","uri":"/branches/4.0/categories/guides/USEcases"},{"pages":[{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"regulations","title":"List of wage-components","type":"basic","updatedAt":"2026-05-04T18:52:23.000Z","pages":[],"category":"/branches/4.0/categories/guides/Definitions","uri":"/branches/4.0/guides/regulations","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"list-of-nationalities","title":"List of nationalities","type":"basic","updatedAt":"2026-05-04T18:52:23.000Z","pages":[],"category":"/branches/4.0/categories/guides/Definitions","uri":"/branches/4.0/guides/list-of-nationalities","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"list-of-countries","title":"List of countries","type":"basic","updatedAt":"2026-05-04T18:52:23.000Z","pages":[],"category":"/branches/4.0/categories/guides/Definitions","uri":"/branches/4.0/guides/list-of-countries","parent":null}],"title":"Definitions","uri":"/branches/4.0/categories/guides/Definitions"},{"pages":[{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"future-updates","title":"Future updates","type":"basic","updatedAt":"2026-05-04T18:52:23.000Z","pages":[],"category":"/branches/4.0/categories/guides/Other","uri":"/branches/4.0/guides/future-updates","parent":null}],"title":"Other","uri":"/branches/4.0/categories/guides/Other"}],"aiConfig":{"enabled":false,"settings":{"errors":null,"styleguide":null,"warnings":null}},"config":{"algoliaIndex":"readme_search_v2","amplitude":{"apiKey":"8b550cf334a130e3d6ea41a88b894d8","enabled":"true","sessionReplay":{"enabled":"true","sampleRate":"0.1"}},"api":{"upload":{"fileSizeLimit":10485760,"fileSizeLimitFormatted":"10MB"}},"asset_url":"https://cdn.readme.io","dashDomain":"dash.readme.com","domain":"readme.io","domainFull":"https://dash.readme.com","encryptedLocalStorageKey":"ekfls-2025-03-27","fullstory":{"enabled":true,"orgId":"FSV9A"},"git":{"preview":"https://githug-prod.gitto.rdme.io","sync":{"bitbucket":{"installationLink":"https://developer.atlassian.com/console/install/310151e6-ca1a-4a44-9af6-1b523fea0561?signature=AYABeMn9vqFkrg%2F1DrJAQxSyVf4AAAADAAdhd3Mta21zAEthcm46YXdzOmttczp1cy13ZXN0LTI6NzA5NTg3ODM1MjQzOmtleS83MDVlZDY3MC1mNTdjLTQxYjUtOWY5Yi1lM2YyZGNjMTQ2ZTcAuAECAQB4IOp8r3eKNYw8z2v%2FEq3%2FfvrZguoGsXpNSaDveR%2FF%2Fo0BHUxIjSWx71zNK2RycuMYSgAAAH4wfAYJKoZIhvcNAQcGoG8wbQIBADBoBgkqhkiG9w0BBwEwHgYJYIZIAWUDBAEuMBEEDOJgARbqndU9YM%2FRdQIBEIA7unpCah%2BIu53NA72LkkCDhNHOv%2BgRD7agXAO3jXqw0%2FAcBOB0%2F5LmpzB5f6B1HpkmsAN2i2SbsFL30nkAB2F3cy1rbXMAS2Fybjphd3M6a21zOmV1LXdlc3QtMTo3MDk1ODc4MzUyNDM6a2V5LzQ2MzBjZTZiLTAwYzMtNGRlMi04NzdiLTYyN2UyMDYwZTVjYwC4AQICAHijmwVTMt6Oj3F%2B0%2B0cVrojrS8yZ9ktpdfDxqPMSIkvHAGT%2FMTvCxC3XwnwlulZe975AAAAfjB8BgkqhkiG9w0BBwagbzBtAgEAMGgGCSqGSIb3DQEHATAeBglghkgBZQMEAS4wEQQMMUUe9d1YmFOo373TAgEQgDuJo7TayM6NL19Sj9RPooRrl8rYxwKgvu9gkLNc3GuyyovWI1xA2qTr0LQzMRsf3imrAWsywzPcsjnvuAAHYXdzLWttcwBLYXJuOmF3czprbXM6dXMtZWFzdC0xOjcwOTU4NzgzNTI0MzprZXkvNmMxMjBiYTAtNGNkNS00OTg1LWI4MmUtNDBhMDQ5NTJjYzU3ALgBAgIAeLKa7Dfn9BgbXaQmJGrkKztjV4vrreTkqr7wGwhqIYs5AZR28Sibv2eBxSIg2MydtvEAAAB%2BMHwGCSqGSIb3DQEHBqBvMG0CAQAwaAYJKoZIhvcNAQcBMB4GCWCGSAFlAwQBLjARBAzzWhThsIgJwrr%2FY2ECARCAOxoaW9pob21lweyAfrIm6Fw7gd8D%2B%2F8LHk4rl3jjULDM35%2FVPuqBrqKunYZSVCCGNGB3RqpQJr%2FasASiAgAAAAAMAAAQAAAAAAAAAAAAAAAAAEokowLKsF1tMABEq%2BKNyJP%2F%2F%2F%2F%2FAAAAAQAAAAAAAAAAAAAAAQAAADJLzRcp6MkqKR43PUjOiRxxbxXYhLc6vFXEutK3%2BQ71yuPq4dC8pAHruOVQpvVcUSe8dptV8c7wR8BTJjv%2F%2FNe8r0g%3D&product=bitbucket"}}},"hubspot":{"portalId":"9401557"},"metrics":{"billingCronEnabled":"true","dashUrl":"https://m.readme.io","defaultUrl":"https://m.readme.io","exportMaxRetries":12,"wsUrl":"wss://m.readme.io"},"micro":{"baseUrl":"https://micro-beta.readme.com"},"novuNotification":{"appId":"ob_MiAPOPqgP","showUnreleasedWorkflows":false},"proxyUrl":"https://try.readme.io","readmeRecaptchaSiteKey":"6LesVBYpAAAAAESOCHOyo2kF9SZXPVb54Nwf3i2x","releaseVersion":"5.906.1","reservedWords":{"tools":["execute-request","get-endpoint","get-server-variables","list-endpoints","list-specs","search-en
88dpoints","search","fetch"]},"sentry":{"dsn":"https://[email protected]/2052166","enabled":true},"shMigration":{"promoVideo":"","forceWaitlist":false,"migrationPreview":false},"sslBaseDomain":"readmessl.com","sslGenerationService":"ssl.readmessl.com","superHub":{"newProjectsEnabled":true},"tiptapCloud":{"appId":"8mzorjl9","url":"wss://8mzorjl9.collab.tiptap.cloud"},"wootric":{"accountToken":"NPS-122b75a4","enabled":true}},"context":{"labs":{},"user":{"isAuthenticated":false,"notifications":{}},"terms":[{"_id":"646cb94d24e448000aa04196","term":"parliament","definition":"Owls are generally solitary, but when seen together the group is called a 'parliament'!"}],"variables":{"user":{},"defaults":[{"source":"server","_id":"65367f1e2f105e0b9f0ed2b1","name":"basePath","default":"v4","apiSetting":"649d546fdd37060059110557","type":""},{"source":"security","_id":"65367f1e2f105e0b9f0ed2b0","name":"bearerAuth","type":"http","scheme":"bearer","apiSetting":"649d546fdd37060059110557"}]},"navigation":[],"project":{"flags":{"agentMetrics":false,"agentSkills":false,"aiDocsAudit":false,"aiPageLinting":false,"aiTranslation":false,"aiWriter":false,"allowApiExplorerJsonEditor":false,"allowBlockedDomainLaunch":false,"allowLaunchWithoutCard":false,"allowReusableOTPs":false,"allowUnsafeCustomHtmlSuggestionsFromNonAdmins":false,"allowXFrame":false,"alwaysShowDocPublishStatus":false,"apiAccessRevoked":false,"askAiOverride":"","bidiSync":true,"bidiSyncBitbucketSelfServe":false,"bidiSyncSkipIndexedHistory":true,"bidiSyncUseGitCli":false,"bidiSyncUseOdbAlternates":true,"bitbucketCloudSync":false,"bitbucketDirectEvents":false,"changelogRssAlwaysPublic":false,"changelogsInGitto":true,"childManagedBidi":false,"collaborativeReview":false,"correctnewlines":false,"customDomainAdminBypass":false,"directGoogleToStableVersion":false,"disableAiChat":false,"disableAiInlineEditor":false,"disableAiWriter":false,"disableAnonForum":false,"disableAskAiApi":false,"disableAutoTranslate":false,"disableDiscussionSpamRecaptchaBypass":false,"disableDocsAudit":false,"disablePageLinter":false,"disablePasswordlessLogin":false,"disableSignups":false,"disableSuperframe":false,"dynamicLlmsTxt":false,"enableOidc":false,"enterprise":false,"enterpriseAiWriter":false,"externalSdkSnippets":false,"gittoUseConnectionPooling":false,"gittoUseExperimentalMDXCache":false,"gitTranslations":false,"googleAuthEnabled":false,"graphql":false,"hideAiFeatures":false,"hideEnforceSSO":false,"hubGoBridge":false,"inlineComments":false,"inlineLintingViolations":false,"jwtReplacePermissions":false,"mcpOauth":false,"mcpSendFeedback":false,"mdx":false,"mdxish":true,"mdxishEditor":true,"mdxSanitizeComments":false,"newEditorDash":true,"newExplorerReducer":false,"newIframeStructure":false,"oauth":false,"passwordlessLogin":"default","prefetch":false,"rdmdCompatibilityMode":false,"requiresJQuery":false,"reviewWorkflow":true,"singleProjectEnterprise":false,"staging":false,"star":false,"streamingSsr":false,"superHub":true,"superHubBranchReviewSummaries":false,"superHubMigrationSelfServeFlow":true,"superHubMsTeamsAppPackage":false,"superHubMsTeamsNotifications":false,"superHubMultiGuides":false,"superHubPlanManagement":true,"superHubPreview":false,"superHubSlack":false,"superHubSlackNotifications":false,"superHubUiTesting":false,"tokenBasedBilling":false,"translation":false,"useDeprecatedSafelistMethod":false,"dashReact":false,"superHubBranchReviewActions":false},"versions":[{"__v":5,"_id":"646cb94d24e448000aa0419c","createdAt":"2023-05-23T13:02:05.817Z","updatedAt":"2026-05-04T18:42:20.706Z","project":"646cb94d24e448000aa04195","version":"4.0","version_clean":"4.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":[],"releaseDate":"2023-05-23T13:02:05.817Z","pdfStatus":"","apiRegistries":[{"filename":"public-version-40.json","uuid":"a9dt9t2anlo2z7rbc"}],"source":"readme"}],"stable":{"__v":5,"_id":"646cb94d24e448000aa0419c","createdAt":"2023-05-23T13:02:05.817Z","updatedAt":"2026-05-04T18:42:20.706Z","project":"646cb94d24e448000aa04195","version":"4.0","version_clean":"4.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":[],"releaseDate":"2023-05-23T13:02:05.817Z","pdfStatus":"","apiRegistries":[{"filename":"public-version-40.json","uuid":"a9dt9t2anlo2z7rbc"}],"source":"readme"},"_id":"646cb94d24e448000aa04195","accessRules":{"branch_approve":{"admin":true,"editor":false},"branch_merge":{"admin":true,"editor":false},"version_edit":{"admin":true,"editor":false}},"ai":{"chat":{"knowledge":{"use_project_knowledge":false},"models":[]},"discovery":{"content_signal":{"ai_train":false,"search":false,"ai_input":false},"link_headers":true,"markdown_negotiation":true,"agent_hint_banner":true,"api_catalog":true,"agent_skills_index":true,"mcp_server_card":true,"webmcp":true,"oauth":{"type":"none","issuer_url":"","authorization_servers":[],"resource_identifier":"","scopes_supported":[]},"show_sub_pages":false,"show_sibling_pages":false,"show_whats_next":false}},"appearance":{"allowApiExplorerJsonEditor":false,"borderRadius":"default","changelog":{"layoutExpanded":false,"showAuthor":true,"showExactDate":false},"referenceFlatSections":"disabled","referenceLayout":"row","referenceParamFont":"default","referenceParamInputs":"all","referenceSimpleMode":true,"methodBadgeStyle":"classic","oneOfLayout":"dropdown","showExactDate":false,"showMethodInSidebar":true,"link_logo_to_url":false,"theme":"solid","theme_preset":"default","colorScheme":"system","overlay":"triangles","landing":true,"sticky":false,"hide_logo":false,"childrenAsPills":false,"subheaderStyle":"links","splitReferenceDocs":false,"showMetricsInReference":false,"rdmd":{"callouts":{"useIconFont":false},"theme":{"background":"","border":"","markdownEdge":"","markdownFont":"","markdownFontSize":"","markdownLineHeight":"","markdownRadius":"","markdownText":"","markdownTitle":"","markdownTitleFont":"","mdCodeBackgroun
88d":"","mdCodeFont":"","mdCodeRadius":"","mdCodeTabs":"","mdCodeText":"","tableEdges":"","tableHead":"","tableHeadText":"","tableRow":"","tableStripe":"","tableText":"","text":"","title":""}},"main_body":{"type":"links"},"colors":{"highlight":"","main":"#005148","main_dark":"","main_alt":"","header_text":"","body_highlight":"#528afa","body_highlight_dark":"","custom_login_link_color":"","page_background":"","page_background_dark":"","background_tint":"","background_tint_dark":"","border":"","border_dark":"","header":"","header_dark":"","askai_button_bg":"","askai_button_bg_dark":"","sidebar_border":"","sidebar_border_dark":""},"typography":{"headline":"Open+Sans:400:sans-serif","body":"Open+Sans:400:sans-serif","code":"","spacing":null,"typekit":false,"tk_key":"","tk_headline":"","tk_body":""},"header":{"img":[],"img_size":"auto","img_pos":"cc","linkStyle":"buttons","style":"solid","subnav":{"alignment":"start"}},"body":{"style":"none"},"promos":[{"_id":"646cb94d24e448000aa04197","title":"Employes Developer Hub","text":"Welcome to the Employes developer hub. You'll find comprehensive guides and documentation to help you start working with Employes as quickly as possible, as well as support if you get stuck. Let's jump right in!","extras":{"type":"buttons","buttonPrimary":"get-started","buttonSecondary":"docs"}}],"layout":{"full_width":false,"style":"classic","sticky_header":null},"logo":["https://files.readme.io/84a1be1031d6e02357bd2ad201aed218d4bcbb469f948a87dc0a3e52c976f3ff-Employees_by_Shine_Logo_White_1.png","84a1be1031d6e02357bd2ad201aed218d4bcbb469f948a87dc0a3e52c976f3ff-Employees_by_Shine_Logo_White_1.png",3200,940,"#ffffff",null,"691dbcd1b3a2802a43ff18bd"],"loginLogo":[],"logo_white":["https://files.readme.io/3ec327f-small-employes-logos-ideTjTYDl0.png","3ec327f-small-employes-logos-ideTjTYDl0.png",346,80,"#000000","https://files.readme.io/c5e1bbc-employes-logos-ideTjTYDl0.png"],"logo_white_use":false,"logo_large":true,"logo_size":"default","favicon":["https://files.readme.io/d8fafacc6c73905bcf382eea071848f35389b095a8e4594b05b0884b85f066b0-favicon.ico","d8fafacc6c73905bcf382eea071848f35389b095a8e4594b05b0884b85f066b0-favicon.ico",32,32,"#000000",null,"691dbcd7126376f107c45ecb"],"tocVariant":"line","stylesheet":"","stylesheet_hub2":"","stylesheet_hub3":"","javascript":"","javascript_hub2":"","html_promo":"","html_body":"","html_footer":"","html_head":"","html_footer_meta":"","global_landing_page":{"html":"","redirect":""},"html_hidelinks":false,"collapsibleCategories":false,"showBreadcrumbs":false,"showPageIcons":true,"showVersion":true,"searchModal":"classic","hideTableOfContents":false,"nextStepsLabel":"","ai_dropdown":"enabled","ai_options":{"ask_ai":"disabled","chatgpt":"enabled","claude":"enabled","clipboard":"enabled","copilot":"enabled","mcp":{"command":"enabled","config":"enabled","cursor":"enabled","vscode":"enabled"},"view_as_markdown":"enabled"}},"custom_domain":"developer.employes.nl","description":"","hstsIncludeSubdomains":false,"planSchedule":{"stripeScheduleId":null,"changeDate":null,"nextPlan":null},"planStatus":"active","error404":"","first_page":"docs","git":{"migration":{"createRepository":{"end":"2025-05-19T20:33:37.413Z","start":"2025-05-19T20:33:37.006Z","status":"successful"},"transformation":{"end":"2025-05-19T20:33:37.893Z","start":"2025-05-19T20:33:37.575Z","status":"successful"},"migratingPages":{"end":"2025-05-19T20:33:38.787Z","start":"2025-05-19T20:33:37.976Z","status":"successful"},"enableSuperhub":{"end":"2025-05-19T20:34:55.843Z","start":"2025-05-19T20:34:55.842Z","status":"successful"}},"renamedSlugs":[]},"glossaryTerms":[{"_id":"646cb94d24e448000aa04196","term":"parliament","definition":"Owls are generally solitary, but when seen together the group is called a 'parliament'!"}],"graphqlSchema":"","gracePeriod":{"enabled":true,"endsAt":"2026-09-01T12:07:01.260Z"},"healthCheck":{"provider":"","settings":{}},"i18n":{"defaultLanguage":"en","languages":[{"code":"en","type":"manual"}],"state":"enabled"},"intercom":"","is_active":true,"branchSharing":"enabled","internal":"","jwtExpirationTime":0,"landing_bottom":[{"type":"text","alignment":"left","title":"Tekst","text":"Tekst"},{"type":"links","alignment":"left"}],"llms_txt":true,"llms_txt_options":{"split":false,"query":null,"use_custom":null},"mcp":{"state":"disabled"},"mdxishMigrationStatus":{"migratedFrom":"mdx"},"metrics":{"monthlyLimit":0,"monthlyPurchaseLimit":0,"thumbsEnabled":true,"meteredBilling":{}},"modules":{"landing":false,"docs":true,"examples":true,"reference":true,"graphql":false,"changelog":true,"discu
88ss":true,"suggested_edits":false,"custompages":false,"tutorials":false},"name":"Employes","nav_names":{"docs":"","reference":"","changelog":"","discuss":"","recipes":"","tutorials":""},"oauth_url":"","onboardingCompleted":{"api":true,"appearance":true,"documentation":true,"domain":true,"jwt":true,"logs":false,"metricsSDK":false,"aiReady":false,"team":false,"gitSync":false},"openapiVisibility":"public","owlbot":{"copilot":{"enabled":false,"hasBeenUsed":false,"installedCustomPage":""},"enabled":false,"newExperience":true,"isPaying":false,"exampleQuestions":{"question1":"","question2":"","question3":""},"customization":{"tone":"neutral","customTone":"","answerLength":"medium","forbiddenWords":"","defaultAnswer":"","showAiDisclaimer":false,"showInSearch":true,"advancedInstruction":"","advancedModeEnabled":false},"llmOptions":{"model":{}},"modelList":[],"knowledge":"","knowledgeSegregation":false},"plan":"free","planOverride":"","readmeScore":{"totalScore":142,"components":{"newDesign":{"enabled":true,"points":25},"reference":{"enabled":true,"points":50},"tryItNow":{"enabled":true,"points":35},"syncingOAS":{"enabled":false,"points":10},"customLogin":{"enabled":false,"points":25},"metrics":{"enabled":false,"points":40},"recipes":{"enabled":false,"points":15},"pageVoting":{"enabled":true,"points":1},"suggestedEdits":{"enabled":true,"points":10},"support":{"enabled":true,"points":5},"htmlLanding":{"enabled":false,"points":5},"guides":{"enabled":true,"points":10},"changelog":{"enabled":true,"points":5},"glossary":{"enabled":false,"points":1},"variables":{"enabled":true,"points":1},"integrations":{"enabled":false,"points":2}}},"reCaptchaSiteKey":"","reference":{"alwaysUseDefaults":true,"autoFillRequestExample":false,"defaultExpandResponseExample":false,"defaultExpandResponseSchema":false,"enableOAuthFlows":false,"fillOptionalObjectsOnExpand":true,"showOpenAPIDownload":false},"seo":{"overwrite_title_tag":false},"searchSettings":{"default_to_current_project":false,"show_project_filter":true,"sort_projects_alphabetically":false},"ssl":{"minTLS":"1.2"},"subdomain":"employes","subpath":"","topnav":{"left":[],"right":[{"type":"user"}],"bottom":[],"edited":true},"trial":{"trialDeadlineEnabled":true,"trialEndsAt":"2023-06-13T13:02:05.373Z"},"translate":{"provider":"transifex","show_widget":false,"key_public":"","org_name":"","project_name":"","languages":[]},"url":"https://employes.nl","variableDefaults":[{"apiSetting":"649d546fdd37060059110557","name":"basePath","default":"v4","source":"server","type":""},{"apiSetting":"649d546fdd37060059110557","name":"bearerAuth","scheme":"bearer","source":"security","type":"http"}],"childrenProjects":[],"derivedPlan":"free","fullBaseUrl":"https://employes.readme.io/","isExternalSnippetActive":false,"isPublished":true,"planTrial":"free","shouldGateDash":true,"webhookEnabled":false,"isHubEditable":true},"projectStore":{"data":{"allow_crawlers":"disabled","canonical_url":null,"default_version":{"name":"4.0"},"description":null,"git":{"repository_name":null,"connection":{"repository":null,"organization":null,"status":"none"},"remediation_status":null,"remediated_at":null,"remediation_initiated_by":null,"remediation_dry_run":null,"remediation_job_id":null},"glossary":[{"term":"parliament","definition":"Owls are generally solitary, but when seen together the group is called a 'parliament'!","inherited":false}],"homepage_url":"https://employes.nl","created_at":null,"updated_at":null,"id":"646cb94d24e448000aa04195","name":"Employes","parent":null,"sitemap":"disabled","llms_txt":"enabled","subdomain":"employes","suggested_edits":"disabled","notification_settings":{"project_topic_key":null},"uri":"/projects/me","variable_defaults":[{"name":"basePath","default":"v4","source":"server","type":"","id":null},{"name":"bearerAuth","scheme":"bearer","source":"security","type":"http","id":null}],"webhooks":[],"api_designer":{"allow_editing":"enabled"},"custom_login":{"jwt_secret":null,"jwt_expiration_time":0,"login_url":null,"logout_url":null},"features":{"mdx":"disabled"},"onboarding_completed":{"api":true,"appearance":true,"documentation":true,"domain":true,"jwt":true,"logs":false,"metricsSDK":false,"ai_ready":false,"team":false,"git_sync":false},"owner":{"id":null,"email":null,"name":null},"privacy":{"branches":"enabled","openapi":"public","password":null,"view":"public"},"refactored":{"status":"enabled","migrated":"successful"},"seo":{"overwrite_title_tag":"disabled"},"ssl":{"min_tls_version":"1.2"},"hsts":{"include_subdomains":false},"feature_rules":{"merge":{"requirements":[],"allow_override":[]}},"god_mode":{"is_active":null,"flags":{},"admin_limit_override":null,"notes":null,"legacy_css":null,"children_limit":null,"extra_sections_limit":null,"owlbot":{"enabled":null,"new_experience":null,"trial_ends_at":null},"salesforce":{"account_id":null},"enterprise_notes":{"account_name":null,"owner_csm":null,"owner_sales":null,"status":null,"superhub_migration_eligibility":null},"mdxish_migration_status":{"migrated_at":null,"migrated_from":null,"reverted_at":null,"source":null}},"mcp":{"state":"disabled","custom_tools":[],"disabled_routes":[],"explicitly_enabled_routes":[],"disabled_tools":[],"has_password":false,"oauth_pages":{"auth_url":null,"success_url":null,"error_url":null},"openai_challenge_token":null,"oauth_credentials":{},"privacy":{"password":null}},"plan":{"type":"free","admin_limit_override_active":false,"bills_extra_admin_seats":false,"extra_sections_limit":0,"override":null,"stripe_subscription_id":null,"grace_peri
88od":{"enabled":true,"end_date":"2026-09-01T12:07:01.260Z"},"trial":{"active":false,"enabled":null,"expired":false,"end_date":"2023-06-13T13:02:05.373Z"}},"redirects":[],"reference":{"api_sdk_snippets":"enabled","experimental_performance_mode":"disabled","defaults":"always_use","show_openapi_download":"disabled","fill_optional_objects_on_expand":"enabled","json_editor":"disabled","method_badge_style":"classic","flat_sections":"disabled","param_font":"default","param_inputs":"all","oauth_flows":"disabled","oneof_layout":"dropdown","request_history":"disabled","request_examples":"collapsed","response_examples":"collapsed","response_schemas":"collapsed","show_method_in_sidebar":"enabled","webhook_badge":"pill","sdk_snippets":{"external":"disabled"}},"llms_txt_options":{"split":{"enabled":"disabled","categories":"enabled"},"query":{"enabled":"disabled"},"custom":{"enabled":"disabled"}},"custom_domain":{"name":"developer.employes.nl","target":null,"validation":{"status":null,"code":null}},"ai":{"discovery":{"content_signal":{"ai_train":false,"search":false,"ai_input":false},"link_headers":true,"markdown_negotiation":true,"agent_hint_banner":true,"show_sub_pages":false,"show_sibling_pages":false,"show_whats_next":false,"api_catalog":true,"agent_skills_index":true,"mcp_server_card":true,"webmcp":true,"oauth":{"type":"none","issuer_url":null,"authorization_servers":[],"resource_identifier":null,"scopes_supported":[]}},"hidden":false,"readiness":{"status":null,"score":null,"grade":null,"category_scores":null,"pages":null,"summary":null,"results":null,"resolutions":null,"cap":null,"last_checked_at":null,"error_message":null},"ai_writer":{"enabled":true},"docs_audit":{"enabled":true},"inline_editor":{"enabled":true},"linter":{"enabled":true},"chat":{"enabled":true,"models":[],"knowledge":{"custom_knowledge":null,"use_project_knowledge":false}},"owlbot":{"enabled":false,"new_experience":true,"placements":["header","in_search"],"is_paying":false,"trial":{"is_paying":false}},"slack":{"writer":{"allow_branch_deletion":false,"allow_branch_merge":false}}},"integrations":{"aws":{"readme_webhook_login":{"region":null,"external_id":null,"role_arn":null,"usage_plan_id":null}},"bing":{"verify":null},"google":{"analytics":null,"site_verification":null},"heap":{"id":null},"koala":{"key":null},"localize":{"key":null},"postman":{"key":null,"client_id":null,"client_secret":null,"is_connected":false},"recaptcha":{"site_key":null,"secret_key":null},"segment":{"key":null,"domain":null},"speakeasy":{"key":null,"spec_url":null},"typekit":{"key":null},"zendesk":{"subdomain":null},"intercom":{"app_id":null,"secure_mode":{"key":null}}},"pages":{"default_visibility":"public","not_found":null},"permissions":{"appearance":{"private_label":"disabled","custom_code":{"css":"disabled","html":"disabled","js":"disabled"}},"branches":{"merge":{"admin":true,"editor":false},"approve":{"admin":true,"editor":false}},"versions":{"edit":{"admin":true,"editor":false}}},"metrics":{"monthly_purchase_limit":0,"monthly_limit":0,"pii":{"enabled":true},"voting":{"page_quality":{"enabled":true}}},"health_check":{"provider":"none","settings":{"manual":{"status":"down","url":null},"statuspage":{"id":null}}},"appearance":{"border_radius":"default","toc_variant":"line","changelog":{"layout":"collapsed","show_author":true,"show_exact_date":false},"layout":{"full_width":"disabled","sticky_header":null,"style":"classic"},"brand":{"primary_color":"#005148","primary_color_dark":null,"link_color":"#528afa","link_color_dark":null,"theme":"system","theme_preset":"default","background":{"color":null,"color_dark":null,"tint":null,"tint_dark":null},"border":{"color":null,"color_dark":null},"header":{"color":null,"color_dark":null},"sidebar":{"border":null,"border_dark":null},"askai":{"color":null,"color_dark":null}},"markdown":{"callouts":{"icon_font":"emojis"}},"table_of_contents":"enabled","whats_next_label":null,"landing_page":{"sections":[{"type":"text","alignment":"left","title":"Tekst","text":"Tekst","html":null,"page_type":null,"side":null,"media_type":null,"media_html":null,"media_image":null,"media_code":null,"group0":null,"group1":null,"group2":null},{"type":"links","alignment":"left","title":null,"text":null,"html":null,"page_type":null,"side":null,"media_type":null,"media_html":null,"media_image":null,"media_code":null,"group0":null,"group1":null,"group2":null}],"promo":{"title":"Employes Developer Hub","text":"Welcome to the Employes developer hub. You'll find comprehensive guides and documentation to help you start working with Employes as quickly as possible, as well as supp
88ort if you get stuck. Let's jump right in!","content_type":"buttons","html":null,"button_primary":"get-started","button_secondary":"docs"}},"footer":{"readme_logo":"show"},"logo":{"size":"large","dark_mode":{"uri":null,"url":"https://files.readme.io/3ec327f-small-employes-logos-ideTjTYDl0.png","name":"3ec327f-small-employes-logos-ideTjTYDl0.png","width":346,"height":80,"color":"#000000","links":{"original_url":"https://files.readme.io/c5e1bbc-employes-logos-ideTjTYDl0.png"}},"main":{"uri":"/images/691dbcd1b3a2802a43ff18bd","url":"https://files.readme.io/84a1be1031d6e02357bd2ad201aed218d4bcbb469f948a87dc0a3e52c976f3ff-Employees_by_Shine_Logo_White_1.png","name":"84a1be1031d6e02357bd2ad201aed218d4bcbb469f948a87dc0a3e52c976f3ff-Employees_by_Shine_Logo_White_1.png","width":3200,"height":940,"color":"#ffffff","links":{"original_url":null}},"favicon":{"uri":"/images/691dbcd7126376f107c45ecb","url":"https://files.readme.io/d8fafacc6c73905bcf382eea071848f35389b095a8e4594b05b0884b85f066b0-favicon.ico","name":"d8fafacc6c73905bcf382eea071848f35389b095a8e4594b05b0884b85f066b0-favicon.ico","width":32,"height":32,"color":"#000000","links":{"original_url":null}}},"typography":{"heading_font":null,"body_font":null,"code_font":null,"spacing":null,"custom_heading":{"url":null,"filename":null,"format":null},"custom_code":{"url":null,"filename":null,"format":null},"custom_body":{"regular":{"url":null,"filename":null,"format":null},"medium":{"url":null,"filename":null,"format":null},"semibold":{"url":null,"filename":null,"format":null}}},"ai":{"dropdown":"enabled","options":{"ask_ai":"disabled","chatgpt":"enabled","claude":"enabled","clipboard":"enabled","view_as_markdown":"enabled","mcp":{"command":"enabled","config":"enabled","cursor":"enabled","vscode":"enabled"}}},"custom_code":{"css":null,"js":null,"html":{"header":null,"home_footer":null,"page_footer":null}},"header":{"type":"solid","gradient_color":null,"subnav":{"alignment":"start"},"link_style":"buttons","overlay":{"fill":"auto","type":"triangles","position":"center-center","image":{"uri":null,"url":null,"name":null,"width":null,"height":null,"color":null,"links":{"original_url":null}}}},"navigation":{"collapsible_categories":"disabled","breadcrumbs":"disabled","first_page":"documentation","left":[],"logo_link":"landing_page","page_icons":"enabled","right":[{"type":"user_controls","title":null,"url":null,"custom_page":null}],"search_modal":"classic","sub_nav":[],"subheader_layout":"links","version":"enabled","links":{"home":{"label":"Home","visibility":"disabled"},"graphql":{"label":"GraphQL","visibility":"disabled","schema":null},"guides":{"label":"Guides","alias":null,"visibility":"enabled"},"reference":{"label":"API Reference","alias":null,"visibility":"enabled"},"recipes":{"label":"Recipes","alias":null,"visibility":"disabled"},"changelog":{"label":"Changelog","alias":null,"visibility":"enabled"},"discussions":{"label":"Discussions","alias":null,"visibility":"enabled"}}}},"i18n":{"defaultLanguage":"en","languages":[{"code":"en","type":"manual"}],"state":"disabled","do_not_translate_words":[],"ai_unlocked_languages":null}}},"version":{"_id":"646cb94d24e448000aa0419c","version":"4.0","version_clean":"4.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["646cb94d24e448000aa0419e","646cb94d24e448000aa0419e","646cb94d24e448000aa041a0","646cc0ebacd41303c333537d","646cc12d550b640056d8ad76","646cc222cc448c0065d3307f","646d0e043091870079e6a61f","646d0e81d7098a006bd7bb6f","646d0f4f29a52d005d52a986","646d0fc5853bff003453f3dc","646d10a6e963060028deba0d","646d139f7631cb0056bb5010","646d13b1a206ae0017b87bce","646d13d6614693007bb9c3d1","646d141a2fac23007326f57f","646d16f75b99ad001e940fe0","646d19308eda480073bff04d","646d193a526495005e63f087","646d198ff089ea000bda8e87","646d19ee64ec2800730df3af","646d1dde7328120035a9ea9b","646d1e0c2ab80d00711990e4","646d1e25e28650006cf20738","646d1e2d1fcbe10011182fb0","646d22e1bd7f8d001671f6bf","646d2349f86b02003bd8807a","646d26ea934a08000b462a9b","646f6ea135ace01a61ab7586","646f726f1024621e033a1f10","646f74332a550402017afba8","646f7452dc54b10494468ad5","6475f07a0409100050a07c71","6475f097cd0db60193f775ce","6475f1926932ef000ae8df37","6475f1dadd473b0018b4caa2","6475f322822e9500372c65bc","6475f35423a006081b8ded2f","6475f40398ce1d003bef138f","6475f707a52ddb044383bedd","6475f714457014005d37cd19","6475f7190ca565000e22787d","6475f729a2a790042b101996","6475f75f456a9700347a2ce4","6475f9b1686b2a006e73794e","6475fae6463f850ec81d80f5","649c0174eab76e0019f1c761","649d546fdd37060059110558","649fc051c9d5e20059934f99","649fc0918a02d90031c4c63a","64aa76116e0de8000aa8a19f"],"project":"646cb94d24e448000aa04195","releaseDate":"2023-05-23T13:02:05.817Z","createdAt":"2023-05-23T13:02:05.817Z","__v":5,"updatedAt":"2026-05-04T18:42:20.706Z","apiRegistries":[{"filename":"public-version-40.json","uuid":"a9dt9t2anlo2z7rbc"}],"pdfStatus":"","source":"readme"}},"i18n":{"language":"en","translations":{"en":{"common":{"ai":{"aiOpenFailed":"Failed to open SuperHub AI panel.","askAi":"Ask AI","askAiAri
88aLabel":"Open Ask AI Assistant","chatgpt":"Open in ChatGPT","claude":"Open in Claude","copied":"Copied","mdCopy":"Copy Page","mdOpenFailed":"Failed to open as markdown","mdView":"View as Markdown","mcp":{"appNotFound":"{{app}} does not appear to be installed.","command":"Copy MCP Command","config":"Copy MCP Config","copied":"Copied to clipboard!","cursor":"Connect to Cursor","downloadApp":"Download {{app}}","header":"MCP","vscode":"Connect to VS Code"},"noMdToCopy":"No markdown content available to copy.","openFailed":"Failed to open {{option}}.","settings":{"askAiRequired":"Ask AI must be enabled for your project","description":"Adds a dropdown menu for sharing docs with AI assistants.","disabledInternal":"Disabled for internal docs â set to public to enable","dropdownOptions":"Dropdown Options","preview":"Preview","saveFailed":"Failed to save AI dropdown configuration. Please try again.","title":"AI Dropdown"}},"aiInlineEditor":{"disabled":"The AI inline editor has been disabled for this project."},"apiConfig":{"allRequests":"All Requests","allRequestsFilter":"All Requests","apiKeysNotFound":"No API keys found.","apiKeysNotSynced":"API keys are not synced with this developer hub.","apiRequests":"API Requests","authentication":"Authentication","credentials":"Credentials","dayFilter":"Last 24 Hours","emptyStatePrompt":"Make a request to see them here or \u003ca>Try It\u003c/a>!","error":"Error","errorRequestsFilter":"400 & 500","gettingStarted":"Getting Started","logInPrompt":"Log in to see your API keys","monthFilter":"Last 30 Days","moreErrors":"More Errors","moreRequests":"More Requests","myRecentErrors":"My Recent Errors","myRecentRequests":"My Recent Requests","myRequests":"My Requests","myTopEndpoints":"My Top Endpoints","personalizedDocsSetup":"Set up \u003cButton>Personalized Docs\u003c/Button> to show users their API keys.","pickALanguage":"Pick a language","popularEndpoints":"Popular Endpoints","success":"Success","weekFilter":"Past week","yourApiKeys":"Your API Keys"},"attribution":"by {{attribution}}","auth":{"any":"any","apiKey":"API Key","apiKeyPrompt":"Get API Key","apiKeyShow":"Show API Key","apiKeyHide":"Hide API Key","apiKeyToggle":"Toggle API Key","apiInfo":"API Info","authenticate":"Authenticate","authorize":"Authorize","authorizationUrl":"Authorization URL","authorizedScopes":"Authorized scopes for this token","authorizedScopesEmpty":"Token has no authorized scopes","bearer":"Bearer","clearSelection":"Clear Selection","clientId":"Client ID","deselectAll":"Deselect All","credentialMessage":"{{projectName}} accepts {{count}} credential methods. You can use {{option}} of them.","credentialsFor":"Credentials for {{name}}","credentialsForMd":"Credentials for `{{name}}`","either":"eitherLog in to use your API keys","grantType":"Grant Type","info":{"base64":"Your username and password will be combined with a : to form a base64-encoded string: `ENCODED_TOKEN`","basic":"Your username and password are being sent in the [header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Authorization) of the request.","bearer":"\n Bearer authentication gives access to the âbearer of the tokenâ and must be sent in the Authorization header. For example:\n ```bash\n curl --request POST \\\n --url https://httpbin.org/anything/bearer\n --header 'Authorization: Bearer BEARER_TOKEN'\n ```\n ","cookie":"Your API Key is being sent as a [cookie](https://developer.mozilla.org/en-US/docs/Web/HTTP/Cookies).","header":"Your API Key is sent in the request [header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers).","jwt":"The bearer token's format is JSON Web Token (JWT). Read more at [JWT.io](https://jwt.io/).","query":"Your API Key is being sent as a query parameter in the [URL](https://developer.mozilla.org/en-US/docs/Web/API/URL)."},"infoTable":{"contact":"Contact","description":"Description","identifier":"Identifier","license":"License","name":"Name","termsOfService":"Terms of Service","title":"Title","summary":"Summary","url":"URL","version":"Version"},"information":"Information","label":"Label","lastUsed":"Last Used","logInPrompt":"Log in to use your API keys","logIn":"Log In","logOut":"Log Out","or":"or","password":"password","passwordHideLabel":"Hide","passwordShowLabel":"Show","reAuthorize":"Re-Authorize","required":"required","requiredScopes":"Required Scopes","requiredScopesMissingMsg_one":"Missing {{count}} required scope","requiredScopesMissingMsg_other":"Missing {{count}} required scopes","scopes":"Scopes","scopeGroupAllRequired":"All {{count}} scopes required","scopesOrRequired":"At least 1 scope group required","scopesMissingCount":"({{count}} missing from this token)","scopesMissingMsg_one":"This operation requires {{count}} additional scope","scopesMissingMsg_other":"This operation requires {{count}} additional scopes","scopesRequiredMsg":"Scopes required for this operation","scopesRequiredNoneMsg":"No scopes required for this operation","selectAll":"Select All","selectCredentials":"Select Credentials","token":"token","tokenDetails":"Token Details","tokenRotationMessage":"We recommend you rotate this token.","tokenUrl":"Token URL","useOwnToken":"Use Your Own Token","username":"username"},"close":"Close","colorScheme":{"dark":"Dark","light":"Light","system":"System","title":"Color Scheme"},"changelog":{"added":"Added","deprecated":"Deprecated","fixed":"Fixed","improved":"Improved","removed":"Removed","title":"Changelog"},"copyToClipboard":{"copiedFull":"Copied to clipboard!","copiedShort":"Copied!","copyFull":"Copy to clipboard","copyShort":"Copy","failed":"Failed to copy to clipboard.","unable":"Unable to copy"},"discussions":{"addCommentLabel":"Add Comment","adminLabel":"Admin","answered":"Answered","askQuestion":"Ask a Question","backToAll":"Back to all","blankBodyError":"Your post body cannot be blank.","blankCommentError":"Your comment cannot be blank.","blankPostError":"Your post cannot be blank.","blankTitleError":"Your post title cannot be blank.","cancelButtonLabel":"Cancel","commentAndMarkAnswered":"Comment and mark answered","commentAndReopen":"Comment and reopen","deleteButtonLabel":"Delete","deleteCommentConfirmation":"Are you sure you want to delete this comment?","deleteCommentPermanentConfirmation":"Are you sure you want to permanently delete this comment?","deleteComentSuccess":"This comment has been deleted","deletePermanentlyButtonLabel":"Permanently Delete","deletePostConfirmation":"Are you sure you want to delete this post?","editButtonLabel":"Edit","editedLabel":"edited","emailInputAriaLabel":"[email protected]","emailInputPlaceholder":"Your Email","errorMessagePrefix":"Error:","faqAddLabel":"Add to FAQ","faqRemoveLabel":"Remove from FAQ","faqsLabel":"FAQs","logInToComment":"\u003cb>Log in\u003c/b> to add a comment.","markAsAnswered":"Mark as answered","markAsUnanswered":"Mark as unanswered","markCommentSpamLabel":"Mark this comment as spam","markPostSpamLabel":"Mark this post as spam","nameAndEmailError":"Please fill out your name and email.","nameInputAriaLabel":"Your name","nameInputPlaceholder":"Full name","permanentlyDeleteLabel":"Permanently delete","questionInputAriaLabel":"New question","recaptchaInvalidError":"Invalid ReCaptcha tokens.","recaptchaRequiredError":"Please complete the reCaptcha verification.","recentLabel":"Recent","saveButtonLabel":"Save","submitButtonLabel":"Post Question","tagButtonLabel":"Tag","tagInputPlaceholder":"Enter tag","titleInputAriaLabel":"Question title","titleInputPlaceholder":"Your question title","unansweredLabel":"Unanswered","voteCountLabel":"{{count}} vote","voteCountLabel_plural":"{{count}} votes"},"docsAudit":{"disabled":"The AI Docs Audit has been disabled for this project.","scheduleDisabled":"Disabled by admin"},"emptyState":{"changelog":{"title":"No Changelogs"},"discussion":{"actionLabel":"New Question","description":"Nobody's asked a question yet. Be the first!","title":"No Discu
88ssions"},"guide":{"title":"No Guides"},"recipe":{"title":"No Recipes"},"reference":{"title":"No API Endpoints"}},"llmsTxt":{"documentation":"Documentation","documentationFor":"Documentation for {{name}}","groupIndexHint":"Each project below either links to its own llms.txt, which contains a full index of that project's documentation, or inlines the index its authors wrote by hand. Where links are listed, the section and category ones narrow to that part of the docs.","heading":"{{name}} Documentation","hubBanner":"For AI agents: visit {{url}} for an index of all pages formatted in Markdown and endpoints in OpenAPI.","indexLink":"{{title}} index","mdSuffixHint":"Append .md to any documentation page URL to get its markdown version.","openapiDefinition":"OpenAPI definition","openapiIntroNote":"This is the part of the APIâs OpenAPI definition that covers servers and authentication. Each endpoint page has its own operation.","pageNotFound":"Page not found. The full index is at {{url}}. Use the agentTools in the front matter above to search the docs or browse the index.","projectDocumentation":"{{name}} documentation","queryCapabilityHint":"To search every page by keyword, fetch {{url}} with your own terms. Results come back most relevant first.","queryFailedHint":"Search is temporarily unavailable, so this is the complete index rather than the pages matching `{{query}}`.","queryNoResultsHint":"No pages matched `{{query}}`. Fetch {{url}} for the complete index.","queryResultsHint":"Pages matching `{{query}}`, most relevant first. Fetch {{url}} for the complete index.","searchResults":"Search Results","sectionIndexNote":"full section index","siblingPages":"Sibling pages","siteIndexHint":"The index for every project on this site is at {{url}}.","splitCategoriesHint":"Category links narrow to a single category.","splitIndexHint":"Each section below links to its own llms.txt, which indexes every page in that section.","subPages":"Sub pages","subsetIndexHint":"This file lists one part of the documentation. The full index is at {{url}}."},"more":"moreâ¦","next":"Next","onlyVisibleToAdmins":"Only visible to ReadMe admins","owlbotChat":{"assistant":"Assistant","clearChat":"Clear chat history","closeChat":"Close chat","emptyMessage":"Iâll help you find answers in the docs","emptyTitle":"Ask AI","failureTitle":"Ask AI","fallbackHeading":"Something went wrong with Ask AI","fallbackMessage":"Please try refreshing the page or contact support if the problem persists.","inputPlaceholder":"Ask AI anythingâ¦","interrupted":"Ask AI couldnât finish this answer. Please try again.","providerFailure":"Ask AI is temporarily unavailable. Please try again in a moment.","resend":"Resend?","sourceCount_one":"{{count}} source","sourceCount_other":"{{count}} sources","sourceLabel":"{{title}} ({{section}})","streamError":"...Something went wrong.","tryAgain":"Try Again","typingLabel":"Generating","voteFailure":"Failed to record vote. It may take a moment for the message to be saved. Please try again.","aiDisclaimer":"AI can get things wrong, so double check any info or code. You're responsible for verifying results are accurate and fit your needs before taking action. Do not input sensitive information.","voteLabelDown":"Not helpful","voteLabelUp":"Helpful","thinkingDefault":"Thinking...","thinkingSearchKnowledge":"Searching knowledge base...","thinkingSearchPages":"Searching for keywords...","thinkingListPages":"Looking up pages...","thinkingReadPage":"Reading relevant pages..."},"pageLinter":{"disabled":"The AI Page Linter has been disabled for this project."},"pageNotFound":{"heading":"Page Not Found","metaTitle":"404 Not Found"},"pageThumbs":{"no":"No","placeHolder":"Leave an optional commentâ¦","prompt":"Did this page help you?","submit":"Vote","thankYou":"Thanks for voting!","yes":"Yes"},"poweredBy":"Powered by","recipes":{"inThisRecipe":"In this Recipe","openRecipe":"Open Recipe","step_one":"{{count}} step","step_other":"{{count}} steps"},"reference":{"callback":"Callback","clearExample":"Clear Example","clearResponse":"Clear Response","data":"Data","example":"Example","examplePrompt":"Choose an example","examplePromptOr":"Or choose an example","examples":"Examples","headers":"Headers","invali
88dJSON":"Invalid JSON","inspectRequest":"Inspect Request","jsonEditorAriaLabel":"Toggle Raw JSON Editor","jsonEditorLabel":"Edit JSON Body","language":"Language","library":"Library","log":"Log","logsLoading":"Retrieving recent requestsâ¦","logsPrompt":"Make a request to see history.","logsSeeAllLabel":"See All Requests","logsStatusLabel":"Status","logsThisMonth_one":"{{count}} Request This Month","logsThisMonth_other":"{{count}} Requests This Month","logsTimeLabel":"Time","logsUserAgentLabel":"User Agent","payloadExample":"Payload Example","recentRequests":"Recent Requests","replayRequest":"Replay Request","request":"Request","requestExample":"Request Example","requestExamples":"Request Examples","requestHistoryPrompt":"Log in to see full request history","requestInstructions":"Request instructions","resetBody":"Reset","response":"Response","showDescription":"Show Description","hideDescription":"Hide Description","sdkCodeEmpty":"No SDK code available","sdkCodeError":"Error retrieving SDK code. Please try again later.","tryIt":"Try It","tryItPrompt":"Click \u003ccode>Try It!\u003c/code> to start a request and see the response here!","tryItPunctuated":"Try It!"},"search":{"arrowsToNavigate":"Use \u003ckbd>â\u003c/kbd> \u003ckbd>â\u003c/kbd> to navigate","askAiAbout":"Ask about \"{{query}}\"","askAiEmpty":"Ask AI","askAiSubtitle":"Find the answer using the Ask AI assistant","askAiSuggestionsTitle":"Ask AI Assistant","askFailure":"We had an issue responding, please try again later","filtersAll":"All","filtersEmpty":"No matches","filtersLabel":"Filters","filtersMore":"{{name}} +{{others}}","filtersPlaceholder":"Filter","forMore":"for more","fromTheDocs":"From the Docs","inProject":"in {{project}}","noResults":"No search results for '{{query}}'","noResultsShort":"No search results","resultsFound_one":"{{count}} search result","resultsFound_other":"{{count}} search results","resultsLabel":"Search results","placeholder":"Search","pressEnterToAskAi":"Press \u003ckbd>Enter\u003c/kbd> to ask AI","pressEnterToOpen":"Press \u003ckbd>Enter\u003c/kbd> to open","promptEmpty":"Start typing to searchâ¦","promptLoading":"Keep typing to searchâ¦","recentTitle":"Recent","removeRecent":"Remove {{label}} from recent searches","searching":"Searchingâ¦","thinking":"Thinking"},"sections":{"all":"All","apiLogs":"API Logs","changelog":"Changelog","discussions":"Discussions","guides":"Guides","graphql":"GraphQL","home":"Home","pages":"Pages","recipes":"Recipes","reference":"API Reference"},"sidebar":{"filter":"Filter","filterPages":"Filter pages","noMatchingPages":"No matching pages","search":"Search"},"superHubAgent":{"disabled":"The SuperHub Agent has been disabled for this project."},"tableOfContents":"Table of Contents","time":{"absolute":{"noPrefix":"{{time}}","noPrefixAttributed":"{{time}} by {{attribution}}","postedPrefix":"Posted {{time}}","postedPrefixAttributed":"Posted {{time}} by {{attribution}}","updatedPrefix":"Updated {{time}}","updatedPrefixAttributed":"Updated {{time}} by {{attribution}}"},"justNow":{"noPrefix":"Less than a minute ago","noPrefixAttributed":"Less than a minute ago by {{attribution}}","postedPrefix":"Posted just now","postedPrefixAttributed":"Posted just now by {{attribution}}","updatedPrefix":"Updated just now","updatedPrefixAttributed":"Updated just now by {{attribution}}"},"relative":{"noPrefix":"{{time}}","noPrefixAttributed":"{{time}} by {{attribution}}","postedPrefix":"Posted {{time}}","postedPrefixAttributed":"Posted {{time}} by {{attribution}}","updatedPrefix":"Updated {{time}}","updatedPrefixAttributed":"Updated {{time}} by {{attribution}}"}},"unableToCopy":"Unable to copy","version":{"beta":"Beta","default":"Default","deprecated":"Deprecated","hiddenLabel":"Hidden Version"},"whatsNext":"Whatâs Next"}}}},"is404":false,"isFramePreview":false,"isIframeSsrTransfer":false,"isStreamingSSR":false,"isDetachedProductionSite":false,"lang":"en","langFull":"Default","reqUrl":"/docs/getting-started","version":{"_id":"646cb94d24e448000aa0419c","version":"4.0","version_clean":"4.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["646cb94d24e448000aa0419e","646cb94d24e448000aa0419e","646cb94d24e448000aa041a0","646cc0ebacd41303c333537d","646cc12d550b640056d8ad76","646cc222cc448c0065d3307f","646d0e043091870079e6a61f","646d0e81d7098a006bd7bb6f","646d0f4f29a52d005d52a986","646d0fc5853bff003453f3dc","646d10a6e963060028deba0d","646d139f7631cb0056bb5010","646d13b1a206ae0017b87bce","646d13d6614
88693007bb9c3d1","646d141a2fac23007326f57f","646d16f75b99ad001e940fe0","646d19308eda480073bff04d","646d193a526495005e63f087","646d198ff089ea000bda8e87","646d19ee64ec2800730df3af","646d1dde7328120035a9ea9b","646d1e0c2ab80d00711990e4","646d1e25e28650006cf20738","646d1e2d1fcbe10011182fb0","646d22e1bd7f8d001671f6bf","646d2349f86b02003bd8807a","646d26ea934a08000b462a9b","646f6ea135ace01a61ab7586","646f726f1024621e033a1f10","646f74332a550402017afba8","646f7452dc54b10494468ad5","6475f07a0409100050a07c71","6475f097cd0db60193f775ce","6475f1926932ef000ae8df37","6475f1dadd473b0018b4caa2","6475f322822e9500372c65bc","6475f35423a006081b8ded2f","6475f40398ce1d003bef138f","6475f707a52ddb044383bedd","6475f714457014005d37cd19","6475f7190ca565000e22787d","6475f729a2a790042b101996","6475f75f456a9700347a2ce4","6475f9b1686b2a006e73794e","6475fae6463f850ec81d80f5","649c0174eab76e0019f1c761","649d546fdd37060059110558","649fc051c9d5e20059934f99","649fc0918a02d90031c4c63a","64aa76116e0de8000aa8a19f"],"project":"646cb94d24e448000aa04195","releaseDate":"2023-05-23T13:02:05.817Z","createdAt":"2023-05-23T13:02:05.817Z","__v":5,"updatedAt":"2026-05-04T18:42:20.706Z","apiRegistries":[{"filename":"public-version-40.json","uuid":"a9dt9t2anlo2z7rbc"}],"pdfStatus":"","source":"readme"},"gitVersion":{"ai_translation":{"status":null,"started_at":null,"completed_at":null},"base":null,"display_name":null,"i18n":{"lang":null,"parsed_version":null},"name":"4.0","release_stage":"release","source":"readme","state":"current","updated_at":"2026-05-04T18:52:23.000Z","uri":"/branches/4.0","privacy":{"view":"default"}},"versions":{"total":1,"data":[{"ai_translation":{"status":null,"started_at":null,"completed_at":null},"base":null,"display_name":null,"i18n":{"lang":null,"parsed_version":null},"name":"4.0","release_stage":"release","source":"readme","state":"current","updated_at":"2026-05-04T18:52:23.366Z","uri":"/branches/4.0","privacy":{"view":"default"}}],"type":"version"},"sidebarStatus":{"changelog":true,"custom_pages":false,"discuss":true,"guides":true,"recipes":false,"reference":true}}</script>
88</div><div id="hub-container"><div class="hub-container"><div state-container ng-attr-id="{{state.current().root !== 'docs' && 'react-app-content-container'}}"><div id="replace-view" ng-non-bindable></div></div></div></div>
88<script>var is_hub = true; 89var is_hub2 = true; 90var is_hub_edit = true; 91</script>
91<div id="ssr-end">
91<script id="__LOADABLE_REQUIRED_CHUNKS__" type="application/json">[2852,4863,4011,6269,444,4148,1456,3307,7137,9977,6146,441,1347,8836,5446,1306,2966,8813,4071,7358,6383,9127,8719,1924,2712,779,97,1297,2985,6212,4818,1425,5798]</script>
91<script id="__LOADABLE_REQUIRED_CHUNKS___ext" type="application/json">{"namedChunks":["routes-SuperHub","Containers-EndUserContainer","Header","routes-SuperHub-Routes","Doc","ConnectMetadata","RMDXISH","components-AIDropdown","Footer"]}</script>
vendor: 1 bytes, line 91
91
92<script async data-chunk="main" src="https://cdn.readme.io/public/hub/web/main.cc789f714ace36f66839.js"></script>
vendor: 1 bytes, line 92
92
93<script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/routes-SuperHub.529e1767765a70259c1d.js"></script>
vendor: 1 bytes, line 93
93
94<script async data-chunk="Containers-EndUserContainer" src="https://cdn.readme.io/public/hub/web/Containers-EndUserContainer.a39bb49787d00dc5a756.js"></script>
vendor: 1 bytes, line 94
94
95<script async data-chunk="Header" src="https://cdn.readme.io/public/hub/web/4011.98c6655a4c5d99e73da8.js"></script>
vendor: 1 bytes, line 95
95
96<script async data-chunk="Header" src="https://cdn.readme.io/public/hub/web/6269.ec68447c21baa0d006c4.js"></script>
vendor: 1 bytes, line 96
96
97<script async data-chunk="Header" src="https://cdn.readme.io/public/hub/web/444.9911d4434036a49d02be.js"></script>
vendor: 1 bytes, line 97
97
98<script async data-chunk="Header" src="https://cdn.readme.io/public/hub/web/4148.fbcb7b553d8b36a3535f.js"></script>
vendor: 1 bytes, line 98
98
99<script async data-chunk="Header" src="https://cdn.readme.io/public/hub/web/Header.a76de00df61db59a3b60.js"></script>
vendor: 1 bytes, line 99
99
100<script async data-chunk="routes-SuperHub-Routes" src="https://cdn.readme.io/public/hub/web/routes-SuperHub-Routes.5212e2cc1e2393ed6ccd.js"></script>
vendor: 1 bytes, line 100
100
101<script async data-chunk="Doc" src="https://cdn.readme.io/public/hub/web/7137.6d393781d59245222014.js"></script>
vendor: 1 bytes, line 101
101
102<script async data-chunk="Doc" src="https://cdn.readme.io/public/hub/web/9977.a933c2a0ee96169ffef7.js"></script>
vendor: 1 bytes, line 102
102
103<script async data-chunk="Doc" src="https://cdn.readme.io/public/hub/web/6146.e0750bc6839fd326854d.js"></script>
vendor: 1 bytes, line 103
103
104<script async data-chunk="Doc" src="https://cdn.readme.io/public/hub/web/441.0bca8969b4854384884a.js"></script>
vendor: 1 bytes, line 104
104
105<script async data-chunk="Doc" src="https://cdn.readme.io/public/hub/web/1347.6265ddeff9b9202723b8.js"></script>
vendor: 1 bytes, line 105
105
106<script async data-chunk="Doc" src="https://cdn.readme.io/public/hub/web/8836.278c0fa83edd766823b0.js"></script>
vendor: 1 bytes, line 106
106
107<script async data-chunk="Doc" src="https://cdn.readme.io/public/hub/web/5446.66a863132dae0648c54c.js"></script>
vendor: 1 bytes, line 107
107
108<script async data-chunk="Doc" src="https://cdn.readme.io/public/hub/web/1306.50782c5e797f388d05de.js"></script>
vendor: 1 bytes, line 108
108
109<script async data-chunk="Doc" src="https://cdn.readme.io/public/hub/web/2966.7dda7fe8a5d98b4a3ffe.js"></script>
vendor: 1 bytes, line 109
109
110<script async data-chunk="Doc" src="https://cdn.readme.io/public/hub/web/8813.fa11b4c3ec4dd6845870.js"></script>
vendor: 1 bytes, line 110
110
111<script async data-chunk="Doc" src="https://cdn.readme.io/public/hub/web/4071.7611d1296eb10d1ab027.js"></script>
vendor: 1 bytes, line 111
111
112<script async data-chunk="Doc" src="https://cdn.readme.io/public/hub/web/7358.586fb9797e5f7461750b.js"></script>
vendor: 1 bytes, line 112
112
113<script async data-chunk="Doc" src="https://cdn.readme.io/public/hub/web/6383.fd233703db9be7c9fc84.js"></script>
vendor: 1 bytes, line 113
113
114<script async data-chunk="Doc" src="https://cdn.readme.io/public/hub/web/9127.bb4d560bc945b6900553.js"></script>
vendor: 1 bytes, line 114
114
115<script async data-chunk="Doc" src="https://cdn.readme.io/public/hub/web/Doc.5f97f0771ff731d59de3.js"></script>
vendor: 1 bytes, line 115
115
116<script async data-chunk="ConnectMetadata" src="https://cdn.readme.io/public/hub/web/ConnectMetadata.2d6f49b2cb0315a7ccd6.js"></script>
vendor: 1 bytes, line 116
116
117<script async data-chunk="RMDXISH" src="https://cdn.readme.io/public/hub/web/2712.4cdafc1e56a745cc323d.js"></script>
vendor: 1 bytes, line 117
117
118<script async data-chunk="RMDXISH" src="https://cdn.readme.io/public/hub/web/779.787e23290115569e9f85.js"></script>
vendor: 1 bytes, line 118
118
119<script async data-chunk="RMDXISH" src="https://cdn.readme.io/public/hub/web/97.5601dd7405fb2adb484c.js"></script>
vendor: 1 bytes, line 119
119
120<script async data-chunk="RMDXISH" src="https://cdn.readme.io/public/hub/web/1297.27dddfa8ccd2dd3bce10.js"></script>
vendor: 1 bytes, line 120
120
121<script async data-chunk="RMDXISH" src="https://cdn.readme.io/public/hub/web/2985.a3c9e5ecc4ac37e1db9b.js"></script>
vendor: 1 bytes, line 121
121
122<script async data-chunk="RMDXISH" src="https://cdn.readme.io/public/hub/web/RMDXISH.f4037585e9d9a19fb24f.js"></script>
vendor: 1 bytes, line 122
122
123<script async data-chunk="components-AIDropdown" src="https://cdn.readme.io/public/hub/web/4818.9a6592613ce853a623e4.js"></script>
vendor: 1 bytes, line 123
123
124<script async data-chunk="components-AIDropdown" src="https://cdn.readme.io/public/hub/web/components-AIDropdown.88def46aeefbfb1f9434.js"></script>
vendor: 1 bytes, line 124
124
125<script async data-chunk="Footer" src="https://cdn.readme.io/public/hub/web/Footer.167664af72797a4cf2f8.js"></script>
125</div>
125<script id="hub-me" type="application/json" data-json="{"loggedIn":false,"search":{"app":"","token":"","filters":"","metaData":[{"modules":{"landing":false,"docs":true,"examples":true,"reference":true,"graphql":false,"changelog":true,"discuss":true,"suggested_edits":false,"logs":false,"custompages":false,"tutorials":false},"id":"646cb94d24e448000aa04195","name":"Employes","subdomain":"employes","subpath":"","nav_names":{"docs":"","reference":"","changelog":"","discuss":"","recipes":"","tutorials":""}}]}}"></script>
125<script id="readme-data-baseUrl" type="application/json"></script>
125<script>(function(){function c(){var b=a.contentDocument||(a.contentWindow&&a.contentWindow.document);if(b){var d=b.createElement('script');d.innerHTML="window.__CF$cv$params={r:'a43c16049a33127b',t:'MTc5MDg2NDE5NQ=='};var a=document.createElement('script');a.src='/cdn-cgi/challenge-platform/scripts/jsd/main.js';document.getElementsByTagName('head')[0].appendChild(a);";b.getElementsByTagName('head')[0].appendChild(d)}}if(document.body){var a=document.createElement('iframe');a.height=1;a.width=1;a.style.position='absolute';a.style.top=0;a.style.left=0;a.style.border='none';a.style.visibility='hidden';document.body.appendChild(a);if('loading'!==document.readyState)c();else if(window.addEventListener)document.addEventListener('DOMContentLoaded',c);else{var e=document.onreadystatechange||function(){};document.onreadystatechange=function(b){e(b);'loading'!==document.readyState&&(document.onreadystatechange=e,c())}}}})();</script>
125</body></html>
Line numbers count LF bytes from the start of the resource, as the search results do. Vendor segments are library code the classifier recognised; they are stored but not indexed. Bytes are shown as Latin1 characters, one per byte.