[{"data":1,"prerenderedAt":856},["ShallowReactive",2],{"navigation_docs":3,"-api-reference-errors":217,"-api-reference-errors-surround":851},[4,55],{"title":5,"icon":6,"path":7,"stem":8,"children":9,"page":12},"Guides","i-nucleo-book","\u002Fguides","1.guides",[10,21,41],{"title":11,"icon":12,"path":13,"stem":14,"children":15,"page":12},"Getting started",false,"\u002Fguides\u002Fgetting-started","1.guides\u002F1.getting-started",[16],{"title":17,"path":18,"stem":19,"icon":20},"Introduction","\u002Fguides\u002Fgetting-started\u002Fintroduction","1.guides\u002F1.getting-started\u002F1.introduction","i-nucleo-home",{"title":22,"icon":12,"path":23,"stem":24,"children":25,"page":12},"Connect an AI app","\u002Fguides\u002Fconnect-ai","1.guides\u002F2.connect-ai",[26,31,36],{"title":27,"path":28,"stem":29,"icon":30},"Connect Claude","\u002Fguides\u002Fconnect-ai\u002Fconnect-claude","1.guides\u002F2.connect-ai\u002F1.connect-claude","i-nucleo-plug",{"title":32,"path":33,"stem":34,"icon":35},"What it can see","\u002Fguides\u002Fconnect-ai\u002Fwhat-it-can-see","1.guides\u002F2.connect-ai\u002F2.what-it-can-see","i-nucleo-eye",{"title":37,"path":38,"stem":39,"icon":40},"Manage connections","\u002Fguides\u002Fconnect-ai\u002Fmanage-connections","1.guides\u002F2.connect-ai\u002F3.manage-connections","i-nucleo-sliders",{"title":42,"icon":12,"path":43,"stem":44,"children":45,"page":12},"Using the API","\u002Fguides\u002Fusing-the-api","1.guides\u002F3.using-the-api",[46,50],{"title":47,"path":48,"stem":49,"icon":35},"Read your data","\u002Fguides\u002Fusing-the-api\u002Fread-your-data","1.guides\u002F3.using-the-api\u002F1.read-your-data",{"title":51,"path":52,"stem":53,"icon":54},"Send metric values","\u002Fguides\u002Fusing-the-api\u002Fsend-metric-values","1.guides\u002F3.using-the-api\u002F2.send-metric-values","i-nucleo-chart-activity",{"title":56,"path":57,"stem":58,"children":59,"icon":216},"API Reference","\u002Fapi-reference","2.api-reference\u002F01.index",[60,62,67,72,77,90,114,151,161,186,201],{"title":11,"path":57,"stem":58,"icon":61},"i-nucleo-rocket",{"title":63,"path":64,"stem":65,"icon":66},"Authentication","\u002Fapi-reference\u002Fauthentication","2.api-reference\u002F02.authentication","i-nucleo-key",{"title":68,"path":69,"stem":70,"icon":71},"Errors and limits","\u002Fapi-reference\u002Ferrors","2.api-reference\u002F03.errors","i-nucleo-triangle-warning",{"title":73,"path":74,"stem":75,"icon":76},"Pagination","\u002Fapi-reference\u002Fpagination","2.api-reference\u002F04.pagination","i-nucleo-check-list",{"title":78,"icon":12,"path":79,"stem":80,"children":81,"page":12},"Programs","\u002Fapi-reference\u002Fprograms","2.api-reference\u002F05.programs",[82],{"title":83,"path":84,"stem":85,"badge":86},"List programs","\u002Fapi-reference\u002Fprograms\u002Flist-programs","2.api-reference\u002F05.programs\u002F1.list-programs",{"label":87,"color":88,"variant":89},"GET","success","subtle",{"title":91,"icon":12,"path":92,"stem":93,"children":94,"page":12},"Employees","\u002Fapi-reference\u002Femployees","2.api-reference\u002F06.employees",[95,100,107],{"title":96,"path":97,"stem":98,"badge":99},"List employees","\u002Fapi-reference\u002Femployees\u002Flist-employees","2.api-reference\u002F06.employees\u002F1.list-employees",{"label":87,"color":88,"variant":89},{"title":101,"path":102,"stem":103,"badge":104},"Create an employee","\u002Fapi-reference\u002Femployees\u002Fcreate-employee","2.api-reference\u002F06.employees\u002F2.create-employee",{"label":105,"color":106,"variant":89},"POST","info",{"title":108,"path":109,"stem":110,"badge":111},"Update an employee","\u002Fapi-reference\u002Femployees\u002Fupdate-employee","2.api-reference\u002F06.employees\u002F3.update-employee",{"label":112,"color":113,"variant":89},"PATCH","warning",{"title":115,"icon":12,"path":116,"stem":117,"children":118,"page":12},"Groups","\u002Fapi-reference\u002Fgroups","2.api-reference\u002F07.groups",[119,124,129,134,141,146],{"title":120,"path":121,"stem":122,"badge":123},"List groups","\u002Fapi-reference\u002Fgroups\u002Flist-groups","2.api-reference\u002F07.groups\u002F1.list-groups",{"label":87,"color":88,"variant":89},{"title":125,"path":126,"stem":127,"badge":128},"Create a group","\u002Fapi-reference\u002Fgroups\u002Fcreate-group","2.api-reference\u002F07.groups\u002F2.create-group",{"label":105,"color":106,"variant":89},{"title":130,"path":131,"stem":132,"badge":133},"Update a group","\u002Fapi-reference\u002Fgroups\u002Fupdate-group","2.api-reference\u002F07.groups\u002F3.update-group",{"label":112,"color":113,"variant":89},{"title":135,"path":136,"stem":137,"badge":138},"Archive a group","\u002Fapi-reference\u002Fgroups\u002Farchive-group","2.api-reference\u002F07.groups\u002F4.archive-group",{"label":139,"color":140,"variant":89},"DELETE","error",{"title":142,"path":143,"stem":144,"badge":145},"Add employees to groups","\u002Fapi-reference\u002Fgroups\u002Fadd-employees-to-groups","2.api-reference\u002F07.groups\u002F5.add-employees-to-groups",{"label":105,"color":106,"variant":89},{"title":147,"path":148,"stem":149,"badge":150},"Remove employees from groups","\u002Fapi-reference\u002Fgroups\u002Fremove-employees-from-groups","2.api-reference\u002F07.groups\u002F6.remove-employees-from-groups",{"label":105,"color":106,"variant":89},{"title":152,"icon":12,"path":153,"stem":154,"children":155,"page":12},"Rewards","\u002Fapi-reference\u002Frewards","2.api-reference\u002F08.rewards",[156],{"title":157,"path":158,"stem":159,"badge":160},"List upcoming rewards","\u002Fapi-reference\u002Frewards\u002Flist-upcoming-rewards","2.api-reference\u002F08.rewards\u002F1.list-upcoming-rewards",{"label":87,"color":88,"variant":89},{"title":162,"icon":12,"path":163,"stem":164,"children":165,"page":12},"Insights","\u002Fapi-reference\u002Finsights","2.api-reference\u002F09.insights",[166,171,176,181],{"title":167,"path":168,"stem":169,"badge":170},"Get coverage gaps","\u002Fapi-reference\u002Finsights\u002Fget-coverage-gaps","2.api-reference\u002F09.insights\u002F1.get-coverage-gaps",{"label":87,"color":88,"variant":89},{"title":172,"path":173,"stem":174,"badge":175},"List coverage gap employees","\u002Fapi-reference\u002Finsights\u002Flist-coverage-gap-employees","2.api-reference\u002F09.insights\u002F2.list-coverage-gap-employees",{"label":87,"color":88,"variant":89},{"title":177,"path":178,"stem":179,"badge":180},"Get quiet employees","\u002Fapi-reference\u002Finsights\u002Fget-quiet-employees","2.api-reference\u002F09.insights\u002F3.get-quiet-employees",{"label":87,"color":88,"variant":89},{"title":182,"path":183,"stem":184,"badge":185},"Get program review","\u002Fapi-reference\u002Finsights\u002Fget-program-review","2.api-reference\u002F09.insights\u002F4.get-program-review",{"label":87,"color":88,"variant":89},{"title":187,"icon":12,"path":188,"stem":189,"children":190,"page":12},"Metrics","\u002Fapi-reference\u002Fmetrics","2.api-reference\u002F10.metrics",[191,196],{"title":192,"path":193,"stem":194,"badge":195},"Send a metric value","\u002Fapi-reference\u002Fmetrics\u002Fsend-metric-value","2.api-reference\u002F10.metrics\u002F1.send-metric-value",{"label":105,"color":106,"variant":89},{"title":197,"path":198,"stem":199,"badge":200},"Get a metric value","\u002Fapi-reference\u002Fmetrics\u002Fget-metric-value","2.api-reference\u002F10.metrics\u002F2.get-metric-value",{"label":87,"color":88,"variant":89},{"title":202,"icon":12,"path":203,"stem":204,"children":205,"page":12},"System","\u002Fapi-reference\u002Fsystem","2.api-reference\u002F11.system",[206,211],{"title":207,"path":208,"stem":209,"badge":210},"Check API health","\u002Fapi-reference\u002Fsystem\u002Fhealth","2.api-reference\u002F11.system\u002F1.health",{"label":87,"color":88,"variant":89},{"title":212,"path":213,"stem":214,"badge":215},"Get the OpenAPI document","\u002Fapi-reference\u002Fsystem\u002Fopenapi","2.api-reference\u002F11.system\u002F2.openapi",{"label":87,"color":88,"variant":89},"i-nucleo-code",{"id":218,"title":68,"body":219,"description":844,"extension":845,"links":846,"meta":847,"navigation":848,"path":69,"seo":849,"stem":70,"__hash__":850},"docs\u002F2.api-reference\u002F03.errors.md",{"type":220,"value":221,"toc":839},"minimark",[222,227,244,410,437,441,795,799,835],[223,224,226],"h2",{"id":225},"read-an-error","Read an error",[228,229,230,231,235,236,239,240,243],"p",{},"Errors are JSON. Branch your code on ",[232,233,234],"code",{},"data.code",", which won't change. ",[232,237,238],{},"why"," and ",[232,241,242],{},"fix"," are written for the developer reading them.",[245,246,251],"pre",{"className":247,"code":248,"language":249,"meta":250,"style":250},"language-json shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","{\n  \"error\": true,\n  \"status\": 403,\n  \"message\": \"This API key needs the employee:read scope\",\n  \"data\": {\n    \"code\": \"API_KEY_SCOPE_MISSING\",\n    \"why\": \"The key is valid, but it wasn't given employee:read when it was created.\",\n    \"fix\": \"Create a new key with this scope in Settings, under Developer.\"\n  }\n}\n","json","",[232,252,253,262,280,299,322,337,359,379,398,404],{"__ignoreMap":250},[254,255,258],"span",{"class":256,"line":257},"line",1,[254,259,261],{"class":260},"sMK4o","{\n",[254,263,265,268,271,274,277],{"class":256,"line":264},2,[254,266,267],{"class":260},"  \"",[254,269,140],{"class":270},"spNyl",[254,272,273],{"class":260},"\"",[254,275,276],{"class":260},":",[254,278,279],{"class":260}," true,\n",[254,281,283,285,288,290,292,296],{"class":256,"line":282},3,[254,284,267],{"class":260},[254,286,287],{"class":270},"status",[254,289,273],{"class":260},[254,291,276],{"class":260},[254,293,295],{"class":294},"sbssI"," 403",[254,297,298],{"class":260},",\n",[254,300,302,304,307,309,311,314,318,320],{"class":256,"line":301},4,[254,303,267],{"class":260},[254,305,306],{"class":270},"message",[254,308,273],{"class":260},[254,310,276],{"class":260},[254,312,313],{"class":260}," \"",[254,315,317],{"class":316},"sfazB","This API key needs the employee:read scope",[254,319,273],{"class":260},[254,321,298],{"class":260},[254,323,325,327,330,332,334],{"class":256,"line":324},5,[254,326,267],{"class":260},[254,328,329],{"class":270},"data",[254,331,273],{"class":260},[254,333,276],{"class":260},[254,335,336],{"class":260}," {\n",[254,338,340,343,346,348,350,352,355,357],{"class":256,"line":339},6,[254,341,342],{"class":260},"    \"",[254,344,232],{"class":345},"sBMFI",[254,347,273],{"class":260},[254,349,276],{"class":260},[254,351,313],{"class":260},[254,353,354],{"class":316},"API_KEY_SCOPE_MISSING",[254,356,273],{"class":260},[254,358,298],{"class":260},[254,360,362,364,366,368,370,372,375,377],{"class":256,"line":361},7,[254,363,342],{"class":260},[254,365,238],{"class":345},[254,367,273],{"class":260},[254,369,276],{"class":260},[254,371,313],{"class":260},[254,373,374],{"class":316},"The key is valid, but it wasn't given employee:read when it was created.",[254,376,273],{"class":260},[254,378,298],{"class":260},[254,380,382,384,386,388,390,392,395],{"class":256,"line":381},8,[254,383,342],{"class":260},[254,385,242],{"class":345},[254,387,273],{"class":260},[254,389,276],{"class":260},[254,391,313],{"class":260},[254,393,394],{"class":316},"Create a new key with this scope in Settings, under Developer.",[254,396,397],{"class":260},"\"\n",[254,399,401],{"class":256,"line":400},9,[254,402,403],{"class":260},"  }\n",[254,405,407],{"class":256,"line":406},10,[254,408,409],{"class":260},"}\n",[228,411,412,413,416,417,420,421,424,425,428,429,432,433,436],{},"A ",[232,414,415],{},"400"," also lists the problems under ",[232,418,419],{},"data.fieldErrors",", by field, and problems with the request as a whole under ",[232,422,423],{},"data.formErrors",". A ",[232,426,427],{},"429"," says how long to wait in a ",[232,430,431],{},"Retry-After"," header and in ",[232,434,435],{},"data.retryAfterSeconds",".",[223,438,440],{"id":439},"error-codes","Error codes",[442,443,444,461],"table",{},[445,446,447],"thead",{},[448,449,450,454,458],"tr",{},[451,452,453],"th",{},"Status",[451,455,456],{},[232,457,234],{},[451,459,460],{},"When it happens",[462,463,464,477,489,501,514,526,538,550,562,579,594,606,619,635,653,669,681,693,706,719,734,746,758,770,782],"tbody",{},[448,465,466,469,474],{},[467,468,415],"td",{},[467,470,471],{},[232,472,473],{},"API_QUERY_INVALID",[467,475,476],{},"A query parameter, or an ID in the path, is unknown or not in the right form",[448,478,479,481,486],{},[467,480,415],{},[467,482,483],{},[232,484,485],{},"REQUEST_BODY_INVALID",[467,487,488],{},"The body has a field that is unknown, missing or out of range",[448,490,491,493,498],{},[467,492,415],{},[467,494,495],{},[232,496,497],{},"METRIC_OBSERVATION_INVALID",[467,499,500],{},"The body of Send a metric value doesn't match the required fields",[448,502,503,506,511],{},[467,504,505],{},"401",[467,507,508],{},[232,509,510],{},"API_KEY_INVALID",[467,512,513],{},"The key is missing, wrong, expired or revoked",[448,515,516,519,523],{},[467,517,518],{},"403",[467,520,521],{},[232,522,354],{},[467,524,525],{},"The key wasn't given the scope this endpoint needs",[448,527,528,530,535],{},[467,529,518],{},[467,531,532],{},[232,533,534],{},"PLAN_UPGRADE_REQUIRED",[467,536,537],{},"Your plan doesn't include the API",[448,539,540,542,547],{},[467,541,518],{},[467,543,544],{},[232,545,546],{},"PLAN_HEADCOUNT_LIMIT",[467,548,549],{},"Adding this person would take you past the employees your plan covers",[448,551,552,554,559],{},[467,553,518],{},[467,555,556],{},[232,557,558],{},"COMPANY_CLOSED",[467,560,561],{},"Your company has closed its Teambrite account",[448,563,564,567,572],{},[467,565,566],{},"404",[467,568,569],{},[232,570,571],{},"EMPLOYEE_NOT_FOUND",[467,573,574,575,578],{},"No employee in your company has this ID. ",[232,576,577],{},"data.employeeIds"," lists them when you sent several",[448,580,581,583,588],{},[467,582,566],{},[467,584,585],{},[232,586,587],{},"GROUP_NOT_FOUND",[467,589,590,591,578],{},"Your company has no active group with this ID. ",[232,592,593],{},"data.groupIds",[448,595,596,598,603],{},[467,597,566],{},[467,599,600],{},[232,601,602],{},"METRIC_OBSERVATION_NOT_FOUND",[467,604,605],{},"Your company has no metric value with this ID",[448,607,608,611,616],{},[467,609,610],{},"409",[467,612,613],{},[232,614,615],{},"METRIC_IDEMPOTENCY_CONFLICT",[467,617,618],{},"The idempotency key was already used with a different employee, metric or value",[448,620,621,623,628],{},[467,622,610],{},[467,624,625],{},[232,626,627],{},"EMPLOYEE_EMAIL_TAKEN",[467,629,630,631,634],{},"Another employee has this email. ",[232,632,633],{},"data.employeeId"," says who",[448,636,637,639,644],{},[467,638,610],{},[467,640,641],{},[232,642,643],{},"EMPLOYEE_EXTERNAL_ID_TAKEN",[467,645,646,647,650,651,634],{},"Another employee has this ",[232,648,649],{},"externalId",". ",[232,652,633],{},[448,654,655,657,662],{},[467,656,610],{},[467,658,659],{},[232,660,661],{},"GROUP_NAME_TAKEN",[467,663,664,665,668],{},"An active group with the same parent has this name. ",[232,666,667],{},"data.groupId"," says which",[448,670,671,673,678],{},[467,672,610],{},[467,674,675],{},[232,676,677],{},"GROUP_PARENT_INVALID",[467,679,680],{},"The parent would put a group inside itself, or nest groups too deeply",[448,682,683,685,690],{},[467,684,610],{},[467,686,687],{},[232,688,689],{},"GROUP_IN_USE",[467,691,692],{},"The group still has active members, active subgroups or programs",[448,694,695,698,703],{},[467,696,697],{},"411",[467,699,700],{},[232,701,702],{},"REQUEST_LENGTH_REQUIRED",[467,704,705],{},"The request didn't declare its length",[448,707,708,711,716],{},[467,709,710],{},"413",[467,712,713],{},[232,714,715],{},"REQUEST_TOO_LARGE",[467,717,718],{},"The body is over 1 MB",[448,720,721,724,729],{},[467,722,723],{},"422",[467,725,726],{},[232,727,728],{},"EMPLOYEE_INACTIVE",[467,730,731,732,578],{},"The employee is no longer active. ",[232,733,577],{},[448,735,736,738,743],{},[467,737,723],{},[467,739,740],{},[232,741,742],{},"METRIC_NOT_FOUND",[467,744,745],{},"Your company has no metric with this key",[448,747,748,750,755],{},[467,749,723],{},[467,751,752],{},[232,753,754],{},"METRIC_ARCHIVED",[467,756,757],{},"This metric has been archived",[448,759,760,762,767],{},[467,761,427],{},[467,763,764],{},[232,765,766],{},"API_KEY_RATE_LIMITED",[467,768,769],{},"The key is over 600 requests a minute",[448,771,772,774,779],{},[467,773,427],{},[467,775,776],{},[232,777,778],{},"COMPANY_RATE_LIMITED",[467,780,781],{},"Your company is over 120 read requests a minute",[448,783,784,787,792],{},[467,785,786],{},"500",[467,788,789],{},[232,790,791],{},"METRIC_OBSERVATION_FAILED",[467,793,794],{},"A problem on our side. Resend with the same idempotency key",[223,796,798],{"id":797},"limits","Limits",[800,801,802,816,826],"ul",{},[803,804,805,809,810,812,813,815],"li",{},[806,807,808],"strong",{},"Requests:"," 600 a minute for each key. Over that, you get a ",[232,811,427],{},". Wait for the number of seconds in ",[232,814,431],{},", then send it again.",[803,817,818,821,822,825],{},[806,819,820],{},"Read requests:"," 120 a minute for your whole company, because some of them forecast up to a year of rewards. AI apps connected to your company share this limit. ",[823,824,197],"a",{"href":198}," doesn't count toward it.",[803,827,828,831,832,436],{},[806,829,830],{},"Body size:"," 1 MB, with a declared ",[232,833,834],{},"Content-Length",[836,837,838],"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 .sbssI, html code.shiki .sbssI{--shiki-light:#F76D47;--shiki-default:#F78C6C;--shiki-dark:#F78C6C}html pre.shiki code .sfazB, html code.shiki .sfazB{--shiki-light:#91B859;--shiki-default:#C3E88D;--shiki-dark:#C3E88D}html pre.shiki code .sBMFI, html code.shiki .sBMFI{--shiki-light:#E2931D;--shiki-default:#FFCB6B;--shiki-dark:#FFCB6B}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":250,"searchDepth":264,"depth":264,"links":840},[841,842,843],{"id":225,"depth":264,"text":226},{"id":439,"depth":264,"text":440},{"id":797,"depth":264,"text":798},"How errors are shaped, what each code means, and the limits on requests.","md",null,{},{"icon":71},{"title":68,"description":844},"a3pz0tqEpxx7EpsdosvAlf31k7rodTVYIeVKZlmlSA4",[852,854],{"title":63,"path":64,"stem":65,"description":853,"icon":66,"children":-1},"Create an API key, choose what it can do, and send it with your requests.",{"title":73,"path":74,"stem":75,"description":855,"icon":76,"children":-1},"How to page through lists and the detail in reports.",1794422646789]