We offer a downloadable version of the BambooHR API as an OpenAPI specification file. This file can be used to generate a Postman Collection or interact with the OpenAPI definition directly in your preferred tools.
The OpenAPI specification provides flexibility for interacting with the BambooHR API. You can:
Import it into Postman to create a collection for testing and exploring API endpoints.
Use it with other tools that support the OpenAPI standard.
Updated 5 months ago
\n\n### Why Use the OpenAPI Spec?\n\nThe OpenAPI specification provides flexibility for interacting with the BambooHR API. You can:\n\n- Import it into Postman to create a collection for testing and exploring API endpoints.\n- Use it with other tools that support the OpenAPI standard.","dehydrated":{"toc":"","body":"
The OpenAPI specification provides flexibility for interacting with the BambooHR API. You can:
\n
\n
Import it into Postman to create a collection for testing and exploring API endpoints.
\n
Use it with other tools that support the OpenAPI standard.
\n
"},"mdx":false,"opts":{"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":{}},"safeMode":false,"settings":{"position":true},"theme":"light","customBlocks":{},"resourceID":"67b8cce84b6e03004b8401fa","resourceType":"page","baseUrl":"/","terms":[],"variables":{"user":{},"defaults":[{"source":"security","type":"oauth2","_id":"67462e86b10ce7000f01eaa8","name":"auth","apiSetting":"5c5c82c3dc49780051f2d292"},{"source":"security","type":"http","_id":"67462e86b10ce7000f01eaa7","name":"basic","scheme":"basic","apiSetting":"5c5c82c3dc49780051f2d292"},{"apiSetting":"67b900d377247c003734f310","name":"oauth","source":"security","type":"oauth2","_id":"687abcaa316b51eb6e976e98"}]}},"terms":[],"variables":{"user":{},"defaults":[{"source":"security","type":"oauth2","_id":"67462e86b10ce7000f01eaa8","name":"auth","apiSetting":"5c5c82c3dc49780051f2d292"},{"source":"security","type":"http","_id":"67462e86b10ce7000f01eaa7","name":"basic","scheme":"basic","apiSetting":"5c5c82c3dc49780051f2d292"},{"apiSetting":"67b900d377247c003734f310","name":"oauth","source":"security","type":"oauth2","_id":"687abcaa316b51eb6e976e98"}]}},"doc":{"metadata":{"image":[],"title":"","description":"","keywords":"","robots":"index"},"mdx":{"altBody":"","status":"rdmd"},"api":{"method":"get","url":"","auth":"required","params":[]},"next":{"description":"","pages":[]},"algolia":{"translationFailure":false,"publishPending":false,"recordCount":2,"updatedAt":"2025-02-27T20:39:12.629Z"},"_id":"67b8cce84b6e03004b8401fa","title":"Postman Collection","icon":"","updates":[],"type":"basic","slug":"postman-collection","excerpt":"We offer a downloadable version of the BambooHR API as an OpenAPI specification file. This file can be used to generate a Postman Collection or interact with the OpenAPI definition directly in your preferred tools.","body":"### How to Get Started\n\n**1. Download the OpenAPI Specification**\n\nUse the link below to download the OpenAPI spec for the BambooHR API: \n[Download the OpenAPI Specification](https://openapi.bamboohr.io/main/latest/docs/openapi/public-openapi.yaml)\n\n**2. Import to Postman**\n\nIf you’d like to create a Postman Collection from the OpenAPI file, follow these instructions from Postman: \n[Import OpenAPI Specification into Postman](https://learning.postman.com/docs/integrations/available-integrations/working-with-openAPI/)\n\n \n\n### Why Use the OpenAPI Spec?\n\nThe OpenAPI specification provides flexibility for interacting with the BambooHR API. You can:\n\n- Import it into Postman to create a collection for testing and exploring API endpoints.\n- Use it with other tools that support the OpenAPI standard.","order":2,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"reusableContent":[],"previousSlug":"","slugUpdatedAt":"2025-02-21T18:30:26.547Z","revision":11,"user":"5c475d230f46980f22e4ab8a","project":"599d8d6fc4ad04001905e8b8","category":{"_id":"599d8d6fc4ad04001905e8bc","project":"599d8d6fc4ad04001905e8b8","version":"599d8d6fc4ad04001905e8bb","isAPI":false,"reference":false,"createdAt":"2017-08-23T14:13:03.422Z","from_sync":false,"order":0,"slug":"documentation","title":"DOCUMENTATION","__v":0,"type":"guide","id":"599d8d6fc4ad04001905e8bc"},"createdAt":"2025-02-21T18:58:48.409Z","updatedAt":"2025-02-26T22:04:36.789Z","version":{"pdfStatus":"","source":"readme","_id":"599d8d6fc4ad04001905e8bb","project":"599d8d6fc4ad04001905e8b8","createdAt":"2017-08-23T14:13:03.394Z","releaseDate":"2017-08-23T14:13:03.394Z","categories":["599d8d6fc4ad04001905e8bc","59a8381141bce5000f12c298","59a8382505f519001bfbb869","59a838ab78ddf9000f47a540","59a8413c5f69db002f7fd01d","59b712aca50f750030f41a13","59b713e8d8aa11003a9f8c27","59b7140ca50f750030f41acd","59b71432944cbe003083fed7","59b8372c944cbe003084bdc0","5c5c829866ef540011c2599c","5c5c82c3dc49780051f2d293","5ce430d1b3ddaa0010fc9e35","60da389606d3f9006bfce338","624f1fa2fa2e12066f9d2add","6376bee8127d990003169e8f","661811e9287a080041aea2bc","6618127636084d004560875a","67a53cac0d5096002a78c4c5","67a655b0ee1e570044b62792","67a65611a3843f0053aa3ba0","67a6564c3e340500113786b0","67a664b94b57f3005424e705","67a66e7ec298200062e13381","67a66efbc28d4400588f12e7","67a66f315157260010e176bd","67a66f51ceb469005ecc438d","67a66fa4297355003ec0eabd","67a66fc4ee08820065d2d8dd","67a66ff32326a6002a0f7233","67a6710946e14e00121204b4","67a6725712e0920031937db5","67a67665c298200062e13cf0","67a676935c522a000f6b97cc","67b8c180190c770018af1f81","67b8f31377247c003734b362","67b8f455be616d0011ddf23a","67b900d377247c003734f311","67bcb8572a9e27001e3cff69","6801755fd6fe3f00537cc4fa","68017679a69cd20023fd4953"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1","__v":13,"updatedAt":"2025-04-17T21:45:29.788Z","apiRegistries":[]},"lastUpdatedHash":"4aedd862b9ff201afd14d2162810868d5790b529","__v":0,"parentDoc":null,"isApi":false,"tutorials":[],"id":"67b8cce84b6e03004b8401fa"},"hideTOC":true,"meta":{"_id":"67b8cce84b6e03004b8401fa","description":"We offer a downloadable version of the BambooHR API as an OpenAPI specification file. This file can be used to generate a Postman Collection or interact with the OpenAPI definition directly in your preferred tools.","hidden":false,"image":[],"keywords":"","metaTitle":"Postman Collection","parent":null,"robots":"index","slug":"postman-collection","title":"Postman Collection","type":"docs"},"slugUrl":"/docs/postman-collection","config":{"algoliaIndex":"readme_search_v2","amplitude":{"apiKey":"dc8065a65ef83d6ad23e37aaf014fc84","enabled":true},"asset_url":"https://cdn.readme.io","domain":"readme.io","domainFull":"https://dash.readme.com","encryptedLocalStorageKey":"ekfls-2025-03-27","fullstory":{"enabled":true,"orgId":"FSV9A"},"liveblocks":{"copilotId":"co_11Q0l0JJlkcBhhAYUFh8s"},"metrics":{"billingCronEnabled":"true","dashUrl":"https://m.readme.io","defaultUrl":"https://m.readme.io","exportMaxRetries":12,"wsUrl":"wss://m.readme.io"},"proxyUrl":"https://try.readme.io","readmeRecaptchaSiteKey":"6LesVBYpAAAAAESOCHOyo2kF9SZXPVb54Nwf3i2x","releaseVersion":"5.422.0","sentry":{"dsn":"https://3bbe57a973254129bcb93e47dc0cc46f@o343074.ingest.sentry.io/2052166","enabled":true},"shMigration":{"promoVideo":"","forceWaitlist":false,"migrationPreview":false},"sslBaseDomain":"readmessl.com","sslGenerationService":"ssl.readmessl.com","stripePk":"pk_live_5103PML2qXbDukVh7GDAkQoR4NSuLqy8idd5xtdm9407XdPR6o3bo663C1ruEGhXJjpnb2YCpj8EU1UvQYanuCjtr00t1DRCf2a","superHub":{"newProjectsEnabled":true},"wootric":{"accountToken":"NPS-122b75a4","enabled":true}},"context":{"labs":{},"user":{},"terms":[],"variables":{"user":{},"defaults":[{"source":"security","type":"oauth2","_id":"67462e86b10ce7000f01eaa8","name":"auth","apiSetting":"5c5c82c3dc49780051f2d292"},{"source":"security","type":"http","_id":"67462e86b10ce7000f01eaa7","name":"basic","scheme":"basic","apiSetting":"5c5c82c3dc49780051f2d292"},{"apiSetting":"67b900d377247c003734f310","name":"oauth","source":"security","type":"oauth2","_id":"687abcaa316b51eb6e976e98"}]},"project":{"_id":"599d8d6fc4ad04001905e8b8","appearance":{"nextStepsLabel":"","hideTableOfContents":true,"showVersion":true,"html_hidelinks":false,"html_footer_meta":"","html_head":"","html_footer":"","html_body":"","html_promo":"","javascript_hub2":"","javascript":"","stylesheet_hub2":"@import url('https://fonts.googleapis.com/css?family=Lato');\n\nbody {\n font-family: 'Lato', Arial, Helvetica, sans-serif;\n font-weight: 400;\n padding: 10px;\n}\n\nh1 {\n font-family: 'Lato', Arial, Helvetica, sans-serif;\n font-size: 36px;\n font-weight: 800;\n line-height: 44px;\n}","stylesheet":"","favicon":["https://files.readme.io/9b6a0cd-small-bamboohricon.png","bamboohricon.png",252,252,"#dae8c8","https://files.readme.io/35262e9-bamboohricon.png"],"logo_white_use":true,"logo_white":["https://files.readme.io/bea0d00-white-logo.png","white-logo.png",1000,149,"#333"],"logo":["https://files.readme.io/9b7660c-small-logo.png","logo.png",1000,149,"#8cc43c","https://files.readme.io/be77fc0-logo.png"],"promos":[{"extras":{"type":"buttons","buttonPrimary":"get-started","buttonSecondary":""},"title":"BambooHR API Documentation","text":"Welcome to BambooHR's API Documentation. You'll find comprehensive guides and documentation to help you start working with BambooHR as quickly as possible, as well as support if you get stuck. Let's jump right in!","_id":"599d8d6fc4ad04001905e8b9"}],"body":{"style":"none"},"header":{"img_pos":"tl","img_size":"auto","img":[],"style":"solid","linkStyle":"buttons"},"typography":{"tk_body":"","tk_headline":"","tk_key":"","typekit":false,"body":"Open+Sans:400:sans-serif","headline":"Open+Sans:400:sans-serif"},"colors":{"body_highlight":"#599D15","header_text":"","main_alt":"","main":"#599D15","highlight":"","custom_login_link_color":""},"main_body":{"type":"links"},"categoriesAsDropdown":false,"hide_logo":false,"sticky":false,"landing":true,"overlay":"triangles","notheme":false,"theme":"solid","link_logo_to_url":false,"referenceLayout":"row","childrenAsPills":false,"global_landing_page":{"html":"","redirect":""},"splitReferenceDocs":false,"rdmd":{"callouts":{"useIconFont":false},"theme":{"background":"","border":"","markdownEdge":"","markdownFont":"","markdownFontSize":"","markdownLineHeight":"","markdownRadius":"","markdownText":"","markdownTitle":"","markdownTitleFont":"","mdCodeBackground":"","mdCodeFont":"","mdCodeRadius":"","mdCodeTabs":"","mdCodeText":"","tableEdges":"","tableHead":"","tableHeadText":"","tableRow":"","tableStripe":"","tableText":"","text":"","title":""}},"subheaderStyle":"dropdown","showMetricsInReference":true,"referenceSimpleMode":true,"stylesheet_hub3":"","loginLogo":[],"logo_large":false,"colorScheme":"dark","changelog":{"layoutExpanded":false,"showAuthor":true,"showExactDate":false},"allowApiExplorerJsonEditor":false,"ai_dropdown":"disabled","ai_options":{"chatgpt":"enabled","claude":"enabled","clipboard":"enabled","view_as_markdown":"enabled","copilot":"enabled","perplexity":"enabled"},"showPageIcons":true,"layout":{"full_width":false,"style":"classic"}},"custom_domain":"documentation.bamboohr.com","childrenProjects":[],"derivedPlan":"startup","description":"","isExternalSnippetActive":false,"error404":"","experiments":[],"first_page":"docs","flags":{"cacheEnabled":true,"allowImport":false,"stripe":false,"hideGoogleAnalytics":false,"jwt":false,"cookieAuthentication":false,"allowXFrame":true,"speedyRender":false,"correctnewlines":false,"swagger":false,"oauth":false,"migrationSwaggerRun":false,"migrationRun":false,"hub2":true,"enterprise":false,"allow_hub2":false,"newApiExplorer":true,"directGoogleToStableVersion":false,"disableAnonForum":false,"newEditor":true,"translation":false,"alwaysShowDocPublishStatus":false,"newMarkdownBetaProgram":false,"oldMarkdown":false,"newSearch":true,"allowApiExplorerJsonEditor":false,"rdmdCompatibilityMode":false,"staging":false,"tutorials":true,"useReactApp":true,"newHeader":false,"referenceRedesign":false,"auth0Oauth":false,"graphql":false,"singleProjectEnterprise":false,"dashReact":false,"allowReferenceUpgrade":true,"metricsV2":true,"newEditorDash":true,"enableRealtimeExperiences":false,"reviewWorkflow":true,"star":false,"allowDarkMode":false,"forceDarkMode":false,"useReactGLP":false,"disablePasswordlessLogin":false,"personalizedDocs":false,"myDevelopers":false,"superHub":false,"developerDashboard":false,"allowReusableOTPs":false,"dashHomeRefresh":false,"owlbotAi":false,"apiV2":false,"git":{"read":false,"write":false},"superHubBeta":false,"dashQuickstart":false,"disableAutoTranslate":false,"customBlocks":false,"devDashHub":false,"disableSAMLScoping":false,"allowUnsafeCustomHtmlSuggestionsFromNonAdmins":false,"apiAccessRevoked":false,"passwordlessLogin":"default","disableSignups":false,"billingRedesignEnabled":true,"developerPortal":false,"mdx":false,"superHubDevelopment":false,"annualBillingEnabled":true,"devDashBillingRedesignEnabled":false,"enableOidc":false,"customComponents":false,"disableDiscussionSpamRecaptchaBypass":false,"developerViewUsersData":false,"changelogRssAlwaysPublic":false,"bidiSync":false,"superHubMigrationSelfServeFlow":true,"apiDesigner":false,"hideEnforceSSO":false,"localLLM":false,"superHubManageVersions":false,"gitSidebar":false,"superHubGlobalCustomBlocks":false,"childManagedBidi":false,"superHubBranches":false,"externalSdkSnippets":false,"requiresJQuery":false,"migrationPreview":false,"superHubPreview":false,"superHubBranchReviews":false,"superHubMergePermissions":false},"fullBaseUrl":"https://documentation.bamboohr.com/","git":{"migration":{"createRepository":{},"transformation":{},"migratingPages":{},"enableSuperhub":{}},"sync":{"linked_repository":{},"installationRequest":{},"connections":[],"providers":[]}},"glossaryTerms":[],"graphqlSchema":"","gracePeriod":{"enabled":false,"endsAt":null},"shouldGateDash":false,"healthCheck":{"provider":"","settings":{}},"intercom_secure_emailonly":false,"intercom":"","is_active":true,"integrations":{"login":{}},"internal":"","jwtExpirationTime":0,"landing_bottom":[{"type":"docs","alignment":"left","pageType":"Reference"}],"mdxMigrationStatus":"rdmd","metrics":{"enabled":false,"thumbsEnabled":false,"monthlyLimit":0,"planLimit":1000000,"usageLastChecked":"2022-01-27T23:28:55.449Z","realtime":{"dashEnabled":false,"hubEnabled":false},"monthlyPurchaseLimit":0,"meteredBilling":{}},"modules":{"suggested_edits":true,"discuss":false,"reference":true,"examples":true,"docs":true,"landing":true,"changelog":true,"logs":false,"custompages":true,"tutorials":false,"graphql":false},"name":"BambooHR","nav_names":{"discuss":"","reference":"","docs":"Documentation","changelog":"","tutorials":"","recipes":""},"oauth_url":"","onboardingCompleted":{"documentation":true,"appearance":true,"jwt":true,"api":true,"logs":false,"domain":true,"metricsSDK":false},"owlbot":{"enabled":false,"isPaying":false,"customization":{"answerLength":"long","customTone":"","defaultAnswer":"","forbiddenWords":"","tone":"neutral"},"copilot":{"enabled":false,"hasBeenUsed":false,"installedCustomPage":""}},"owner":{"id":null,"email":null,"name":null},"plan":"startup","planOverride":"","planSchedule":{"stripeScheduleId":null,"changeDate":null,"nextPlan":null},"planStatus":"active","planTrial":"startup","readmeScore":{"components":{"newDesign":{"enabled":true,"points":25},"reference":{"enabled":true,"points":50},"tryItNow":{"enabled":true,"points":35},"syncingOAS":{"enabled":true,"points":10},"customLogin":{"enabled":true,"points":25},"metrics":{"enabled":false,"points":40},"recipes":{"enabled":false,"points":15},"pageVoting":{"enabled":false,"points":1},"suggestedEdits":{"enabled":true,"points":10},"support":{"enabled":false,"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":true,"points":2}},"percentScore":25,"totalScore":173},"reCaptchaSiteKey":"","reference":{"alwaysUseDefaults":true,"defaultExpandResponseExample":false,"defaultExpandResponseSchema":false,"enableOAuthFlows":false},"seo":{"overwrite_title_tag":false},"stable":{"_id":"599d8d6fc4ad04001905e8bb","project":"599d8d6fc4ad04001905e8b8","createdAt":"2017-08-23T14:13:03.394Z","releaseDate":"2017-08-23T14:13:03.394Z","categories":["599d8d6fc4ad04001905e8bc","59a8381141bce5000f12c298","59a8382505f519001bfbb869","59a838ab78ddf9000f47a540","59a8413c5f69db002f7fd01d","59b712aca50f750030f41a13","59b713e8d8aa11003a9f8c27","59b7140ca50f750030f41acd","59b71432944cbe003083fed7","59b8372c944cbe003084bdc0","5c5c829866ef540011c2599c","5c5c82c3dc49780051f2d293","5ce430d1b3ddaa0010fc9e35","60da389606d3f9006bfce338","624f1fa2fa2e12066f9d2add","6376bee8127d990003169e8f","661811e9287a080041aea2bc","6618127636084d004560875a","67a53cac0d5096002a78c4c5","67a655b0ee1e570044b62792","67a65611a3843f0053aa3ba0","67a6564c3e340500113786b0","67a664b94b57f3005424e705","67a66e7ec298200062e13381","67a66efbc28d4400588f12e7","67a66f315157260010e176bd","67a66f51ceb469005ecc438d","67a66fa4297355003ec0eabd","67a66fc4ee08820065d2d8dd","67a66ff32326a6002a0f7233","67a6710946e14e00121204b4","67a6725712e0920031937db5","67a67665c298200062e13cf0","67a676935c522a000f6b97cc","67b8c180190c770018af1f81","67b8f31377247c003734b362","67b8f455be616d0011ddf23a","67b900d377247c003734f311","67bcb8572a9e27001e3cff69","6801755fd6fe3f00537cc4fa","68017679a69cd20023fd4953"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1","__v":13,"updatedAt":"2025-04-17T21:45:29.788Z"},"subdomain":"bamboohr","subpath":"","superHubWaitlist":false,"topnav":{"edited":true,"right":[{"type":"user","text":"User","url":"/login?redirect_uri=/docs/postman-collection"}],"left":[{"type":"docs","text":"Documentation"},{"type":"reference","text":"API Reference"}],"bottom":[]},"trial":{"trialEndsAt":"2017-09-06T14:13:03.367Z","trialDeadlineEnabled":true},"translate":{"languages":[],"provider":"transifex","key_public":"","org_name":"","project_name":"","show_widget":false},"url":"https://www.bamboohr.com","versions":[{"_id":"61f31ea4156d370057ea93d0","version":"1-beta","version_clean":"1.0.0-beta","codename":"beta","is_stable":false,"is_beta":true,"is_hidden":true,"is_deprecated":false,"categories":["61f31ea4156d370057ea9313","61f31ea4156d370057ea9314","61f31ea4156d370057ea9315","61f32578406c1501e872509d","61f328f79a3abf0010b85965","6376bee8127d990003169e96"],"project":"599d8d6fc4ad04001905e8b8","createdAt":"2017-08-23T14:13:03.394Z","releaseDate":"2017-08-23T14:13:03.394Z","__v":1,"forked_from":"599d8d6fc4ad04001905e8bb"},{"_id":"599d8d6fc4ad04001905e8bb","project":"599d8d6fc4ad04001905e8b8","createdAt":"2017-08-23T14:13:03.394Z","releaseDate":"2017-08-23T14:13:03.394Z","categories":["599d8d6fc4ad04001905e8bc","59a8381141bce5000f12c298","59a8382505f519001bfbb869","59a838ab78ddf9000f47a540","59a8413c5f69db002f7fd01d","59b712aca50f750030f41a13","59b713e8d8aa11003a9f8c27","59b7140ca50f750030f41acd","59b71432944cbe003083fed7","59b8372c944cbe003084bdc0","5c5c829866ef540011c2599c","5c5c82c3dc49780051f2d293","5ce430d1b3ddaa0010fc9e35","60da389606d3f9006bfce338","624f1fa2fa2e12066f9d2add","6376bee8127d990003169e8f","661811e9287a080041aea2bc","6618127636084d004560875a","67a53cac0d5096002a78c4c5","67a655b0ee1e570044b62792","67a65611a3843f0053aa3ba0","67a6564c3e340500113786b0","67a664b94b57f3005424e705","67a66e7ec298200062e13381","67a66efbc28d4400588f12e7","67a66f315157260010e176bd","67a66f51ceb469005ecc438d","67a66fa4297355003ec0eabd","67a66fc4ee08820065d2d8dd","67a66ff32326a6002a0f7233","67a6710946e14e00121204b4","67a6725712e0920031937db5","67a67665c298200062e13cf0","67a676935c522a000f6b97cc","67b8c180190c770018af1f81","67b8f31377247c003734b362","67b8f455be616d0011ddf23a","67b900d377247c003734f311","67bcb8572a9e27001e3cff69","6801755fd6fe3f00537cc4fa","68017679a69cd20023fd4953"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1","__v":13,"updatedAt":"2025-04-17T21:45:29.788Z"}],"variableDefaults":[{"source":"security","type":"oauth2","_id":"67462e86b10ce7000f01eaa8","name":"auth","apiSetting":"5c5c82c3dc49780051f2d292"},{"source":"security","type":"http","_id":"67462e86b10ce7000f01eaa7","name":"basic","scheme":"basic","apiSetting":"5c5c82c3dc49780051f2d292"},{"apiSetting":"67b900d377247c003734f310","name":"oauth","source":"security","type":"oauth2","_id":"687abcaa316b51eb6e976e98"}],"webhookEnabled":false,"isHubEditable":true},"projectStore":{"data":{"allow_crawlers":"disabled","canonical_url":null,"default_version":{"name":"1"},"description":null,"glossary":[],"homepage_url":"https://www.bamboohr.com","id":"599d8d6fc4ad04001905e8b8","name":"BambooHR","parent":null,"redirects":[],"sitemap":"disabled","llms_txt":"disabled","subdomain":"bamboohr","suggested_edits":"enabled","uri":"/projects/me","variable_defaults":[{"name":"auth","source":"security","type":"oauth2","id":"67462e86b10ce7000f01eaa8"},{"name":"basic","scheme":"basic","source":"security","type":"http","id":"67462e86b10ce7000f01eaa7"},{"name":"oauth","source":"security","type":"oauth2","id":"687abcaa316b51eb6e976e98"}],"webhooks":[],"api_designer":{"allow_editing":"enabled"},"custom_login":{"login_url":null,"logout_url":null},"features":{"mdx":"disabled"},"mcp":{},"onboarding_completed":{"api":true,"appearance":true,"documentation":true,"domain":true,"jwt":true,"logs":false,"metricsSDK":false},"pages":{"not_found":null},"privacy":{"openapi":"admin","password":null,"view":"public"},"refactored":{"status":"disabled","migrated":"unknown"},"seo":{"overwrite_title_tag":"disabled"},"plan":{"type":"startup","grace_period":{"enabled":false,"end_date":null},"trial":{"expired":false,"end_date":"2017-09-06T14:13:03.367Z"}},"reference":{"api_sdk_snippets":"enabled","defaults":"always_use","json_editor":"disabled","oauth_flows":"disabled","request_history":"enabled","response_examples":"collapsed","response_schemas":"collapsed","sdk_snippets":{"external":"disabled"}},"health_check":{"provider":"none","settings":{"manual":{"status":"down","url":null},"statuspage":{"id":null}}},"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},"recaptcha":{"site_key":null,"secret_key":null},"segment":{"key":null,"domain":null},"speakeasy":{"key":null,"spec_url":null},"stainless":{"key":null,"name":null},"typekit":{"key":null},"zendesk":{"subdomain":null},"intercom":{"app_id":null,"secure_mode":{"key":null,"email_only":false}}},"permissions":{"appearance":{"private_label":"disabled","custom_code":{"css":"enabled","html":"disabled","js":"disabled"}},"branches":{"merge":{"admin":true}}},"appearance":{"brand":{"primary_color":"#599D15","link_color":"#599D15","theme":"dark"},"changelog":{"layout":"collapsed","show_author":true,"show_exact_date":false},"layout":{"full_width":"disabled","style":"classic"},"markdown":{"callouts":{"icon_font":"emojis"}},"table_of_contents":"disabled","whats_next_label":null,"footer":{"readme_logo":"show"},"logo":{"size":"default","dark_mode":{"uri":null,"url":"https://files.readme.io/bea0d00-white-logo.png","name":"white-logo.png","width":1000,"height":149,"color":"#333","links":{"original_url":null}},"main":{"uri":null,"url":"https://files.readme.io/9b7660c-small-logo.png","name":"logo.png","width":1000,"height":149,"color":"#8cc43c","links":{"original_url":"https://files.readme.io/be77fc0-logo.png"}},"favicon":{"uri":null,"url":"https://files.readme.io/9b6a0cd-small-bamboohricon.png","name":"bamboohricon.png","width":252,"height":252,"color":"#dae8c8","links":{"original_url":"https://files.readme.io/35262e9-bamboohricon.png"}}},"custom_code":{"css":"@import url('https://fonts.googleapis.com/css?family=Lato');\n\nbody {\n font-family: 'Lato', Arial, Helvetica, sans-serif;\n font-weight: 400;\n padding: 10px;\n}\n\nh1 {\n font-family: 'Lato', Arial, Helvetica, sans-serif;\n font-size: 36px;\n font-weight: 800;\n line-height: 44px;\n}","js":null,"html":{"header":null,"home_footer":null,"page_footer":null}},"header":{"type":"solid","gradient_color":null,"link_style":"buttons","overlay":{"fill":"auto","type":"triangles","position":"top-left","image":{"uri":null,"url":null,"name":null,"width":null,"height":null,"color":null,"links":{"original_url":null}}}},"ai":{"dropdown":"disabled","options":{"chatgpt":"enabled","claude":"enabled","clipboard":"enabled","copilot":"enabled","view_as_markdown":"enabled"}},"navigation":{"first_page":"documentation","left":[{"type":"guides","title":null,"url":null,"custom_page":null},{"type":"reference","title":null,"url":null,"custom_page":null}],"logo_link":"landing_page","page_icons":"enabled","right":[{"type":"user_controls","title":null,"url":null,"custom_page":null}],"sub_nav":[],"subheader_layout":"dropdown","version":"enabled","links":{"home":{"label":"Home","visibility":"enabled"},"graphql":{"label":"GraphQL","visibility":"disabled"},"guides":{"label":"Guides","alias":"Documentation","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":"disabled"}}}},"git":{"connection":{"repository":{},"organization":null,"status":"inactive"}}}},"version":{"_id":"599d8d6fc4ad04001905e8bb","project":"599d8d6fc4ad04001905e8b8","createdAt":"2017-08-23T14:13:03.394Z","releaseDate":"2017-08-23T14:13:03.394Z","categories":["599d8d6fc4ad04001905e8bc","59a8381141bce5000f12c298","59a8382505f519001bfbb869","59a838ab78ddf9000f47a540","59a8413c5f69db002f7fd01d","59b712aca50f750030f41a13","59b713e8d8aa11003a9f8c27","59b7140ca50f750030f41acd","59b71432944cbe003083fed7","59b8372c944cbe003084bdc0","5c5c829866ef540011c2599c","5c5c82c3dc49780051f2d293","5ce430d1b3ddaa0010fc9e35","60da389606d3f9006bfce338","624f1fa2fa2e12066f9d2add","6376bee8127d990003169e8f","661811e9287a080041aea2bc","6618127636084d004560875a","67a53cac0d5096002a78c4c5","67a655b0ee1e570044b62792","67a65611a3843f0053aa3ba0","67a6564c3e340500113786b0","67a664b94b57f3005424e705","67a66e7ec298200062e13381","67a66efbc28d4400588f12e7","67a66f315157260010e176bd","67a66f51ceb469005ecc438d","67a66fa4297355003ec0eabd","67a66fc4ee08820065d2d8dd","67a66ff32326a6002a0f7233","67a6710946e14e00121204b4","67a6725712e0920031937db5","67a67665c298200062e13cf0","67a676935c522a000f6b97cc","67b8c180190c770018af1f81","67b8f31377247c003734b362","67b8f455be616d0011ddf23a","67b900d377247c003734f311","67bcb8572a9e27001e3cff69","6801755fd6fe3f00537cc4fa","68017679a69cd20023fd4953"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1","__v":13,"updatedAt":"2025-04-17T21:45:29.788Z"}},"is404":false,"isDetachedProductionSite":false,"lang":"en","langFull":"Default","reqUrl":"/docs/postman-collection","version":{"_id":"599d8d6fc4ad04001905e8bb","project":"599d8d6fc4ad04001905e8b8","createdAt":"2017-08-23T14:13:03.394Z","releaseDate":"2017-08-23T14:13:03.394Z","categories":["599d8d6fc4ad04001905e8bc","59a8381141bce5000f12c298","59a8382505f519001bfbb869","59a838ab78ddf9000f47a540","59a8413c5f69db002f7fd01d","59b712aca50f750030f41a13","59b713e8d8aa11003a9f8c27","59b7140ca50f750030f41acd","59b71432944cbe003083fed7","59b8372c944cbe003084bdc0","5c5c829866ef540011c2599c","5c5c82c3dc49780051f2d293","5ce430d1b3ddaa0010fc9e35","60da389606d3f9006bfce338","624f1fa2fa2e12066f9d2add","6376bee8127d990003169e8f","661811e9287a080041aea2bc","6618127636084d004560875a","67a53cac0d5096002a78c4c5","67a655b0ee1e570044b62792","67a65611a3843f0053aa3ba0","67a6564c3e340500113786b0","67a664b94b57f3005424e705","67a66e7ec298200062e13381","67a66efbc28d4400588f12e7","67a66f315157260010e176bd","67a66f51ceb469005ecc438d","67a66fa4297355003ec0eabd","67a66fc4ee08820065d2d8dd","67a66ff32326a6002a0f7233","67a6710946e14e00121204b4","67a6725712e0920031937db5","67a67665c298200062e13cf0","67a676935c522a000f6b97cc","67b8c180190c770018af1f81","67b8f31377247c003734b362","67b8f455be616d0011ddf23a","67b900d377247c003734f311","67bcb8572a9e27001e3cff69","6801755fd6fe3f00537cc4fa","68017679a69cd20023fd4953"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1","__v":13,"updatedAt":"2025-04-17T21:45:29.788Z"}}">