[{"data":1,"prerenderedAt":435},["ShallowReactive",2],{"navigation_docs":3,"-api-reference-employees-create-employee-operation":217,"-api-reference-employees-create-employee":412,"-api-reference-employees-create-employee-surround":428},[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":105,"path":218,"description":219,"scope":220,"parameters":221,"body":222,"responses":275},"\u002Fv1\u002Femployees","Adds an active employee. Programs that reach everyone, or match their dates, start including them straight away. Nobody is emailed. To archive someone who has left, use the Teambrite dashboard: the API can't. Email and `externalId` are each unique in your company, so a retried create can't add someone twice: it answers `409` with `data.employeeId`, the person the first attempt made.","employee:write",[],{"schema":223,"example":267},{"type":224,"properties":225,"required":265,"additionalProperties":12},"object",{"fullName":226,"email":231,"startDate":235,"birthday":242,"timezone":248,"externalId":254,"externalIdSource":260},{"type":227,"minLength":228,"maxLength":229,"description":230},"string",1,200,"Their full name.",{"type":227,"maxLength":232,"format":233,"description":234},254,"email","Their work email. Rewards are sent here, and no two employees in your company can share one. Capitals don't matter.",{"anyOf":236},[237,240],{"type":227,"format":238,"description":239},"date","The day they started. Work anniversary programs count from it.",{"type":241},"null",{"anyOf":243},[244,247],{"type":227,"pattern":245,"description":246},"^(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$","Their birthday as `MM-DD`. Send no year: Teambrite never keeps one. Whether coworkers see it stays their own choice.",{"type":241},{"anyOf":249},[250,253],{"type":227,"minLength":228,"maxLength":251,"description":252},100,"Their IANA time zone, such as `America\u002FToronto`.",{"type":241},{"anyOf":255},[256,259],{"type":227,"minLength":228,"maxLength":257,"description":258},255,"The ID your own system uses for them. No two employees in your company can share one.",{"type":241},{"anyOf":261},[262,264],{"type":227,"minLength":228,"maxLength":251,"description":263},"The system `externalId` comes from, such as `workday`.",{"type":241},[266,233],"fullName",{"fullName":268,"email":269,"startDate":270,"birthday":271,"timezone":272,"externalId":273,"externalIdSource":274},"Ada Lovelace","ada@example.com","2021-03-15","12-10","America\u002FToronto","EMP-1042","workday",[276,335,351,361,371,381,391,401],{"status":277,"description":278,"schema":279,"example":331},"201","The employee was added. Their profile, as List employees shows it.",{"type":224,"properties":280,"required":322,"additionalProperties":12},{"id":281,"fullName":284,"email":286,"startDate":291,"yearsOfService":296,"birthday":303,"avatarUrl":308,"timezone":314,"externalId":316,"externalIdSource":319},{"type":227,"maxLength":251,"pattern":282,"description":283},"^emp_[A-Za-z0-9_-]+$","The employee's ID, which is also in the address of their dashboard profile. Use it as `employeeId` when you send a metric value.",{"type":227,"description":285},"The employee's full name.",{"anyOf":287,"description":290},[288,289],{"type":227,"format":233},{"type":241},"Their work email.",{"anyOf":292},[293,295],{"type":227,"format":238,"description":294},"The day they started.",{"type":241},{"anyOf":297},[298,302],{"type":299,"minimum":300,"description":301},"integer",0,"Whole years since `startDate`, as of today in your company's time zone. Someone who started on 29 February reaches the next year on 28 February in other years. `null` with no start date, or one still to come.",{"type":241},{"anyOf":304,"description":307},[305,306],{"type":227,"pattern":245},{"type":241},"Their birthday as `MM-DD`. Teambrite keeps no birth year. `null` if it's missing or they have made it private, and the two aren't told apart.",{"anyOf":309,"description":313},[310,312],{"type":227,"format":311},"uri",{"type":241},"The address of the picture they uploaded.",{"description":252,"type":315},[227,241],{"description":317,"type":318},"The ID your own system uses for them.",[227,241],{"description":320,"type":321},"The system `externalId` came from.",[227,241],[323,266,233,324,325,326,327,328,329,330],"id","startDate","yearsOfService","birthday","avatarUrl","timezone","externalId","externalIdSource",{"id":332,"fullName":268,"email":269,"startDate":270,"yearsOfService":333,"birthday":271,"avatarUrl":334,"timezone":272,"externalId":273,"externalIdSource":274},"emp_LssEG8crOK3xrxCVx1nS6jy7",5,null,{"status":336,"description":337,"schema":338,"example":340},"400","`REQUEST_BODY_INVALID`: The body has a field that is unknown, missing or out of range.",{"$ref":339},"#\u002Fcomponents\u002Fschemas\u002FError",{"error":341,"status":342,"message":343,"data":344},true,400,"The body has a field that is unknown, missing or out of range.",{"code":345,"why":343,"fix":346,"formErrors":347,"fieldErrors":348},"REQUEST_BODY_INVALID","Correct the fields listed under `fieldErrors`, or the problem under `formErrors`, and send it again.",[],{"limit":349},[350],"Too big: expected number to be \u003C=100",{"status":352,"description":353,"schema":354,"example":355},"401","`API_KEY_INVALID`: The key is missing, wrong, expired or revoked.",{"$ref":339},{"error":341,"status":356,"message":357,"data":358},401,"The key is missing, wrong, expired or revoked.",{"code":359,"why":357,"fix":360},"API_KEY_INVALID","Send a current key as a Bearer token. Owners and admins manage keys in Settings, under Developer.",{"status":362,"description":363,"schema":364,"example":365},"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. `PLAN_HEADCOUNT_LIMIT`: Adding this person would take you past the number of employees your plan covers.",{"$ref":339},{"error":341,"status":366,"message":367,"data":368},403,"The key is valid but wasn't given the scope this endpoint needs.",{"code":369,"why":367,"fix":370},"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":372,"description":373,"schema":374,"example":375},"409","`EMPLOYEE_EMAIL_TAKEN`: Another employee in your company already has this email. `EMPLOYEE_EXTERNAL_ID_TAKEN`: Another employee in your company already has this `externalId`.",{"$ref":339},{"error":341,"status":376,"message":377,"data":378},409,"Another employee in your company already has this email.",{"code":379,"why":377,"fix":380},"EMPLOYEE_EMAIL_TAKEN","Update the employee in `data.employeeId` instead. A create that is retried after a timeout gets this answer, with the ID it made.",{"status":382,"description":383,"schema":384,"example":385},"411","`REQUEST_LENGTH_REQUIRED`: The request didn't declare its length.",{"$ref":339},{"error":341,"status":386,"message":387,"data":388},411,"The request didn't declare its length.",{"code":389,"why":387,"fix":390},"REQUEST_LENGTH_REQUIRED","Send the request with a Content-Length header.",{"status":392,"description":393,"schema":394,"example":395},"413","`REQUEST_TOO_LARGE`: The body is over 1 MB.",{"$ref":339},{"error":341,"status":396,"message":397,"data":398},413,"The body is over 1 MB.",{"code":399,"why":397,"fix":400},"REQUEST_TOO_LARGE","Send less at once and try again.",{"status":402,"description":403,"schema":404,"example":405},"429","`API_KEY_RATE_LIMITED`: The key is over 600 requests a minute.",{"$ref":339},{"error":341,"status":406,"message":407,"data":408},429,"The key is over 600 requests a minute.",{"code":409,"why":407,"fix":410,"retryAfterSeconds":411},"API_KEY_RATE_LIMITED","Wait for the number of seconds in the `Retry-After` header, then send it again.",42,{"id":413,"title":101,"body":414,"description":421,"extension":422,"links":334,"meta":423,"navigation":424,"path":102,"seo":426,"stem":103,"__hash__":427},"docs\u002F2.api-reference\u002F06.employees\u002F2.create-employee.md",{"type":415,"value":416,"toc":417},"minimark",[],{"title":418,"searchDepth":419,"depth":419,"links":420},"",2,[],"Add someone, with the dates their rewards depend on.","md",{},{"badge":425},{"label":105,"color":106,"variant":89},{"title":101,"description":421},"BCk7kk92HSSLOxd3DB-0Lp6RmhA7Fa5R5eLJoFkrSKc",[429,432],{"title":96,"path":97,"stem":98,"description":430,"badge":431,"children":-1},"Your active employees, with the IDs you need to send metric values.",{"label":87,"color":88,"variant":89},{"title":108,"path":109,"stem":110,"description":433,"badge":434,"children":-1},"Change someone's profile, such as a new start date or email.",{"label":112,"color":113,"variant":89},1794422646790]