[{"data":1,"prerenderedAt":725},["ShallowReactive",2],{"navigation_docs":3,"-guides-using-the-api-read-your-data":217,"-guides-using-the-api-read-your-data-surround":720},[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":47,"body":219,"description":713,"extension":714,"links":715,"meta":716,"navigation":717,"path":48,"seo":718,"stem":49,"__hash__":719},"docs\u002F1.guides\u002F3.using-the-api\u002F1.read-your-data.md",{"type":220,"value":221,"toc":706},"minimark",[222,231,236,243,247,271,597,601,624,628,638,642,645,699,702],[223,224,225,226,230],"p",{},"The API can answer the same questions a ",[227,228,229],"a",{"href":33},"connected AI app"," can, in a form your own code can use. Everything here is read-only.",[232,233,235],"h2",{"id":234},"choose-what-the-key-can-read","Choose what the key can read",[223,237,238,239,242],{},"When you ",[227,240,241],{"href":64},"create a key",", give it only what it needs. A key that builds a report on programs has no reason to see employee names.",[232,244,246],{"id":245},"walk-through-a-long-list","Walk through a long list",[223,248,249,250,253,254,257,258,261,262,266,267,270],{},"Lists of ",[227,251,252],{"href":84},"programs",", ",[227,255,256],{"href":97},"employees"," and ",[227,259,260],{"href":121},"groups"," come back a page at a time. Keep asking until ",[263,264,265],"code",{},"nextCursor"," is ",[263,268,269],{},"null",":",[272,273,278],"pre",{"className":274,"code":275,"language":276,"meta":277,"style":277},"language-js shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","const employees = []\nlet cursor\n\ndo {\n  const url = new URL('https:\u002F\u002Fapi.teambrite.com\u002Fv1\u002Femployees')\n  url.searchParams.set('limit', '100')\n  if (cursor) url.searchParams.set('cursor', cursor)\n\n  const response = await fetch(url, {\n    headers: { Authorization: `Bearer ${process.env.TEAMBRITE_API_KEY}` },\n  })\n  const page = await response.json()\n  employees.push(...page.data)\n  cursor = page.nextCursor\n} while (cursor)\n","js","",[263,279,280,300,309,316,326,361,400,441,446,470,514,522,544,570,585],{"__ignoreMap":277},[281,282,285,289,293,297],"span",{"class":283,"line":284},"line",1,[281,286,288],{"class":287},"spNyl","const",[281,290,292],{"class":291},"sTEyZ"," employees ",[281,294,296],{"class":295},"sMK4o","=",[281,298,299],{"class":291}," []\n",[281,301,303,306],{"class":283,"line":302},2,[281,304,305],{"class":287},"let",[281,307,308],{"class":291}," cursor\n",[281,310,312],{"class":283,"line":311},3,[281,313,315],{"emptyLinePlaceholder":314},true,"\n",[281,317,319,323],{"class":283,"line":318},4,[281,320,322],{"class":321},"s7zQu","do",[281,324,325],{"class":295}," {\n",[281,327,329,332,335,338,341,345,349,352,356,358],{"class":283,"line":328},5,[281,330,331],{"class":287},"  const",[281,333,334],{"class":291}," url",[281,336,337],{"class":295}," =",[281,339,340],{"class":295}," new",[281,342,344],{"class":343},"s2Zo4"," URL",[281,346,348],{"class":347},"swJcz","(",[281,350,351],{"class":295},"'",[281,353,355],{"class":354},"sfazB","https:\u002F\u002Fapi.teambrite.com\u002Fv1\u002Femployees",[281,357,351],{"class":295},[281,359,360],{"class":347},")\n",[281,362,364,367,370,373,375,378,380,382,385,387,390,393,396,398],{"class":283,"line":363},6,[281,365,366],{"class":291},"  url",[281,368,369],{"class":295},".",[281,371,372],{"class":291},"searchParams",[281,374,369],{"class":295},[281,376,377],{"class":343},"set",[281,379,348],{"class":347},[281,381,351],{"class":295},[281,383,384],{"class":354},"limit",[281,386,351],{"class":295},[281,388,389],{"class":295},",",[281,391,392],{"class":295}," '",[281,394,395],{"class":354},"100",[281,397,351],{"class":295},[281,399,360],{"class":347},[281,401,403,406,409,412,415,418,420,422,424,426,428,430,432,434,436,439],{"class":283,"line":402},7,[281,404,405],{"class":321},"  if",[281,407,408],{"class":347}," (",[281,410,411],{"class":291},"cursor",[281,413,414],{"class":347},") ",[281,416,417],{"class":291},"url",[281,419,369],{"class":295},[281,421,372],{"class":291},[281,423,369],{"class":295},[281,425,377],{"class":343},[281,427,348],{"class":347},[281,429,351],{"class":295},[281,431,411],{"class":354},[281,433,351],{"class":295},[281,435,389],{"class":295},[281,437,438],{"class":291}," cursor",[281,440,360],{"class":347},[281,442,444],{"class":283,"line":443},8,[281,445,315],{"emptyLinePlaceholder":314},[281,447,449,451,454,456,459,462,464,466,468],{"class":283,"line":448},9,[281,450,331],{"class":287},[281,452,453],{"class":291}," response",[281,455,337],{"class":295},[281,457,458],{"class":321}," await",[281,460,461],{"class":343}," fetch",[281,463,348],{"class":347},[281,465,417],{"class":291},[281,467,389],{"class":295},[281,469,325],{"class":295},[281,471,473,476,478,481,484,486,489,492,495,498,500,503,505,508,511],{"class":283,"line":472},10,[281,474,475],{"class":347},"    headers",[281,477,270],{"class":295},[281,479,480],{"class":295}," {",[281,482,483],{"class":347}," Authorization",[281,485,270],{"class":295},[281,487,488],{"class":295}," `",[281,490,491],{"class":354},"Bearer ",[281,493,494],{"class":295},"${",[281,496,497],{"class":291},"process",[281,499,369],{"class":295},[281,501,502],{"class":291},"env",[281,504,369],{"class":295},[281,506,507],{"class":291},"TEAMBRITE_API_KEY",[281,509,510],{"class":295},"}`",[281,512,513],{"class":295}," },\n",[281,515,517,520],{"class":283,"line":516},11,[281,518,519],{"class":295},"  }",[281,521,360],{"class":347},[281,523,525,527,530,532,534,536,538,541],{"class":283,"line":524},12,[281,526,331],{"class":287},[281,528,529],{"class":291}," page",[281,531,337],{"class":295},[281,533,458],{"class":321},[281,535,453],{"class":291},[281,537,369],{"class":295},[281,539,540],{"class":343},"json",[281,542,543],{"class":347},"()\n",[281,545,547,550,552,555,557,560,563,565,568],{"class":283,"line":546},13,[281,548,549],{"class":291},"  employees",[281,551,369],{"class":295},[281,553,554],{"class":343},"push",[281,556,348],{"class":347},[281,558,559],{"class":295},"...",[281,561,562],{"class":291},"page",[281,564,369],{"class":295},[281,566,567],{"class":291},"data",[281,569,360],{"class":347},[281,571,573,576,578,580,582],{"class":283,"line":572},14,[281,574,575],{"class":291},"  cursor",[281,577,337],{"class":295},[281,579,529],{"class":291},[281,581,369],{"class":295},[281,583,584],{"class":291},"nextCursor\n",[281,586,588,591,594],{"class":283,"line":587},15,[281,589,590],{"class":295},"}",[281,592,593],{"class":321}," while",[281,595,596],{"class":291}," (cursor)\n",[232,598,600],{"id":599},"find-one-person","Find one person",[223,602,603,604,606,607,253,610,613,614,617,618,620,621,623],{},"To match someone in your own system to Teambrite, filter ",[227,605,256],{"href":97}," by ",[263,608,609],{},"email",[263,611,612],{},"externalId"," or ",[263,615,616],{},"id",". You get them as the only item in ",[263,619,567],{},", or an empty ",[263,622,567],{}," if nobody matches.",[232,625,627],{"id":626},"see-whats-coming","See what's coming",[223,629,630,633,634,637],{},[227,631,632],{"href":158},"Upcoming rewards"," lists the rewards due, earliest first and a page at a time, with totals by program. It's a good source for a budget report. Starter plans can look 60 days ahead, and Enterprise plans 365. If you ask for more than your plan allows, you get what it does allow, and ",[263,635,636],{},"limitedToDays"," says so.",[232,639,641],{"id":640},"find-the-gaps","Find the gaps",[223,643,644],{},"Three endpoints look for problems in your programs:",[646,647,648,661],"table",{},[649,650,651],"thead",{},[652,653,654,658],"tr",{},[655,656,657],"th",{},"Endpoint",[655,659,660],{},"The question it answers",[662,663,664,679,689],"tbody",{},[652,665,666,672],{},[667,668,669],"td",{},[227,670,671],{"href":168},"Coverage gaps",[667,673,674,675,678],{},"How many people does no birthday or anniversary program reach? ",[227,676,677],{"href":173},"List them"," when you need names",[652,680,681,686],{},[667,682,683],{},[227,684,685],{"href":178},"Quiet employees",[667,687,688],{},"Who has gone a long time without a reward?",[652,690,691,696],{},[667,692,693],{},[227,694,695],{"href":183},"Program review",[667,697,698],{},"Which programs would pay someone twice, or never pay anyone?",[223,700,701],{},"These do more work than a simple list, so run them on a schedule rather than on every page view.",[703,704,705],"style",{},"html pre.shiki code .spNyl, html code.shiki .spNyl{--shiki-light:#9C3EDA;--shiki-default:#C792EA;--shiki-dark:#C792EA}html pre.shiki code .sTEyZ, html code.shiki .sTEyZ{--shiki-light:#90A4AE;--shiki-default:#EEFFFF;--shiki-dark:#BABED8}html pre.shiki code .sMK4o, html code.shiki .sMK4o{--shiki-light:#39ADB5;--shiki-default:#89DDFF;--shiki-dark:#89DDFF}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 .swJcz, html code.shiki .swJcz{--shiki-light:#E53935;--shiki-default:#F07178;--shiki-dark:#F07178}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":277,"searchDepth":302,"depth":302,"links":707},[708,709,710,711,712],{"id":234,"depth":302,"text":235},{"id":245,"depth":302,"text":246},{"id":599,"depth":302,"text":600},{"id":626,"depth":302,"text":627},{"id":640,"depth":302,"text":641},"Pull your programs, employees and insights into your own systems.","md",null,{},{"icon":35},{"title":47,"description":713},"kLv-ITgu30MuothOJTMcXOTjRXCkS5-Bt-MX5VEZsbM",[721,723],{"title":37,"path":38,"stem":39,"description":722,"icon":40,"children":-1},"See which apps are connected, disconnect one, and fix common problems.",{"title":51,"path":52,"stem":53,"description":724,"icon":54,"children":-1},"Report each person's progress so goal programs can reward them.",1794422645403]