[{"data":1,"prerenderedAt":1847},["ShallowReactive",2],{"navigation":3,"\u002Fapi\u002Frequests-and-responses":547,"\u002Fapi\u002Frequests-and-responses-surround":1842},[4,28,62,92,117,146,253,292,325,349,385,421,459,488],{"title":5,"path":6,"stem":7,"children":8,"icon":27},"Getting Started","\u002Fgetting-started","1.getting-started\u002F1.index",[9,12,17,22],{"title":10,"path":6,"stem":7,"icon":11},"Introduction","i-lucide-house",{"title":13,"path":14,"stem":15,"icon":16},"Usage","\u002Fgetting-started\u002Fusage","1.getting-started\u002F3.usage","i-lucide-sliders",{"title":18,"path":19,"stem":20,"icon":21},"Signing in on the mobile app","\u002Fgetting-started\u002Fmobile-app-sign-in","1.getting-started\u002F4.mobile-app-sign-in","i-lucide-smartphone",{"title":23,"path":24,"stem":25,"icon":26},"Running without email","\u002Fgetting-started\u002Frunning-without-email","1.getting-started\u002F5.running-without-email","i-lucide-mail-x",false,{"title":29,"icon":27,"path":30,"stem":31,"children":32,"page":27},"Security & Privacy","\u002Fsecurity","10.security",[33,38,43,47,52,57],{"title":34,"path":35,"stem":36,"icon":37},"Security Overview","\u002Fsecurity\u002Foverview","10.security\u002F1.overview","i-lucide-shield-check",{"title":39,"path":40,"stem":41,"icon":42},"Authentication","\u002Fsecurity\u002Fauthentication","10.security\u002F2.authentication","i-lucide-log-in",{"title":44,"path":45,"stem":46,"icon":21},"Two-Factor & Devices","\u002Fsecurity\u002Ftwo-factor-and-devices","10.security\u002F3.two-factor-and-devices",{"title":48,"path":49,"stem":50,"icon":51},"Audit & Monitoring","\u002Fsecurity\u002Faudit-and-monitoring","10.security\u002F4.audit-and-monitoring","i-lucide-scroll-text",{"title":53,"path":54,"stem":55,"icon":56},"Account Deletion & Privacy","\u002Fsecurity\u002Faccount-deletion-and-privacy","10.security\u002F5.account-deletion-and-privacy","i-lucide-user-x",{"title":58,"path":59,"stem":60,"icon":61},"Roles & Permissions","\u002Fsecurity\u002Froles-and-permissions","10.security\u002F6.roles-and-permissions","i-lucide-key-round",{"title":63,"icon":27,"path":64,"stem":65,"children":66,"page":27},"Billing & Plans","\u002Fbilling","11.billing",[67,72,77,82,87],{"title":68,"path":69,"stem":70,"icon":71},"Plans","\u002Fbilling\u002Fplans","11.billing\u002F1.plans","i-lucide-credit-card",{"title":73,"path":74,"stem":75,"icon":76},"Limits & Usage","\u002Fbilling\u002Flimits-and-usage","11.billing\u002F2.limits-and-usage","i-lucide-gauge",{"title":78,"path":79,"stem":80,"icon":81},"Managing Your Subscription","\u002Fbilling\u002Fmanaging-your-subscription","11.billing\u002F3.managing-your-subscription","i-lucide-receipt",{"title":83,"path":84,"stem":85,"icon":86},"Add-ons","\u002Fbilling\u002Fadd-ons","11.billing\u002F4.add-ons","i-lucide-puzzle",{"title":88,"path":89,"stem":90,"icon":91},"Integrations","\u002Fbilling\u002Fintegrations","11.billing\u002F5.integrations","i-lucide-plug",{"title":93,"icon":27,"path":94,"stem":95,"children":96,"page":27},"Settings","\u002Fsettings","12.settings",[97,101,105,109,113],{"title":98,"path":99,"stem":100},"General","\u002Fsettings\u002Fgeneral","12.settings\u002F1.general",{"title":102,"path":103,"stem":104},"Leave Types","\u002Fsettings\u002Fleavetype","12.settings\u002F2.leaveType",{"title":106,"path":107,"stem":108},"Carry Forward","\u002Fsettings\u002Fcarryforward","12.settings\u002F3.carryForward",{"title":110,"path":111,"stem":112},"Department Management","\u002Fsettings\u002Fdepartments","12.settings\u002F4.departments",{"title":114,"path":115,"stem":116},"Public Holidays","\u002Fsettings\u002Fpublicholiday","12.settings\u002F5.publicholiday",{"title":118,"path":119,"stem":120,"children":121,"page":27},"Mcp","\u002Fmcp","13.mcp",[122,127,131,136,141],{"title":123,"path":124,"stem":125,"icon":126},"Overview","\u002Fmcp\u002Foverview","13.mcp\u002F1.overview","i-lucide-bot",{"title":128,"path":129,"stem":130,"icon":91},"Connecting","\u002Fmcp\u002Fconnecting","13.mcp\u002F2.connecting",{"title":132,"path":133,"stem":134,"icon":135},"Tools Reference","\u002Fmcp\u002Ftools","13.mcp\u002F3.tools","i-lucide-wrench",{"title":137,"path":138,"stem":139,"icon":140},"Security","\u002Fmcp\u002Fsecurity","13.mcp\u002F4.security","i-lucide-shield",{"title":142,"path":143,"stem":144,"icon":145},"Integrating Your Own MCP Client","\u002Fmcp\u002Fcustom-client","13.mcp\u002F5.custom-client","i-lucide-code",{"title":147,"icon":27,"path":148,"stem":149,"children":150,"page":27},"Public API","\u002Fapi","14.api",[151,156,160,164,169,174,179,183,208,238,243,248],{"title":152,"path":153,"stem":154,"icon":155},"API Overview","\u002Fapi\u002Foverview","14.api\u002F1.overview","i-lucide-code-xml",{"title":5,"path":157,"stem":158,"icon":159},"\u002Fapi\u002Fgetting-started","14.api\u002F2.getting-started","i-lucide-rocket",{"title":161,"path":162,"stem":163,"icon":61},"Authentication & Tokens","\u002Fapi\u002Fauthentication","14.api\u002F3.authentication",{"title":165,"path":166,"stem":167,"icon":168},"API Roles & Scopes","\u002Fapi\u002Froles-and-scopes","14.api\u002F4.roles-and-scopes","i-lucide-layers",{"title":170,"path":171,"stem":172,"icon":173},"Requests & Responses","\u002Fapi\u002Frequests-and-responses","14.api\u002F5.requests-and-responses","i-lucide-arrow-left-right",{"title":175,"path":176,"stem":177,"icon":178},"Errors","\u002Fapi\u002Ferrors","14.api\u002F6.errors","i-lucide-circle-alert",{"title":180,"path":181,"stem":182,"icon":76},"Rate Limits","\u002Fapi\u002Frate-limits","14.api\u002F7.rate-limits",{"title":184,"icon":185,"path":186,"stem":187,"children":188,"page":27},"Guides","i-lucide-book-marked","\u002Fapi\u002Fguides","14.api\u002F8.guides",[189,194,199,204],{"title":190,"path":191,"stem":192,"icon":193},"People","\u002Fapi\u002Fguides\u002Fpeople","14.api\u002F8.guides\u002F1.people","i-lucide-users",{"title":195,"path":196,"stem":197,"icon":198},"Leave","\u002Fapi\u002Fguides\u002Fleave","14.api\u002F8.guides\u002F2.leave","i-lucide-calendar-days",{"title":200,"path":201,"stem":202,"icon":203},"Time","\u002Fapi\u002Fguides\u002Ftime","14.api\u002F8.guides\u002F3.time","i-lucide-clock",{"title":205,"path":206,"stem":207,"icon":81},"Expenses & Documents","\u002Fapi\u002Fguides\u002Fexpenses-and-documents","14.api\u002F8.guides\u002F4.expenses-and-documents",{"title":209,"icon":210,"path":211,"stem":212,"children":213,"page":27},"Webhooks","i-lucide-webhook","\u002Fapi\u002Fwebhooks","14.api\u002F9.webhooks",[214,218,223,228,233],{"title":215,"path":216,"stem":217,"icon":210},"Webhooks Overview","\u002Fapi\u002Fwebhooks\u002Foverview","14.api\u002F9.webhooks\u002F1.overview",{"title":219,"path":220,"stem":221,"icon":222},"Events Reference","\u002Fapi\u002Fwebhooks\u002Fevents","14.api\u002F9.webhooks\u002F2.events","i-lucide-list",{"title":224,"path":225,"stem":226,"icon":227},"Verifying Signatures","\u002Fapi\u002Fwebhooks\u002Fverifying-signatures","14.api\u002F9.webhooks\u002F3.verifying-signatures","i-lucide-badge-check",{"title":229,"path":230,"stem":231,"icon":232},"Retries & Failures","\u002Fapi\u002Fwebhooks\u002Fretries-and-failures","14.api\u002F9.webhooks\u002F4.retries-and-failures","i-lucide-refresh-cw",{"title":234,"path":235,"stem":236,"icon":237},"Best Practices","\u002Fapi\u002Fwebhooks\u002Fbest-practices","14.api\u002F9.webhooks\u002F5.best-practices","i-lucide-list-checks",{"title":239,"path":240,"stem":241,"icon":242},"Postman & OpenAPI","\u002Fapi\u002Fpostman-and-openapi","14.api\u002F91.postman-and-openapi","i-lucide-file-json",{"title":244,"path":245,"stem":246,"icon":247},"Versioning & Changes","\u002Fapi\u002Fversioning","14.api\u002F92.versioning","i-lucide-git-branch",{"title":249,"path":250,"stem":251,"icon":252},"API Reference","\u002Fapi\u002Freference","14.api\u002F93.reference","i-lucide-book-open",{"title":254,"icon":27,"path":255,"stem":256,"children":257,"page":27},"Data Import & Migration","\u002Fdata-import","2.data-import",[258,262,267,272,277,282,287],{"title":123,"path":259,"stem":260,"icon":261},"\u002Fdata-import\u002Foverview","2.data-import\u002F1.overview","i-lucide-database",{"title":263,"path":264,"stem":265,"icon":266},"Importing a File","\u002Fdata-import\u002Fimporting-a-file","2.data-import\u002F2.importing-a-file","i-lucide-file-up",{"title":268,"path":269,"stem":270,"icon":271},"Supported Platforms","\u002Fdata-import\u002Fsupported-platforms","2.data-import\u002F3.supported-platforms","i-lucide-layout-grid",{"title":273,"path":274,"stem":275,"icon":276},"Direct Connections","\u002Fdata-import\u002Fdirect-connections","2.data-import\u002F4.direct-connections","i-lucide-plug-zap",{"title":278,"path":279,"stem":280,"icon":281},"Custom Templates","\u002Fdata-import\u002Fcustom-templates","2.data-import\u002F5.custom-templates","i-lucide-layout-template",{"title":283,"path":284,"stem":285,"icon":286},"Rollback & Import History","\u002Fdata-import\u002Frollback-and-history","2.data-import\u002F6.rollback-and-history","i-lucide-undo-2",{"title":288,"path":289,"stem":290,"icon":291},"Troubleshooting","\u002Fdata-import\u002Ftroubleshooting","2.data-import\u002F7.troubleshooting","i-lucide-life-buoy",{"title":293,"icon":27,"path":294,"stem":295,"children":296,"page":27},"Leave Management","\u002Fleave-management","3.leave-management",[297,302,307,312,316,321],{"title":298,"path":299,"stem":300,"icon":301},"Leave Management Overview","\u002Fleave-management\u002Foverview","3.leave-management\u002F1.overview","i-lucide-palmtree",{"title":303,"path":304,"stem":305,"icon":306},"Requesting Leave","\u002Fleave-management\u002Frequesting-leave","3.leave-management\u002F2.requesting-leave","i-lucide-calendar-plus",{"title":308,"path":309,"stem":310,"icon":311},"Leave Balances","\u002Fleave-management\u002Fleave-balances","3.leave-management\u002F3.leave-balances","i-lucide-wallet",{"title":313,"path":314,"stem":315,"icon":193},"Group Booking","\u002Fleave-management\u002Fgroup-booking","3.leave-management\u002F4.group-booking",{"title":317,"path":318,"stem":319,"icon":320},"Editing and Cancelling Leave","\u002Fleave-management\u002Fediting-and-cancelling","3.leave-management\u002F5.editing-and-cancelling","i-lucide-pencil",{"title":322,"path":323,"stem":324,"icon":291},"Leave Troubleshooting","\u002Fleave-management\u002Ftroubleshooting","3.leave-management\u002F6.troubleshooting",{"title":326,"icon":27,"path":327,"stem":328,"children":329,"page":27},"Approvals","\u002Fapprovals","4.approvals",[330,335,340,344],{"title":331,"path":332,"stem":333,"icon":334},"Approvals Overview","\u002Fapprovals\u002Foverview","4.approvals\u002F1.overview","i-lucide-check-check",{"title":336,"path":337,"stem":338,"icon":339},"Leave Approvals","\u002Fapprovals\u002Fleave-approvals","4.approvals\u002F2.leave-approvals","i-lucide-calendar-check",{"title":341,"path":342,"stem":343,"icon":81},"Expense Approvals","\u002Fapprovals\u002Fexpense-approvals","4.approvals\u002F3.expense-approvals",{"title":345,"path":346,"stem":347,"icon":348},"Time Approvals","\u002Fapprovals\u002Ftime-approvals","4.approvals\u002F4.time-approvals","i-lucide-clock-9",{"title":350,"icon":27,"path":351,"stem":352,"children":353,"page":27},"Time tracking & monitoring","\u002Ftime-tracking","5.Time Tracking",[354,359,364,369,373,377,381],{"title":355,"path":356,"stem":357,"icon":358},"Clocking In & Location","\u002Ftime-tracking\u002Fclock-in-and-location","5.Time Tracking\u002F5.clock-in-and-location","i-lucide-map-pin",{"title":360,"path":361,"stem":362,"icon":363},"Overtime & Pay-Period Lockdown","\u002Ftime-tracking\u002Fovertime-and-lockdown","5.Time Tracking\u002F6.overtime-and-lockdown","i-lucide-lock",{"title":365,"path":366,"stem":367,"icon":368},"Geofencing","\u002Ftime-tracking\u002Fgeofencing","5.Time Tracking\u002F7.geofencing","i-lucide-map",{"title":370,"path":371,"stem":372},"Time & Projects","\u002Ftime-tracking\u002Ftimeandprojects","5.Time Tracking\u002FTime&Projects",{"title":374,"path":375,"stem":376},"Time Tracking","\u002Ftime-tracking\u002Ftime-tracking","5.Time Tracking\u002FTime-tracking",{"title":378,"path":379,"stem":380},"Timeboard","\u002Ftime-tracking\u002Ftimeboard","5.Time Tracking\u002FTimeBoard",{"title":382,"path":383,"stem":384},"Timesheets","\u002Ftime-tracking\u002Ftimesheets","5.Time Tracking\u002FTimesheets",{"title":386,"icon":27,"path":387,"stem":388,"children":389,"page":27},"Expenses","\u002Fexpenses","6.expenses",[390,394,398,402,406,411,416],{"title":391,"path":392,"stem":393},"Expense Claims","\u002Fexpenses\u002Foverview","6.expenses\u002F1.overview",{"title":395,"path":396,"stem":397},"Add & Manage Purchases","\u002Fexpenses\u002Fpurchases","6.expenses\u002F2.purchases",{"title":399,"path":400,"stem":401},"Travel & Mileage Entry","\u002Fexpenses\u002Ftravelentries","6.expenses\u002F3.travelentries",{"title":403,"path":404,"stem":405,"icon":71},"Company Card Expenses","\u002Fexpenses\u002Fcompany-cards","6.expenses\u002F4.company-cards",{"title":407,"path":408,"stem":409,"icon":410},"Per Diems","\u002Fexpenses\u002Fper-diems","6.expenses\u002F5.per-diems","i-lucide-utensils",{"title":412,"path":413,"stem":414,"icon":415},"Receipt Scanning","\u002Fexpenses\u002Freceipt-scanning","6.expenses\u002F6.receipt-scanning","i-lucide-scan-line",{"title":417,"path":418,"stem":419,"icon":420},"Statuses & Submission","\u002Fexpenses\u002Fstatuses-and-submission","6.expenses\u002F7.statuses-and-submission","i-lucide-git-pull-request-arrow",{"title":422,"icon":27,"path":423,"stem":424,"children":425,"page":27},"Documents & E-Signatures","\u002Fdocuments","7.documents",[426,430,435,440,445,449,454],{"title":123,"path":427,"stem":428,"icon":429},"\u002Fdocuments\u002Foverview","7.documents\u002F1.overview","i-lucide-folder-open",{"title":431,"path":432,"stem":433,"icon":434},"Uploading Documents","\u002Fdocuments\u002Fuploading","7.documents\u002F2.uploading","i-lucide-upload",{"title":436,"path":437,"stem":438,"icon":439},"E-Signatures","\u002Fdocuments\u002Fe-signatures","7.documents\u002F3.e-signatures","i-lucide-pen-tool",{"title":441,"path":442,"stem":443,"icon":444},"Audit Trail & Certificate","\u002Fdocuments\u002Faudit-trail","7.documents\u002F4.audit-trail","i-lucide-file-check",{"title":446,"path":447,"stem":448,"icon":281},"Templates & Bulk Send","\u002Fdocuments\u002Ftemplates-and-bulk-send","7.documents\u002F5.templates-and-bulk-send",{"title":450,"path":451,"stem":452,"icon":453},"Onboarding","\u002Fdocuments\u002Fonboarding","7.documents\u002F6.onboarding","i-lucide-user-plus",{"title":455,"path":456,"stem":457,"icon":458},"Offboarding","\u002Fdocuments\u002Foffboarding","7.documents\u002F7.offboarding","i-lucide-user-minus",{"title":460,"icon":27,"path":461,"stem":462,"children":463,"page":27},"People & HR","\u002Fpeople","8.people",[464,468,473,478,483],{"title":465,"path":466,"stem":467,"icon":193},"Directory & Profiles","\u002Fpeople\u002Fdirectory-and-profiles","8.people\u002F1.directory-and-profiles",{"title":469,"path":470,"stem":471,"icon":472},"Managing Users","\u002Fpeople\u002Fmanaging-users","8.people\u002F2.managing-users","i-lucide-user-cog",{"title":474,"path":475,"stem":476,"icon":477},"HR Records","\u002Fpeople\u002Fhr-records","8.people\u002F3.hr-records","i-lucide-folder-archive",{"title":479,"path":480,"stem":481,"icon":482},"Performance","\u002Fpeople\u002Fperformance","8.people\u002F4.performance","i-lucide-target",{"title":484,"path":485,"stem":486,"icon":487},"Training","\u002Fpeople\u002Ftraining","8.people\u002F5.training","i-lucide-graduation-cap",{"title":489,"icon":27,"path":490,"stem":491,"children":492,"page":27},"Features","\u002Ffeatures","9.features",[493,497,501,505,510,515,519,523,527,531,535,539,543],{"title":494,"path":495,"stem":496,"icon":11},"Home","\u002Ffeatures\u002Fhome","9.features\u002F1.home",{"title":498,"path":499,"stem":500},"Email Configuration (SMTP)","\u002Ffeatures\u002Femail-configuration","9.features\u002F10.email-configuration",{"title":502,"path":503,"stem":504},"SMTP troubleshoot","\u002Ffeatures\u002Fsmtp-troubleshoot","9.features\u002F11.smtp-troubleshoot",{"title":506,"path":507,"stem":508,"icon":509},"Notifications","\u002Ffeatures\u002Fnotifications","9.features\u002F12.notifications","i-lucide-bell",{"title":511,"path":512,"stem":513,"icon":514},"Reports","\u002Ffeatures\u002Freports","9.features\u002F13.reports","i-lucide-bar-chart-3",{"title":516,"path":517,"stem":518},"Dashboard","\u002Ffeatures\u002Fdashboard","9.features\u002F2.dashboard",{"title":520,"path":521,"stem":522},"Calendar & Leave Overview","\u002Ffeatures\u002Fcalendar","9.features\u002F3.calendar",{"title":524,"path":525,"stem":526},"Calendar Integration","\u002Ffeatures\u002Fcalendar-integration","9.features\u002F4.calendar-integration",{"title":528,"path":529,"stem":530},"Schedules","\u002Ffeatures\u002Fschedules","9.features\u002F5.schedules",{"title":532,"path":533,"stem":534},"Project Management","\u002Ffeatures\u002Fprojects","9.features\u002F6.projects",{"title":536,"path":537,"stem":538},"Expense Settings","\u002Ffeatures\u002Fexpense-settings","9.features\u002F7.expense-settings",{"title":540,"path":541,"stem":542},"Auth0 SSO Integration","\u002Ffeatures\u002Fauth0-integration","9.features\u002F8.auth0-integration",{"title":544,"path":545,"stem":546},"Password & Authentication Policy","\u002Ffeatures\u002Fpolicies","9.features\u002F9.policies",{"id":548,"title":170,"body":549,"description":1835,"extension":1836,"links":1837,"meta":1838,"navigation":1839,"path":171,"seo":1840,"stem":172,"__hash__":1841},"docs\u002F14.api\u002F5.requests-and-responses.md",{"type":550,"value":551,"toc":1822},"minimark",[552,556,561,573,687,696,832,858,865,869,901,905,908,979,996,1000,1003,1057,1070,1204,1226,1418,1425,1440,1445,1448,1490,1496,1500,1516,1550,1554,1602,1606,1613,1698,1764,1767,1778,1784,1788,1799,1803,1818],[553,554,555],"p",{},"Every endpoint follows the same conventions, so code you write for one works for the others.",[557,558,560],"h2",{"id":559},"the-envelope","The envelope",[553,562,563,564,568,569,572],{},"A successful response wraps its payload in ",[565,566,567],"code",{},"data"," and adds ",[565,570,571],{},"meta",":",[574,575,580],"pre",{"className":576,"code":577,"language":578,"meta":579,"style":579},"language-json shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","{\n  \"data\": { \"id\": \"cm...\", \"name\": \"Northwind Health\" },\n  \"meta\": { \"request_id\": \"8f2c4b1e-5d0a-4c55-9a3e-0f6b8f1c2d77\" }\n}\n","json","",[565,581,582,591,649,681],{"__ignoreMap":579},[583,584,587],"span",{"class":585,"line":586},"line",1,[583,588,590],{"class":589},"sMK4o","{\n",[583,592,594,597,600,603,605,608,611,615,617,619,621,625,627,630,632,635,637,639,641,644,646],{"class":585,"line":593},2,[583,595,596],{"class":589},"  \"",[583,598,567],{"class":599},"spNyl",[583,601,602],{"class":589},"\"",[583,604,572],{"class":589},[583,606,607],{"class":589}," {",[583,609,610],{"class":589}," \"",[583,612,614],{"class":613},"sBMFI","id",[583,616,602],{"class":589},[583,618,572],{"class":589},[583,620,610],{"class":589},[583,622,624],{"class":623},"sfazB","cm...",[583,626,602],{"class":589},[583,628,629],{"class":589},",",[583,631,610],{"class":589},[583,633,634],{"class":613},"name",[583,636,602],{"class":589},[583,638,572],{"class":589},[583,640,610],{"class":589},[583,642,643],{"class":623},"Northwind Health",[583,645,602],{"class":589},[583,647,648],{"class":589}," },\n",[583,650,652,654,656,658,660,662,664,667,669,671,673,676,678],{"class":585,"line":651},3,[583,653,596],{"class":589},[583,655,571],{"class":599},[583,657,602],{"class":589},[583,659,572],{"class":589},[583,661,607],{"class":589},[583,663,610],{"class":589},[583,665,666],{"class":613},"request_id",[583,668,602],{"class":589},[583,670,572],{"class":589},[583,672,610],{"class":589},[583,674,675],{"class":623},"8f2c4b1e-5d0a-4c55-9a3e-0f6b8f1c2d77",[583,677,602],{"class":589},[583,679,680],{"class":589}," }\n",[583,682,684],{"class":585,"line":683},4,[583,685,686],{"class":589},"}\n",[553,688,689,690,693,694,572],{},"A failed response has ",[565,691,692],{},"error"," instead of ",[565,695,567],{},[574,697,699],{"className":576,"code":698,"language":578,"meta":579,"style":579},"{\n  \"error\": {\n    \"code\": \"VALIDATION_FAILED\",\n    \"message\": \"limit must be an integer between 1 and 100.\",\n    \"details\": { \"field\": \"limit\" }\n  },\n  \"meta\": { \"request_id\": \"8f2c4b1e-5d0a-4c55-9a3e-0f6b8f1c2d77\" }\n}\n",[565,700,701,705,718,739,759,792,798,827],{"__ignoreMap":579},[583,702,703],{"class":585,"line":586},[583,704,590],{"class":589},[583,706,707,709,711,713,715],{"class":585,"line":593},[583,708,596],{"class":589},[583,710,692],{"class":599},[583,712,602],{"class":589},[583,714,572],{"class":589},[583,716,717],{"class":589}," {\n",[583,719,720,723,725,727,729,731,734,736],{"class":585,"line":651},[583,721,722],{"class":589},"    \"",[583,724,565],{"class":613},[583,726,602],{"class":589},[583,728,572],{"class":589},[583,730,610],{"class":589},[583,732,733],{"class":623},"VALIDATION_FAILED",[583,735,602],{"class":589},[583,737,738],{"class":589},",\n",[583,740,741,743,746,748,750,752,755,757],{"class":585,"line":683},[583,742,722],{"class":589},[583,744,745],{"class":613},"message",[583,747,602],{"class":589},[583,749,572],{"class":589},[583,751,610],{"class":589},[583,753,754],{"class":623},"limit must be an integer between 1 and 100.",[583,756,602],{"class":589},[583,758,738],{"class":589},[583,760,762,764,767,769,771,773,775,779,781,783,785,788,790],{"class":585,"line":761},5,[583,763,722],{"class":589},[583,765,766],{"class":613},"details",[583,768,602],{"class":589},[583,770,572],{"class":589},[583,772,607],{"class":589},[583,774,610],{"class":589},[583,776,778],{"class":777},"sbssI","field",[583,780,602],{"class":589},[583,782,572],{"class":589},[583,784,610],{"class":589},[583,786,787],{"class":623},"limit",[583,789,602],{"class":589},[583,791,680],{"class":589},[583,793,795],{"class":585,"line":794},6,[583,796,797],{"class":589},"  },\n",[583,799,801,803,805,807,809,811,813,815,817,819,821,823,825],{"class":585,"line":800},7,[583,802,596],{"class":589},[583,804,571],{"class":599},[583,806,602],{"class":589},[583,808,572],{"class":589},[583,810,607],{"class":589},[583,812,610],{"class":589},[583,814,666],{"class":613},[583,816,602],{"class":589},[583,818,572],{"class":589},[583,820,610],{"class":589},[583,822,675],{"class":623},[583,824,602],{"class":589},[583,826,680],{"class":589},[583,828,830],{"class":585,"line":829},8,[583,831,686],{"class":589},[833,834,835,846,852],"ul",{},[836,837,838,841,842,845],"li",{},[565,839,840],{},"error.code"," is stable and machine-readable. Branch on it. See ",[843,844,175],"a",{"href":176},".",[836,847,848,851],{},[565,849,850],{},"error.message"," is for people and may be reworded.",[836,853,854,857],{},[565,855,856],{},"error.details"," is optional. When present it holds safe hints, such as the name of the invalid field.",[553,859,860,861,864],{},"Every response, success or failure, carries ",[565,862,863],{},"Cache-Control: no-store",", so proxies and browsers do not keep copies of your data.",[557,866,868],{"id":867},"field-names-and-values","Field names and values",[833,870,871,888,891,898],{},[836,872,873,874,877,878,881,882,881,885,845],{},"JSON keys are ",[565,875,876],{},"snake_case",": ",[565,879,880],{},"first_name",", ",[565,883,884],{},"leave_year_start_month",[565,886,887],{},"expires_at",[836,889,890],{},"Ids are opaque strings. Do not parse them or assume a format.",[836,892,893,894,897],{},"Ids are only ever looked up inside the token's organization. An id from another organization returns ",[565,895,896],{},"404 NOT_FOUND",", exactly like an id that does not exist.",[836,899,900],{},"Fields the owner is not allowed to see are left out or redacted in the same way the app redacts them, for example private leave details.",[557,902,904],{"id":903},"dates-and-times","Dates and times",[553,906,907],{},"The API uses two formats, and the difference matters:",[909,910,911,930],"table",{},[912,913,914],"thead",{},[915,916,917,921,924,927],"tr",{},[918,919,920],"th",{},"Kind",[918,922,923],{},"Format",[918,925,926],{},"Example",[918,928,929],{},"Used for",[931,932,933,955],"tbody",{},[915,934,935,942,947,952],{},[936,937,938],"td",{},[939,940,941],"strong",{},"Calendar day",[936,943,944],{},[565,945,946],{},"YYYY-MM-DD",[936,948,949],{},[565,950,951],{},"2026-07-01",[936,953,954],{},"Days with no time of day: leave start and end dates, public holidays, dates of birth, employment dates",[915,956,957,962,965,970],{},[936,958,959],{},[939,960,961],{},"Instant",[936,963,964],{},"ISO 8601 in UTC",[936,966,967],{},[565,968,969],{},"2026-10-12T17:04:11.512Z",[936,971,972,973,881,976,978],{},"Moments in time: ",[565,974,975],{},"created_at",[565,977,887],{},", clock-in times",[553,980,981,982,984,985,988,989,992,993,845],{},"A calendar day is the same day for every reader, whatever their timezone: ",[565,983,951],{}," is July 1. Do not convert it to a timestamp in your local timezone, or it may shift to the previous or next day. When you need an organization's timezone, read ",[565,986,987],{},"timezone"," (an IANA name such as ",[565,990,991],{},"America\u002FToronto",") from ",[565,994,995],{},"GET \u002Forganization",[557,997,999],{"id":998},"pagination","Pagination",[553,1001,1002],{},"List endpoints use cursor pagination.",[909,1004,1005,1021],{},[912,1006,1007],{},[915,1008,1009,1012,1015,1018],{},[918,1010,1011],{},"Parameter",[918,1013,1014],{},"Default",[918,1016,1017],{},"Maximum",[918,1019,1020],{},"Notes",[931,1022,1023,1038],{},[915,1024,1025,1029,1032,1035],{},[936,1026,1027],{},[565,1028,787],{},[936,1030,1031],{},"50",[936,1033,1034],{},"100",[936,1036,1037],{},"Must be a whole number of 1 or more. Values above 100 are treated as 100.",[915,1039,1040,1045,1048,1050],{},[936,1041,1042],{},[565,1043,1044],{},"cursor",[936,1046,1047],{},"none",[936,1049],{},[936,1051,1052,1053,1056],{},"The ",[565,1054,1055],{},"meta.next_cursor"," value from the previous page. Opaque: pass it back unchanged.",[553,1058,1059,1060,1063,1064,1067,1068,572],{},"A list response adds ",[565,1061,1062],{},"has_more"," and ",[565,1065,1066],{},"next_cursor"," to ",[565,1069,571],{},[574,1071,1073],{"className":576,"code":1072,"language":578,"meta":579,"style":579},"{\n  \"data\": [ { \"id\": \"cm...\" }, { \"id\": \"cm...\" } ],\n  \"meta\": {\n    \"request_id\": \"1c7e...\",\n    \"has_more\": true,\n    \"next_cursor\": \"eyJpZCI6ImNtLi4uIn0\"\n  }\n}\n",[565,1074,1075,1079,1133,1145,1164,1177,1195,1200],{"__ignoreMap":579},[583,1076,1077],{"class":585,"line":586},[583,1078,590],{"class":589},[583,1080,1081,1083,1085,1087,1089,1092,1094,1096,1098,1100,1102,1104,1106,1108,1111,1113,1115,1117,1119,1121,1123,1125,1127,1130],{"class":585,"line":593},[583,1082,596],{"class":589},[583,1084,567],{"class":599},[583,1086,602],{"class":589},[583,1088,572],{"class":589},[583,1090,1091],{"class":589}," [",[583,1093,607],{"class":589},[583,1095,610],{"class":589},[583,1097,614],{"class":613},[583,1099,602],{"class":589},[583,1101,572],{"class":589},[583,1103,610],{"class":589},[583,1105,624],{"class":623},[583,1107,602],{"class":589},[583,1109,1110],{"class":589}," },",[583,1112,607],{"class":589},[583,1114,610],{"class":589},[583,1116,614],{"class":613},[583,1118,602],{"class":589},[583,1120,572],{"class":589},[583,1122,610],{"class":589},[583,1124,624],{"class":623},[583,1126,602],{"class":589},[583,1128,1129],{"class":589}," }",[583,1131,1132],{"class":589}," ],\n",[583,1134,1135,1137,1139,1141,1143],{"class":585,"line":651},[583,1136,596],{"class":589},[583,1138,571],{"class":599},[583,1140,602],{"class":589},[583,1142,572],{"class":589},[583,1144,717],{"class":589},[583,1146,1147,1149,1151,1153,1155,1157,1160,1162],{"class":585,"line":683},[583,1148,722],{"class":589},[583,1150,666],{"class":613},[583,1152,602],{"class":589},[583,1154,572],{"class":589},[583,1156,610],{"class":589},[583,1158,1159],{"class":623},"1c7e...",[583,1161,602],{"class":589},[583,1163,738],{"class":589},[583,1165,1166,1168,1170,1172,1174],{"class":585,"line":761},[583,1167,722],{"class":589},[583,1169,1062],{"class":613},[583,1171,602],{"class":589},[583,1173,572],{"class":589},[583,1175,1176],{"class":589}," true,\n",[583,1178,1179,1181,1183,1185,1187,1189,1192],{"class":585,"line":794},[583,1180,722],{"class":589},[583,1182,1066],{"class":613},[583,1184,602],{"class":589},[583,1186,572],{"class":589},[583,1188,610],{"class":589},[583,1190,1191],{"class":623},"eyJpZCI6ImNtLi4uIn0",[583,1193,1194],{"class":589},"\"\n",[583,1196,1197],{"class":585,"line":800},[583,1198,1199],{"class":589},"  }\n",[583,1201,1202],{"class":585,"line":829},[583,1203,686],{"class":589},[553,1205,1206,1207,1209,1210,1212,1213,1215,1216,1219,1220,1222,1223,845],{},"Keep requesting with ",[565,1208,1044],{}," set to the last ",[565,1211,1066],{}," until ",[565,1214,1062],{}," is ",[565,1217,1218],{},"false","; ",[565,1221,1066],{}," is then ",[565,1224,1225],{},"null",[574,1227,1231],{"className":1228,"code":1229,"language":1230,"meta":579,"style":579},"language-bash shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","cursor=\"\"\nwhile :; do\n  page=$(curl -s \"https:\u002F\u002Fapp.bookyourpto.com\u002Fapi\u002Fv1\u002F\u003Clist-endpoint>?limit=100${cursor:+&cursor=$cursor}\" \\\n    -H \"Authorization: Bearer $BOOKYOURPTO_TOKEN\")\n  # ... process .data ...\n  [ \"$(echo \"$page\" | jq -r '.meta.has_more')\" = \"true\" ] || break\n  cursor=$(echo \"$page\" | jq -r '.meta.next_cursor')\ndone\n","bash",[565,1232,1233,1244,1260,1302,1320,1326,1381,1413],{"__ignoreMap":579},[583,1234,1235,1238,1241],{"class":585,"line":586},[583,1236,1044],{"class":1237},"sTEyZ",[583,1239,1240],{"class":589},"=",[583,1242,1243],{"class":589},"\"\"\n",[583,1245,1246,1250,1254,1257],{"class":585,"line":593},[583,1247,1249],{"class":1248},"s7zQu","while",[583,1251,1253],{"class":1252},"s2Zo4"," :",[583,1255,1256],{"class":589},";",[583,1258,1259],{"class":1248}," do\n",[583,1261,1262,1265,1268,1271,1274,1276,1279,1282,1284,1286,1289,1291,1293,1296,1299],{"class":585,"line":651},[583,1263,1264],{"class":1237},"  page",[583,1266,1267],{"class":589},"=$(",[583,1269,1270],{"class":613},"curl",[583,1272,1273],{"class":623}," -s",[583,1275,610],{"class":589},[583,1277,1278],{"class":623},"https:\u002F\u002Fapp.bookyourpto.com\u002Fapi\u002Fv1\u002F\u003Clist-endpoint>?limit=100",[583,1280,1281],{"class":589},"${",[583,1283,1044],{"class":1237},[583,1285,572],{"class":589},[583,1287,1288],{"class":623},"+&",[583,1290,1044],{"class":1237},[583,1292,1240],{"class":623},[583,1294,1295],{"class":1237},"$cursor",[583,1297,1298],{"class":589},"}\"",[583,1300,1301],{"class":1237}," \\\n",[583,1303,1304,1307,1309,1312,1315,1317],{"class":585,"line":683},[583,1305,1306],{"class":623},"    -H",[583,1308,610],{"class":589},[583,1310,1311],{"class":623},"Authorization: Bearer ",[583,1313,1314],{"class":1237},"$BOOKYOURPTO_TOKEN",[583,1316,602],{"class":589},[583,1318,1319],{"class":589},")\n",[583,1321,1322],{"class":585,"line":761},[583,1323,1325],{"class":1324},"sHwdD","  # ... process .data ...\n",[583,1327,1328,1331,1334,1337,1339,1342,1344,1347,1350,1353,1356,1359,1362,1365,1367,1370,1372,1375,1378],{"class":585,"line":794},[583,1329,1330],{"class":589},"  [",[583,1332,1333],{"class":589}," \"$(",[583,1335,1336],{"class":1252},"echo",[583,1338,610],{"class":589},[583,1340,1341],{"class":1237},"$page",[583,1343,602],{"class":589},[583,1345,1346],{"class":589}," |",[583,1348,1349],{"class":613}," jq",[583,1351,1352],{"class":623}," -r ",[583,1354,1355],{"class":589},"'",[583,1357,1358],{"class":623},".meta.has_more",[583,1360,1361],{"class":589},"')\"",[583,1363,1364],{"class":589}," =",[583,1366,610],{"class":589},[583,1368,1369],{"class":623},"true",[583,1371,602],{"class":589},[583,1373,1374],{"class":589}," ]",[583,1376,1377],{"class":589}," ||",[583,1379,1380],{"class":1248}," break\n",[583,1382,1383,1386,1388,1390,1392,1394,1396,1398,1400,1403,1406,1409,1411],{"class":585,"line":800},[583,1384,1385],{"class":1237},"  cursor",[583,1387,1267],{"class":589},[583,1389,1336],{"class":1252},[583,1391,610],{"class":589},[583,1393,1341],{"class":1237},[583,1395,602],{"class":589},[583,1397,1346],{"class":589},[583,1399,1349],{"class":613},[583,1401,1402],{"class":623}," -r",[583,1404,1405],{"class":589}," '",[583,1407,1408],{"class":623},".meta.next_cursor",[583,1410,1355],{"class":589},[583,1412,1319],{"class":589},[583,1414,1415],{"class":585,"line":829},[583,1416,1417],{"class":1248},"done\n",[553,1419,1420,1421,1424],{},"A malformed or altered cursor returns ",[565,1422,1423],{},"422 VALIDATION_FAILED",". Keep the same filters on every page of a walk; a cursor only marks a position in the list.",[553,1426,1427,1428,1431,1432,1435,1436,1439],{},"A few endpoints return everything in one response and are not paginated: ",[565,1429,1430],{},"GET \u002Fleave-balances"," returns one object, ",[565,1433,1434],{},"GET \u002Fpublic-holidays"," returns a whole calendar year in one page, and ",[565,1437,1438],{},"GET \u002Fwebhook-events"," returns the full catalogue.",[1441,1442,1444],"h3",{"id":1443},"date-windows","Date windows",[553,1446,1447],{},"Some lists are also bounded by a date window, so a single request can never scan years of records. The window is in calendar days in the organization's timezone:",[909,1449,1450,1463],{},[912,1451,1452],{},[915,1453,1454,1457,1460],{},[918,1455,1456],{},"Endpoint",[918,1458,1459],{},"Default window",[918,1461,1462],{},"Longest window",[931,1464,1465,1478],{},[915,1466,1467,1472,1475],{},[936,1468,1469],{},[565,1470,1471],{},"GET \u002Ftime-entries",[936,1473,1474],{},"The last 30 days",[936,1476,1477],{},"120 days",[915,1479,1480,1485,1488],{},[936,1481,1482],{},[565,1483,1484],{},"GET \u002Fshifts",[936,1486,1487],{},"The next 7 days, starting today",[936,1489,1477],{},[553,1491,1492,1493,1495],{},"A window longer than the maximum, or an end before the start, returns ",[565,1494,1423],{},". To read a longer period, walk it in windows of up to 120 days.",[557,1497,1499],{"id":1498},"request-bodies","Request bodies",[553,1501,1502,1503,881,1506,881,1509,881,1512,1515],{},"Endpoints that accept a body (",[565,1504,1505],{},"POST",[565,1507,1508],{},"PATCH",[565,1510,1511],{},"PUT",[565,1513,1514],{},"DELETE",") expect JSON:",[833,1517,1518,1527,1538,1544],{},[836,1519,1520,1521,1524,1525,845],{},"Send ",[565,1522,1523],{},"Content-Type: application\u002Fjson",". A body sent with any other content type is refused with ",[565,1526,1423],{},[836,1528,1529,1530,1533,1534,1537],{},"The body may be at most ",[939,1531,1532],{},"1 MB",". A larger body is refused, usually with ",[565,1535,1536],{},"413"," by the network edge before it reaches the API.",[836,1539,1540,1541,1543],{},"Malformed JSON returns ",[565,1542,1423],{},", never a server error.",[836,1545,1546,1547,1549],{},"Send only the fields an endpoint documents. Many endpoints refuse an unknown field with ",[565,1548,1423],{}," rather than ignoring it, so a typo in a field name fails loudly.",[557,1551,1553],{"id":1552},"status-codes-on-success","Status codes on success",[909,1555,1556,1566],{},[912,1557,1558],{},[915,1559,1560,1563],{},[918,1561,1562],{},"Status",[918,1564,1565],{},"When",[931,1567,1568,1578,1588],{},[915,1569,1570,1575],{},[936,1571,1572],{},[565,1573,1574],{},"200 OK",[936,1576,1577],{},"A read, an update, or an action such as approve, reject or cancel. The body holds the record as it now stands.",[915,1579,1580,1585],{},[936,1581,1582],{},[565,1583,1584],{},"201 Created",[936,1586,1587],{},"A record was created. The body holds the new record.",[915,1589,1590,1595],{},[936,1591,1592],{},[565,1593,1594],{},"202 Accepted",[936,1596,1597,1598,1601],{},"A webhook test event or redelivery was queued. The body holds the delivery; its ",[565,1599,1600],{},"status"," shows whether the first attempt has already finished.",[557,1603,1605],{"id":1604},"idempotency-keys","Idempotency keys",[553,1607,1608,1609,1612],{},"Network failures happen. To retry a write safely, send an ",[565,1610,1611],{},"Idempotency-Key"," header with a value you generate for that operation, such as a UUID:",[574,1614,1616],{"className":1228,"code":1615,"language":1230,"meta":579,"style":579},"curl -X POST https:\u002F\u002Fapp.bookyourpto.com\u002Fapi\u002Fv1\u002F\u003Cendpoint> \\\n  -H \"Authorization: Bearer $BOOKYOURPTO_TOKEN\" \\\n  -H \"Content-Type: application\u002Fjson\" \\\n  -H \"Idempotency-Key: 6f1d3c7a-2b9e-4f0c-8a51-3e7d2c9b4a10\" \\\n  -d '{ ... }'\n",[565,1617,1618,1645,1660,1672,1685],{"__ignoreMap":579},[583,1619,1620,1622,1625,1628,1631,1634,1637,1640,1643],{"class":585,"line":586},[583,1621,1270],{"class":613},[583,1623,1624],{"class":623}," -X",[583,1626,1627],{"class":623}," POST",[583,1629,1630],{"class":623}," https:\u002F\u002Fapp.bookyourpto.com\u002Fapi\u002Fv1\u002F",[583,1632,1633],{"class":589},"\u003C",[583,1635,1636],{"class":623},"endpoin",[583,1638,1639],{"class":1237},"t",[583,1641,1642],{"class":589},">",[583,1644,1301],{"class":1237},[583,1646,1647,1650,1652,1654,1656,1658],{"class":585,"line":593},[583,1648,1649],{"class":623},"  -H",[583,1651,610],{"class":589},[583,1653,1311],{"class":623},[583,1655,1314],{"class":1237},[583,1657,602],{"class":589},[583,1659,1301],{"class":1237},[583,1661,1662,1664,1666,1668,1670],{"class":585,"line":651},[583,1663,1649],{"class":623},[583,1665,610],{"class":589},[583,1667,1523],{"class":623},[583,1669,602],{"class":589},[583,1671,1301],{"class":1237},[583,1673,1674,1676,1678,1681,1683],{"class":585,"line":683},[583,1675,1649],{"class":623},[583,1677,610],{"class":589},[583,1679,1680],{"class":623},"Idempotency-Key: 6f1d3c7a-2b9e-4f0c-8a51-3e7d2c9b4a10",[583,1682,602],{"class":589},[583,1684,1301],{"class":1237},[583,1686,1687,1690,1692,1695],{"class":585,"line":761},[583,1688,1689],{"class":623},"  -d",[583,1691,1405],{"class":589},[583,1693,1694],{"class":623},"{ ... }",[583,1696,1697],{"class":589},"'\n",[909,1699,1700,1710],{},[912,1701,1702],{},[915,1703,1704,1707],{},[918,1705,1706],{},"Situation",[918,1708,1709],{},"Result",[931,1711,1712,1723,1735,1745,1756],{},[915,1713,1714,1717],{},[936,1715,1716],{},"First request with the key",[936,1718,1719,1720,845],{},"Processed normally. The response is remembered for ",[939,1721,1722],{},"24 hours",[915,1724,1725,1728],{},[936,1726,1727],{},"Same key, same method, path and body, within 24 hours",[936,1729,1730,1731,1734],{},"The original response is returned again, with the header ",[565,1732,1733],{},"Idempotent-Replayed: true",". The write is not repeated.",[915,1736,1737,1740],{},[936,1738,1739],{},"Same key with a different body or query",[936,1741,1742],{},[565,1743,1744],{},"409 IDEMPOTENCY_CONFLICT",[915,1746,1747,1750],{},[936,1748,1749],{},"Same key while the first request is still running",[936,1751,1752,1755],{},[565,1753,1754],{},"409 CONFLICT",". Wait and retry.",[915,1757,1758,1761],{},[936,1759,1760],{},"The first request failed with a server error (5xx)",[936,1762,1763],{},"The key is released, so a retry with the same key is processed again.",[553,1765,1766],{},"Rules for the key:",[833,1768,1769,1772,1775],{},[836,1770,1771],{},"1 to 255 printable ASCII characters, with no spaces.",[836,1773,1774],{},"Keys are scoped to the token and to the method and path, so two integrations cannot collide.",[836,1776,1777],{},"A client error (4xx) is a final answer and is replayed like a success. Fix the request and use a new key.",[553,1779,1780,1781,1783],{},"Keys are accepted on any write endpoint; the ",[843,1782,249],{"href":250}," marks the operations where they are documented.",[557,1785,1787],{"id":1786},"request-ids","Request ids",[553,1789,1790,1791,1794,1795,1798],{},"Every response carries an ",[565,1792,1793],{},"X-Request-Id"," header, and the same value is in ",[565,1796,1797],{},"meta.request_id",". Log it alongside your own request logs. When you contact support about a specific call, quoting the request id lets us find exactly what happened.",[557,1800,1802],{"id":1801},"browsers-and-cors","Browsers and CORS",[553,1804,1805,1806,1809,1810,1813,1814,1817],{},"The API is for server-to-server use. It sends no ",[565,1807,1808],{},"Access-Control-*"," headers, and a preflight ",[565,1811,1812],{},"OPTIONS"," request receives ",[565,1815,1816],{},"204"," without them, so a browser on another origin cannot read responses. Call the API from your back end, and never ship a token to a browser or a distributed app.",[1819,1820,1821],"style",{},"html pre.shiki code .sMK4o, html code.shiki .sMK4o{--shiki-light:#39ADB5;--shiki-default:#89DDFF;--shiki-dark:#89DDFF}html pre.shiki code .spNyl, html code.shiki .spNyl{--shiki-light:#9C3EDA;--shiki-default:#C792EA;--shiki-dark:#C792EA}html pre.shiki code .sBMFI, html code.shiki .sBMFI{--shiki-light:#E2931D;--shiki-default:#FFCB6B;--shiki-dark:#FFCB6B}html pre.shiki code .sfazB, html code.shiki .sfazB{--shiki-light:#91B859;--shiki-default:#C3E88D;--shiki-dark:#C3E88D}html .light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html.light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html .default .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html.dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html pre.shiki code .sbssI, html code.shiki .sbssI{--shiki-light:#F76D47;--shiki-default:#F78C6C;--shiki-dark:#F78C6C}html pre.shiki code .sTEyZ, html code.shiki .sTEyZ{--shiki-light:#90A4AE;--shiki-default:#EEFFFF;--shiki-dark:#BABED8}html pre.shiki code .s7zQu, html code.shiki .s7zQu{--shiki-light:#39ADB5;--shiki-light-font-style:italic;--shiki-default:#89DDFF;--shiki-default-font-style:italic;--shiki-dark:#89DDFF;--shiki-dark-font-style:italic}html pre.shiki code .s2Zo4, html code.shiki .s2Zo4{--shiki-light:#6182B8;--shiki-default:#82AAFF;--shiki-dark:#82AAFF}html pre.shiki code .sHwdD, html code.shiki .sHwdD{--shiki-light:#90A4AE;--shiki-light-font-style:italic;--shiki-default:#546E7A;--shiki-default-font-style:italic;--shiki-dark:#676E95;--shiki-dark-font-style:italic}",{"title":579,"searchDepth":586,"depth":593,"links":1823},[1824,1825,1826,1827,1830,1831,1832,1833,1834],{"id":559,"depth":593,"text":560},{"id":867,"depth":593,"text":868},{"id":903,"depth":593,"text":904},{"id":998,"depth":593,"text":999,"children":1828},[1829],{"id":1443,"depth":651,"text":1444},{"id":1498,"depth":593,"text":1499},{"id":1552,"depth":593,"text":1553},{"id":1604,"depth":593,"text":1605},{"id":1786,"depth":593,"text":1787},{"id":1801,"depth":593,"text":1802},"The response envelope, field naming, calendar dates and timestamps, cursor pagination, request bodies, idempotency keys and request ids.","md",null,{},{"icon":173},{"title":170,"description":1835},"s_T5oH4_pf9fIyrMPCE3fKrNSt3Dsq_ToVJko4mujko",[1843,1845],{"title":165,"path":166,"stem":167,"description":1844,"icon":168,"children":-1},"How scopes limit what a token can reach, how reusable API roles and the built-in templates work, and the full scope catalogue with the minimum owner role for each scope.",{"title":175,"path":176,"stem":177,"description":1846,"icon":178,"children":-1},"Every error code the API returns, its HTTP status, what it means and what to do about it.",1791906528976]