[{"data":1,"prerenderedAt":336},["ShallowReactive",2],{"navigation_docs":3,"-api-reference-groups-archive-group-operation":217,"-api-reference-groups-archive-group":312,"-api-reference-groups-archive-group-surround":329},[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",{"method":139,"path":218,"description":219,"scope":220,"parameters":221,"responses":231},"\u002Fv1\u002Fgroups\u002F{id}","Archives a group that is no longer used. It must have no active members, no active subgroups and no programs that target it. An archived group drops out of List groups, and the rewards it led to keep their history.","group:write",[222],{"name":223,"in":224,"required":225,"description":226,"schema":227},"id","path",true,"The group's ID.",{"type":228,"maxLength":229,"pattern":230},"string",100,"^grp_[A-Za-z0-9_-]+$",[232,246,261,271,281,291,301],{"status":233,"description":234,"schema":235,"example":244},"200","The group is archived.",{"type":236,"properties":237,"required":242,"additionalProperties":12},"object",{"id":238,"status":239},{"type":228,"maxLength":229,"pattern":230,"description":226},{"type":228,"const":240,"description":241},"archived","Always `archived`. Archiving an archived group changes nothing.",[223,243],"status",{"id":245,"status":240},"grp_R4mW8cTqZ2nLx6VbK9hJd3Fs",{"status":247,"description":248,"schema":249,"example":251},"400","`API_QUERY_INVALID`: A query parameter, or an ID in the path, is unknown or not in the right form.",{"$ref":250},"#\u002Fcomponents\u002Fschemas\u002FError",{"error":225,"status":252,"message":253,"data":254},400,"A query parameter, or an ID in the path, is unknown or not in the right form.",{"code":255,"why":253,"fix":256,"formErrors":257,"fieldErrors":258},"API_QUERY_INVALID","Correct the parameters listed under `fieldErrors` and send the request again.",[],{"limit":259},[260],"Too big: expected number to be \u003C=100",{"status":262,"description":263,"schema":264,"example":265},"401","`API_KEY_INVALID`: The key is missing, wrong, expired or revoked.",{"$ref":250},{"error":225,"status":266,"message":267,"data":268},401,"The key is missing, wrong, expired or revoked.",{"code":269,"why":267,"fix":270},"API_KEY_INVALID","Send a current key as a Bearer token. Owners and admins manage keys in Settings, under Developer.",{"status":272,"description":273,"schema":274,"example":275},"403","`API_KEY_SCOPE_MISSING`: The key is valid but wasn't given the scope this endpoint needs. `PLAN_UPGRADE_REQUIRED`: Your plan doesn't include the API. `COMPANY_CLOSED`: Your company has closed its Teambrite account.",{"$ref":250},{"error":225,"status":276,"message":277,"data":278},403,"The key is valid but wasn't given the scope this endpoint needs.",{"code":279,"why":277,"fix":280},"API_KEY_SCOPE_MISSING","Create a new key with this scope in Settings, under Developer. A key's scopes can't be changed afterwards.",{"status":282,"description":283,"schema":284,"example":285},"404","`GROUP_NOT_FOUND`: Your company has no active group with this ID.",{"$ref":250},{"error":225,"status":286,"message":287,"data":288},404,"Your company has no active group with this ID.",{"code":289,"why":287,"fix":290},"GROUP_NOT_FOUND","Find the right ID with List groups. When several were sent, `data.groupIds` lists the ones that weren't found.",{"status":292,"description":293,"schema":294,"example":295},"409","`GROUP_IN_USE`: The group still has active members, active subgroups, or programs that target it.",{"$ref":250},{"error":225,"status":296,"message":297,"data":298},409,"The group still has active members, active subgroups, or programs that target it.",{"code":299,"why":297,"fix":300},"GROUP_IN_USE","Take its members out with Remove employees from groups, archive or move its subgroups, and take it out of its programs in Teambrite. Then archive it.",{"status":302,"description":303,"schema":304,"example":305},"429","`API_KEY_RATE_LIMITED`: The key is over 600 requests a minute.",{"$ref":250},{"error":225,"status":306,"message":307,"data":308},429,"The key is over 600 requests a minute.",{"code":309,"why":307,"fix":310,"retryAfterSeconds":311},"API_KEY_RATE_LIMITED","Wait for the number of seconds in the `Retry-After` header, then send it again.",42,{"id":313,"title":135,"body":314,"description":321,"extension":322,"links":323,"meta":324,"navigation":325,"path":136,"seo":327,"stem":137,"__hash__":328},"docs\u002F2.api-reference\u002F07.groups\u002F4.archive-group.md",{"type":315,"value":316,"toc":317},"minimark",[],{"title":318,"searchDepth":319,"depth":319,"links":320},"",2,[],"Retire a group nobody uses any more.","md",null,{},{"badge":326},{"label":139,"color":140,"variant":89},{"title":135,"description":321},"Lvf5Db1JrpjCpCBHCa5OrZJzpIbuvTH_qk19IsgUYd8",[330,333],{"title":130,"path":131,"stem":132,"description":331,"badge":332,"children":-1},"Rename a group, change its type, or move it.",{"label":112,"color":113,"variant":89},{"title":142,"path":143,"stem":144,"description":334,"badge":335,"children":-1},"Put several people into several groups at once.",{"label":105,"color":106,"variant":89},1794422646790]