[{"data":1,"prerenderedAt":1152},["ShallowReactive",2],{"navigation":3,"\u002Fapi\u002Ferrors":547,"\u002Fapi\u002Ferrors-surround":1147},[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":175,"body":549,"description":1140,"extension":1141,"links":1142,"meta":1143,"navigation":1144,"path":176,"seo":1145,"stem":177,"__hash__":1146},"docs\u002F14.api\u002F6.errors.md",{"type":550,"value":551,"toc":1136},"minimark",[552,578,704,711,716,1012,1015,1019,1104,1114,1132],[553,554,555,556,561,562,566,567,569,570,573,574,577],"p",{},"Errors use the standard ",[557,558,560],"a",{"href":559},"\u002Fapi\u002Frequests-and-responses#the-envelope","envelope",": an ",[563,564,565],"code",{},"error"," object with a stable ",[563,568,563],{}," and a readable ",[563,571,572],{},"message",", and ",[563,575,576],{},"meta.request_id",".",[579,580,585],"pre",{"className":581,"code":582,"language":583,"meta":584,"style":584},"language-json shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","{\n  \"error\": {\n    \"code\": \"SCOPE_MISSING\",\n    \"message\": \"This token is missing the organization:read scope.\"\n  },\n  \"meta\": { \"request_id\": \"3a91d0c2-7b4e-4f8a-9c1d-5e2f6a7b8c90\" }\n}\n","json","",[563,586,587,596,614,639,658,664,698],{"__ignoreMap":584},[588,589,592],"span",{"class":590,"line":591},"line",1,[588,593,595],{"class":594},"sMK4o","{\n",[588,597,599,602,605,608,611],{"class":590,"line":598},2,[588,600,601],{"class":594},"  \"",[588,603,565],{"class":604},"spNyl",[588,606,607],{"class":594},"\"",[588,609,610],{"class":594},":",[588,612,613],{"class":594}," {\n",[588,615,617,620,623,625,627,630,634,636],{"class":590,"line":616},3,[588,618,619],{"class":594},"    \"",[588,621,563],{"class":622},"sBMFI",[588,624,607],{"class":594},[588,626,610],{"class":594},[588,628,629],{"class":594}," \"",[588,631,633],{"class":632},"sfazB","SCOPE_MISSING",[588,635,607],{"class":594},[588,637,638],{"class":594},",\n",[588,640,642,644,646,648,650,652,655],{"class":590,"line":641},4,[588,643,619],{"class":594},[588,645,572],{"class":622},[588,647,607],{"class":594},[588,649,610],{"class":594},[588,651,629],{"class":594},[588,653,654],{"class":632},"This token is missing the organization:read scope.",[588,656,657],{"class":594},"\"\n",[588,659,661],{"class":590,"line":660},5,[588,662,663],{"class":594},"  },\n",[588,665,667,669,672,674,676,679,681,684,686,688,690,693,695],{"class":590,"line":666},6,[588,668,601],{"class":594},[588,670,671],{"class":604},"meta",[588,673,607],{"class":594},[588,675,610],{"class":594},[588,677,678],{"class":594}," {",[588,680,629],{"class":594},[588,682,683],{"class":622},"request_id",[588,685,607],{"class":594},[588,687,610],{"class":594},[588,689,629],{"class":594},[588,691,692],{"class":632},"3a91d0c2-7b4e-4f8a-9c1d-5e2f6a7b8c90",[588,694,607],{"class":594},[588,696,697],{"class":594}," }\n",[588,699,701],{"class":590,"line":700},7,[588,702,703],{"class":594},"}\n",[553,705,706,707,710],{},"Branch on ",[563,708,709],{},"error.code"," and the HTTP status. The message is written for people and may change.",[712,713,715],"h2",{"id":714},"error-codes","Error codes",[717,718,719,738],"table",{},[720,721,722],"thead",{},[723,724,725,729,732,735],"tr",{},[726,727,728],"th",{},"Code",[726,730,731],{},"HTTP status",[726,733,734],{},"Meaning",[726,736,737],{},"What to do",[739,740,741,767,786,801,816,830,845,860,876,899,915,934,958,980,996],"tbody",{},[723,742,743,749,752,755],{},[744,745,746],"td",{},[563,747,748],{},"AUTH_INVALID",[744,750,751],{},"401",[744,753,754],{},"The token is missing, malformed, unknown, revoked or expired, or its owner can no longer hold it (for example the owner was deactivated).",[744,756,757,758,761,762,766],{},"Check the ",[563,759,760],{},"Authorization"," header and the token's status and owner in ",[763,764,765],"strong",{},"Settings > API",". Do not retry with the same token.",[723,768,769,774,777,780],{},[744,770,771],{},[563,772,773],{},"API_DISABLED",[744,775,776],{},"403",[744,778,779],{},"The API is switched off for this organization.",[744,781,782,783,577],{},"Ask an Executive to turn it on under ",[763,784,785],{},"Settings > API > Settings",[723,787,788,793,795,798],{},[744,789,790],{},[563,791,792],{},"PLAN_REQUIRED",[744,794,776],{},[744,796,797],{},"The plan does not include API access, or the subscription is past due, suspended, cancelled or unpaid.",[744,799,800],{},"Resolve billing. API access is included in Pro, Business and Enterprise.",[723,802,803,808,810,813],{},[744,804,805],{},[563,806,807],{},"IP_NOT_ALLOWED",[744,809,776],{},[744,811,812],{},"The request came from an address outside the token's IP allowlist.",[744,814,815],{},"Call from an allowed address, or update the allowlist.",[723,817,818,822,824,827],{},[744,819,820],{},[563,821,633],{},[744,823,776],{},[744,825,826],{},"The token does not hold the scope this endpoint requires. The message names that scope. Also returned when a webhook subscription would deliver events whose read scope the token does not hold.",[744,828,829],{},"Add the scope to the token or its API role, if the owner's role allows it.",[723,831,832,837,839,842],{},[744,833,834],{},[563,835,836],{},"FORBIDDEN",[744,838,776],{},[744,840,841],{},"The token's owner is not allowed to do this in the app, even though the token holds the scope, for example approving their own request. Also returned when the client address cannot be determined.",[744,843,844],{},"Use a token whose owner has the authority in the app.",[723,846,847,852,854,857],{},[744,848,849],{},[563,850,851],{},"MODULE_DISABLED",[744,853,776],{},[744,855,856],{},"The module this endpoint belongs to (for example time tracking or expenses) is switched off for the organization.",[744,858,859],{},"An administrator can switch the module on in the app.",[723,861,862,867,870,873],{},[744,863,864],{},[563,865,866],{},"NOT_FOUND",[744,868,869],{},"404",[744,871,872],{},"The resource does not exist, belongs to another organization, or the path is not an API endpoint.",[744,874,875],{},"Check the id and the path.",[723,877,878,883,886,893],{},[744,879,880],{},[563,881,882],{},"METHOD_NOT_ALLOWED",[744,884,885],{},"405",[744,887,888,889,892],{},"The path exists but does not accept this HTTP method. The ",[563,890,891],{},"Allow"," header lists the methods it does accept.",[744,894,895,896,898],{},"Use a method from the ",[563,897,891],{}," header.",[723,900,901,906,909,912],{},[744,902,903],{},[563,904,905],{},"CONFLICT",[744,907,908],{},"409",[744,910,911],{},"The request conflicts with the resource's current state (for example an expense report that is no longer awaiting a decision, or a name that is already taken), or a request with the same idempotency key is still in progress.",[744,913,914],{},"Re-read the resource, or wait and retry.",[723,916,917,922,924,931],{},[744,918,919],{},[563,920,921],{},"IDEMPOTENCY_CONFLICT",[744,923,908],{},[744,925,926,927,930],{},"The ",[563,928,929],{},"Idempotency-Key"," was already used with a different request.",[744,932,933],{},"Use a new key for a different request.",[723,935,936,941,944,955],{},[744,937,938],{},[563,939,940],{},"VALIDATION_FAILED",[744,942,943],{},"422",[744,945,946,947,950,951,954],{},"The body, a parameter, the cursor or a header is invalid. Malformed JSON and a body that is not ",[563,948,949],{},"application\u002Fjson"," return this code. Also returned when the app's own rules refuse a write, for example insufficient balance or a locked date; the message then says why. ",[563,952,953],{},"details"," may name the field.",[744,956,957],{},"Fix the request. Retrying unchanged will fail again.",[723,959,960,965,968,971],{},[744,961,962],{},[563,963,964],{},"RATE_LIMITED",[744,966,967],{},"429",[744,969,970],{},"A rate limit was exceeded, or the address is temporarily blocked after repeated failed authentication.",[744,972,973,974,977,978,577],{},"Wait for the number of seconds in ",[563,975,976],{},"Retry-After",", then retry. See ",[557,979,180],{"href":181},[723,981,982,987,990,993],{},[744,983,984],{},[563,985,986],{},"INTERNAL",[744,988,989],{},"500",[744,991,992],{},"Something went wrong on our side.",[744,994,995],{},"Retry with backoff. If it persists, contact support with the request id.",[723,997,998,1003,1006,1009],{},[744,999,1000],{},[563,1001,1002],{},"UNAVAILABLE",[744,1004,1005],{},"503",[744,1007,1008],{},"The API is temporarily unavailable.",[744,1010,1011],{},"Retry with backoff.",[553,1013,1014],{},"Error bodies never include stack traces or internal details, and never list the token's scopes.",[712,1016,1018],{"id":1017},"which-errors-to-retry","Which errors to retry",[717,1020,1021,1031],{},[720,1022,1023],{},[723,1024,1025,1028],{},[726,1026,1027],{},"Retry?",[726,1029,1030],{},"Codes",[739,1032,1033,1046,1061,1073],{},[723,1034,1035,1042],{},[744,1036,1037],{},[763,1038,1039,1040],{},"Yes, after ",[563,1041,976],{},[744,1043,1044],{},[563,1045,964],{},[723,1047,1048,1053],{},[744,1049,1050],{},[763,1051,1052],{},"Yes, with exponential backoff",[744,1054,1055,1057,1058,1060],{},[563,1056,986],{},", ",[563,1059,1002],{},", and network errors or timeouts",[723,1062,1063,1068],{},[744,1064,1065],{},[763,1066,1067],{},"After waiting briefly",[744,1069,1070,1072],{},[563,1071,905],{}," caused by an in-progress idempotent request",[723,1074,1075,1080],{},[744,1076,1077],{},[763,1078,1079],{},"No, fix the cause first",[744,1081,1082,1057,1084,1057,1086,1057,1088,1057,1090,1057,1092,1057,1094,1057,1096,1057,1098,1057,1100,1057,1102],{},[563,1083,748],{},[563,1085,773],{},[563,1087,792],{},[563,1089,807],{},[563,1091,633],{},[563,1093,836],{},[563,1095,851],{},[563,1097,866],{},[563,1099,882],{},[563,1101,921],{},[563,1103,940],{},[553,1105,1106,1107,1109,1110,577],{},"When you retry a write, send the same ",[563,1108,929],{}," so it cannot be applied twice. See ",[557,1111,1113],{"href":1112},"\u002Fapi\u002Frequests-and-responses#idempotency-keys","Idempotency keys",[1115,1116,1119],"callout",{"color":1117,"icon":1118},"blue","i-lucide-info",[553,1120,1121,1122,1125,1126,1128,1129,1131],{},"The network edge in front of the API can answer before your request reaches it: ",[563,1123,1124],{},"413"," for a request body over 1 MB, and ",[563,1127,967],{}," when an address sends too many requests. These responses may not use the JSON envelope. Treat any ",[563,1130,967],{}," the same way: wait, then retry.",[1133,1134,1135],"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);}",{"title":584,"searchDepth":591,"depth":598,"links":1137},[1138,1139],{"id":714,"depth":598,"text":715},{"id":1017,"depth":598,"text":1018},"Every error code the API returns, its HTTP status, what it means and what to do about it.","md",null,{},{"icon":178},{"title":175,"description":1140},"953NFbar3M0Y0XeUgt9-FeW5B_2891jP0K6NSNLmzcM",[1148,1150],{"title":170,"path":171,"stem":172,"description":1149,"icon":173,"children":-1},"The response envelope, field naming, calendar dates and timestamps, cursor pagination, request bodies, idempotency keys and request ids.",{"title":180,"path":181,"stem":182,"description":1151,"icon":76,"children":-1},"The request limits per token, per organization and per address, the RateLimit and Retry-After headers, the failed-authentication lockout, and how to back off.",1791906529990]