[{"data":1,"prerenderedAt":386},["ShallowReactive",2],{"navigation_docs":3,"-api-reference-programs-list-programs-operation":217,"-api-reference-programs-list-programs":364,"-api-reference-programs-list-programs-surround":380},[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":237},"\u002Fv1\u002Fprograms","Returns your active reward programs, with how many people each reaches and what it will pay in the next 30 days.","program:read",[222,231],{"name":223,"in":224,"required":12,"description":225,"schema":226},"limit","query","How many to return, up to 100.",{"default":227,"type":228,"minimum":229,"maximum":230},50,"integer",1,100,{"name":232,"in":224,"required":12,"description":233,"schema":234},"cursor","The `nextCursor` from the previous page. Leave it out to start from the beginning.",{"type":235,"minLength":229,"maxLength":236},"string",200,[238,317,333,343,353],{"status":239,"description":240,"schema":241,"example":304},"200","One page of programs.",{"type":242,"properties":243,"required":301,"additionalProperties":12},"object",{"data":244,"nextCursor":298},{"type":245,"items":246,"description":297},"array",{"type":242,"properties":247,"required":290,"additionalProperties":12},{"id":248,"name":251,"occasion":255,"amountMinor":262,"currency":268,"audienceCount":271,"next30Days":273},{"type":235,"maxLength":230,"pattern":249,"description":250},"^pol_[A-Za-z0-9_-]+$","The program's ID.",{"description":252,"type":253},"The program's name. `null` if it was never given one, so identify a program by its ID.",[235,254],"null",{"type":235,"enum":256,"description":261},[257,258,259,260],"birthday","service_anniversary","custom_date","metric_goal","What the program rewards.",{"anyOf":263},[264,267],{"type":228,"minimum":265,"description":266},0,"What the program pays each person. In minor units, so `2500` is 25.00.",{"type":254},{"type":235,"pattern":269,"description":270},"^[a-z]{3}$","Lowercase three-letter currency code, such as `usd`.",{"type":228,"minimum":265,"description":272},"How many active employees the program reaches today.",{"type":242,"properties":274,"required":285,"additionalProperties":12,"description":289},{"rewardCount":275,"amountMinor":277,"nextDate":279},{"type":228,"minimum":265,"description":276},"Rewards due in the next 30 days.",{"type":228,"minimum":265,"description":278},"What those rewards add up to. In minor units, so `2500` is 25.00.",{"anyOf":280},[281,284],{"type":235,"format":282,"description":283},"date","The first day a reward is due, in your company's time zone.",{"type":254},[286,287,288],"rewardCount","amountMinor","nextDate","What the program will pay in the next 30 days.",[291,292,293,287,294,295,296],"id","name","occasion","currency","audienceCount","next30Days","Your active programs, ordered by ID.",{"description":299,"type":300},"Pass this as `cursor` to get the next page. `null` on the last page. Treat it as opaque.",[235,254],[302,303],"data","nextCursor",{"data":305,"nextCursor":316},[306],{"id":307,"name":308,"occasion":257,"amountMinor":309,"currency":310,"audienceCount":311,"next30Days":312},"pol_V3nQ8dKcR2tYh6LmXw9Zs4Bf","Birthday reward",2500,"usd",184,{"rewardCount":313,"amountMinor":314,"nextDate":315},16,40000,"2026-11-12",null,{"status":318,"description":319,"schema":320,"example":322},"400","`API_QUERY_INVALID`: A query parameter, or an ID in the path, is unknown or not in the right form.",{"$ref":321},"#\u002Fcomponents\u002Fschemas\u002FError",{"error":323,"status":324,"message":325,"data":326},true,400,"A query parameter, or an ID in the path, is unknown or not in the right form.",{"code":327,"why":325,"fix":328,"formErrors":329,"fieldErrors":330},"API_QUERY_INVALID","Correct the parameters listed under `fieldErrors` and send the request again.",[],{"limit":331},[332],"Too big: expected number to be \u003C=100",{"status":334,"description":335,"schema":336,"example":337},"401","`API_KEY_INVALID`: The key is missing, wrong, expired or revoked.",{"$ref":321},{"error":323,"status":338,"message":339,"data":340},401,"The key is missing, wrong, expired or revoked.",{"code":341,"why":339,"fix":342},"API_KEY_INVALID","Send a current key as a Bearer token. Owners and admins manage keys in Settings, under Developer.",{"status":344,"description":345,"schema":346,"example":347},"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":321},{"error":323,"status":348,"message":349,"data":350},403,"The key is valid but wasn't given the scope this endpoint needs.",{"code":351,"why":349,"fix":352},"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":354,"description":355,"schema":356,"example":357},"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":321},{"error":323,"status":358,"message":359,"data":360},429,"The key is over 600 requests a minute.",{"code":361,"why":359,"fix":362,"retryAfterSeconds":363},"API_KEY_RATE_LIMITED","Wait for the number of seconds in the `Retry-After` header, then send it again.",42,{"id":365,"title":83,"body":366,"description":373,"extension":374,"links":316,"meta":375,"navigation":376,"path":84,"seo":378,"stem":85,"__hash__":379},"docs\u002F2.api-reference\u002F05.programs\u002F1.list-programs.md",{"type":367,"value":368,"toc":369},"minimark",[],{"title":370,"searchDepth":371,"depth":371,"links":372},"",2,[],"Your active reward programs, their audience and what they will pay.","md",{},{"badge":377},{"label":87,"color":88,"variant":89},{"title":83,"description":373},"Wi_BGyjGkE8ZjNEAiXDHKD_aOEh47pvG00tdvwftG7s",[381,383],{"title":73,"path":74,"stem":75,"description":382,"icon":76,"children":-1},"How to page through lists and the detail in reports.",{"title":96,"path":97,"stem":98,"description":384,"badge":385,"children":-1},"Your active employees, with the IDs you need to send metric values.",{"label":87,"color":88,"variant":89},1794422645857]