[{"data":1,"prerenderedAt":577},["ShallowReactive",2],{"navigation_docs":3,"-api-reference-authentication":217,"-api-reference-authentication-surround":572},[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":63,"body":219,"description":565,"extension":566,"links":567,"meta":568,"navigation":569,"path":64,"seo":570,"stem":65,"__hash__":571},"docs\u002F2.api-reference\u002F02.authentication.md",{"type":220,"value":221,"toc":553},"minimark",[222,235,240,252,299,303,306,442,448,457,471,475,478,523,526,530,536,540,549],[223,224,225,226,230,231,234],"p",{},"Every request except the ",[227,228,229],"a",{"href":208},"health check"," and the ",[227,232,233],{"href":213},"OpenAPI document"," needs an API key.",[236,237,239],"h2",{"id":238},"create-a-key","Create a key",[223,241,242,243,247,248,251],{},"Owners and admins can create keys on the ",[244,245,246],"strong",{},"Starter"," and ",[244,249,250],{},"Enterprise"," plans.",[253,254,256,261,276,280,287,291],"steps",{"level":255},"3",[257,258,260],"h3",{"id":259},"open-api-keys","Open API keys",[223,262,263,264,267,268,271,272,275],{},"In Teambrite, go to ",[244,265,266],{},"Settings",", ",[244,269,270],{},"Developer",", then ",[244,273,274],{},"API keys",".",[257,277,279],{"id":278},"create-the-key","Create the key",[223,281,282,283,286],{},"Choose ",[244,284,285],{},"New key",", name it after what will use it, and choose what it can do. You may be asked to confirm it's you.",[257,288,290],{"id":289},"copy-it-somewhere-safe","Copy it somewhere safe",[223,292,293,294,298],{},"The full key is shown only once. Keys start with ",[295,296,297],"code",{},"tb_live_",". Keep yours in a secrets manager, and never put it in code that runs in a browser.",[236,300,302],{"id":301},"scopes","Scopes",[223,304,305],{},"A key can only do what it was given when it was created. To change that, create a new key and revoke the old one.",[307,308,309,325],"table",{},[310,311,312],"thead",{},[313,314,315,319,322],"tr",{},[316,317,318],"th",{},"Scope",[316,320,321],{},"What it allows",[316,323,324],{},"Personal data it can see",[326,327,328,343,360,382,409,425],"tbody",{},[313,329,330,336,340],{},[331,332,333],"td",{},[295,334,335],{},"program:read",[331,337,338],{},[227,339,83],{"href":84},[331,341,342],{},"None",[313,344,345,350,357],{},[331,346,347],{},[295,348,349],{},"employee:read",[331,351,352,247,354],{},[227,353,96],{"href":97},[227,355,356],{"href":121},"list groups",[331,358,359],{},"Full name, work email, start date, birthday month and day unless private, picture, time zone, and the ID from your own system",[313,361,362,367,376],{},[331,363,364],{},[295,365,366],{},"employee:write",[331,368,369,247,372,375],{},[227,370,371],{"href":102},"Create",[227,373,374],{"href":109},"update"," employees",[331,377,378,379,381],{},"The profile of each employee it adds or changes, as ",[295,380,349],{}," shows it",[313,383,384,389,407],{},[331,385,386],{},[295,387,388],{},"group:write",[331,390,391,267,393,247,395,398,399,402,403,406],{},[227,392,371],{"href":126},[227,394,374],{"href":131},[227,396,397],{"href":136},"archive"," groups, and ",[227,400,401],{"href":143},"add"," or ",[227,404,405],{"href":148},"remove"," members",[331,408,342],{},[313,410,411,416,422],{},[331,412,413],{},[295,414,415],{},"reward:read",[331,417,418,421],{},[227,419,420],{"href":158},"Upcoming rewards"," and the insights",[331,423,424],{},"Full name, start date, reward dates and when someone was last rewarded",[313,426,427,432,439],{},[331,428,429],{},[295,430,431],{},"metric:write",[331,433,434,247,436],{},[227,435,192],{"href":193},[227,437,438],{"href":198},"see how it was checked",[331,440,441],{},"The metric values your company sent",[223,443,444,445,447],{},"Teambrite never keeps a birth year, so none of these can show one. ",[295,446,415],{}," lists the date each reward is due, so a birthday reward shows when someone's birthday is, even if they've made it private. Give that scope only to systems that should see it.",[223,449,450,451,453,454,456],{},"The two write scopes change who gets rewarded and when. ",[295,452,366],{}," sets the email rewards are sent to and the dates programs pay on, and ",[295,455,388],{}," decides who programs that target a group reach. Every change a key makes is in your audit log under the key's name.",[223,458,459,460,463,464,467,468,470],{},"A key without the scope an endpoint needs gets a ",[295,461,462],{},"403"," with the code ",[295,465,466],{},"API_KEY_SCOPE_MISSING",". Keys created before scopes existed have ",[295,469,431],{}," only.",[236,472,474],{"id":473},"send-the-key","Send the key",[223,476,477],{},"Pass it as a bearer token:",[479,480,485],"pre",{"className":481,"code":482,"language":483,"meta":484,"style":484},"language-bash shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","curl https:\u002F\u002Fapi.teambrite.com\u002Fv1\u002Fprograms \\\n  -H \"Authorization: Bearer $TEAMBRITE_API_KEY\"\n","bash","",[295,486,487,504],{"__ignoreMap":484},[488,489,492,496,500],"span",{"class":490,"line":491},"line",1,[488,493,495],{"class":494},"sBMFI","curl",[488,497,499],{"class":498},"sfazB"," https:\u002F\u002Fapi.teambrite.com\u002Fv1\u002Fprograms",[488,501,503],{"class":502},"sTEyZ"," \\\n",[488,505,507,510,514,517,520],{"class":490,"line":506},2,[488,508,509],{"class":498},"  -H",[488,511,513],{"class":512},"sMK4o"," \"",[488,515,516],{"class":498},"Authorization: Bearer ",[488,518,519],{"class":502},"$TEAMBRITE_API_KEY",[488,521,522],{"class":512},"\"\n",[223,524,525],{},"A key belongs to one company. Nothing in a request names a company, so every call acts on the company that owns the key.",[236,527,529],{"id":528},"revoke-a-key","Revoke a key",[223,531,282,532,535],{},[244,533,534],{},"Revoke"," next to the key on the same page. Anything using it stops working right away, and this can't be undone.",[236,537,539],{"id":538},"if-your-plan-changes","If your plan changes",[223,541,542,543,463,545,548],{},"If your company leaves a plan with API access, requests get a ",[295,544,462],{},[295,546,547],{},"PLAN_UPGRADE_REQUIRED",". Your keys are kept, and they work again when you return to a plan that includes the API.",[550,551,552],"style",{},"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 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 .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":484,"searchDepth":506,"depth":506,"links":554},[555,561,562,563,564],{"id":238,"depth":506,"text":239,"children":556},[557,559,560],{"id":259,"depth":558,"text":260},3,{"id":278,"depth":558,"text":279},{"id":289,"depth":558,"text":290},{"id":301,"depth":506,"text":302},{"id":473,"depth":506,"text":474},{"id":528,"depth":506,"text":529},{"id":538,"depth":506,"text":539},"Create an API key, choose what it can do, and send it with your requests.","md",null,{},{"icon":66},{"title":63,"description":565},"mUKv8Cj8IqEjWf0pwYR5gXL5uAhXC6okzDjk9AFQoT4",[573,575],{"title":11,"path":57,"stem":58,"description":574,"icon":61,"children":-1},"Make your first request to the Teambrite API.",{"title":68,"path":69,"stem":70,"description":576,"icon":71,"children":-1},"How errors are shaped, what each code means, and the limits on requests.",1794422645857]