[{"data":1,"prerenderedAt":415},["ShallowReactive",2],{"navigation_docs":3,"-api-reference-employees-list-employees-operation":217,"-api-reference-employees-list-employees":392,"-api-reference-employees-list-employees-surround":408},[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":87,"path":218,"description":219,"scope":220,"parameters":221,"responses":256},"\u002Fv1\u002Femployees","Returns your active employees. To find one person, filter by `id`, `email` or `externalId`, and you get them as the only item in `data`, or an empty `data` if nobody matches. Filters combine, so an employee has to match every one you send. `birthday` is `null` for anyone who has made theirs private.","employee:read",[222,230,235,241,245,251],{"name":223,"in":224,"required":12,"description":225,"schema":226},"id","query","Only the employee with this ID.",{"type":227,"maxLength":228,"pattern":229},"string",100,"^emp_[A-Za-z0-9_-]+$",{"name":231,"in":224,"required":12,"description":232,"schema":233},"email","Only the employee with this work email. Capitals don't matter.",{"type":227,"maxLength":234,"format":231},254,{"name":236,"in":224,"required":12,"description":237,"schema":238},"externalId","Only the employee with this ID from your own system, as it was imported into Teambrite.",{"type":227,"minLength":239,"maxLength":240},1,255,{"name":242,"in":224,"required":12,"description":243,"schema":244},"search","Only return employees whose name contains this text.",{"type":227,"minLength":239,"maxLength":228},{"name":246,"in":224,"required":12,"description":247,"schema":248},"limit","How many to return, up to 100.",{"default":249,"type":250,"minimum":239,"maximum":228},50,"integer",{"name":252,"in":224,"required":12,"description":253,"schema":254},"cursor","The `nextCursor` from the previous page. Leave it out to start from the beginning.",{"type":227,"minLength":239,"maxLength":255},200,[257,345,361,371,381],{"status":258,"description":259,"schema":260,"example":325},"200","One page of employees.",{"type":261,"properties":262,"required":322,"additionalProperties":12},"object",{"data":263,"nextCursor":319},{"type":264,"items":265,"description":318},"array",{"type":261,"properties":266,"required":310,"additionalProperties":12},{"id":267,"fullName":269,"email":271,"startDate":277,"yearsOfService":283,"birthday":289,"avatarUrl":295,"timezone":301,"externalId":304,"externalIdSource":307},{"type":227,"maxLength":228,"pattern":229,"description":268},"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":270},"The employee's full name.",{"anyOf":272,"description":276},[273,274],{"type":227,"format":231},{"type":275},"null","Their work email.",{"anyOf":278},[279,282],{"type":227,"format":280,"description":281},"date","The day they started.",{"type":275},{"anyOf":284},[285,288],{"type":250,"minimum":286,"description":287},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":275},{"anyOf":290,"description":294},[291,293],{"type":227,"pattern":292},"^(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$",{"type":275},"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":296,"description":300},[297,299],{"type":227,"format":298},"uri",{"type":275},"The address of the picture they uploaded.",{"description":302,"type":303},"Their IANA time zone, such as `America\u002FToronto`.",[227,275],{"description":305,"type":306},"The ID your own system uses for them.",[227,275],{"description":308,"type":309},"The system `externalId` came from.",[227,275],[223,311,231,312,313,314,315,316,236,317],"fullName","startDate","yearsOfService","birthday","avatarUrl","timezone","externalIdSource","Active employees who match every filter you sent, ordered by ID. Empty if nobody matches.",{"description":320,"type":321},"Pass this as `cursor` to get the next page. `null` on the last page. Treat it as opaque.",[227,275],[323,324],"data","nextCursor",{"data":326,"nextCursor":339},[327,338],{"id":328,"fullName":329,"email":330,"startDate":331,"yearsOfService":332,"birthday":333,"avatarUrl":334,"timezone":335,"externalId":336,"externalIdSource":337},"emp_LssEG8crOK3xrxCVx1nS6jy7","Ada Lovelace","ada@example.com","2021-03-15",5,"12-10","https:\u002F\u002Fcdn.teambrite.com\u002Favatars\u002Fada.png","America\u002FToronto","EMP-1042","workday",{"id":339,"fullName":340,"email":341,"startDate":342,"yearsOfService":343,"birthday":344,"avatarUrl":344,"timezone":344,"externalId":344,"externalIdSource":344},"emp_YY4BTQjWrhH4sQL1dRwjTpBw","Grace Hopper","grace@example.com","2019-06-03",7,null,{"status":346,"description":347,"schema":348,"example":350},"400","`API_QUERY_INVALID`: A query parameter, or an ID in the path, is unknown or not in the right form.",{"$ref":349},"#\u002Fcomponents\u002Fschemas\u002FError",{"error":351,"status":352,"message":353,"data":354},true,400,"A query parameter, or an ID in the path, is unknown or not in the right form.",{"code":355,"why":353,"fix":356,"formErrors":357,"fieldErrors":358},"API_QUERY_INVALID","Correct the parameters listed under `fieldErrors` and send the request again.",[],{"limit":359},[360],"Too big: expected number to be \u003C=100",{"status":362,"description":363,"schema":364,"example":365},"401","`API_KEY_INVALID`: The key is missing, wrong, expired or revoked.",{"$ref":349},{"error":351,"status":366,"message":367,"data":368},401,"The key is missing, wrong, expired or revoked.",{"code":369,"why":367,"fix":370},"API_KEY_INVALID","Send a current key as a Bearer token. Owners and admins manage keys in Settings, under Developer.",{"status":372,"description":373,"schema":374,"example":375},"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":349},{"error":351,"status":376,"message":377,"data":378},403,"The key is valid but wasn't given the scope this endpoint needs.",{"code":379,"why":377,"fix":380},"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":382,"description":383,"schema":384,"example":385},"429","`API_KEY_RATE_LIMITED`: The key is over 600 requests a minute. `COMPANY_RATE_LIMITED`: Your company is over its limit of 120 read requests a minute.",{"$ref":349},{"error":351,"status":386,"message":387,"data":388},429,"The key is over 600 requests a minute.",{"code":389,"why":387,"fix":390,"retryAfterSeconds":391},"API_KEY_RATE_LIMITED","Wait for the number of seconds in the `Retry-After` header, then send it again.",42,{"id":393,"title":96,"body":394,"description":401,"extension":402,"links":344,"meta":403,"navigation":404,"path":97,"seo":406,"stem":98,"__hash__":407},"docs\u002F2.api-reference\u002F06.employees\u002F1.list-employees.md",{"type":395,"value":396,"toc":397},"minimark",[],{"title":398,"searchDepth":399,"depth":399,"links":400},"",2,[],"Your active employees, with the IDs you need to send metric values.","md",{},{"badge":405},{"label":87,"color":88,"variant":89},{"title":96,"description":401},"EPaxFrIoeltFe9YWflA3JpoaEE2U3Aw13xjQBzS7zc8",[409,412],{"title":83,"path":84,"stem":85,"description":410,"badge":411,"children":-1},"Your active reward programs, their audience and what they will pay.",{"label":87,"color":88,"variant":89},{"title":101,"path":102,"stem":103,"description":413,"badge":414,"children":-1},"Add someone, with the dates their rewards depend on.",{"label":105,"color":106,"variant":89},1794422645676]