[{"data":1,"prerenderedAt":1116},["ShallowReactive",2],{"api-nav":3,"api-spec:index":351,"api-spec:op:get-health":636,"api-permissions-guide":705,"api-reference-doc:get-health":706},[4,28,57,95,115,301,317,331],{"id":5,"title":6,"links":7,"groups":27},"start","Start here",[8,11,15,18,21,24],{"title":9,"to":10},"Overview","\u002Fapi",{"title":12,"to":13,"status":14},"Quickstart","\u002Fapi\u002Fquickstart","available",{"title":16,"to":17,"status":14},"Environments","\u002Fapi\u002Fenvironments",{"title":19,"to":20,"status":14},"Authentication","\u002Fapi\u002Fauthentication",{"title":22,"to":23,"status":14},"Organizations","\u002Fapi\u002Forganizations",{"title":25,"to":26,"status":14},"Permissions","\u002Fapi\u002Fpermissions",[],{"id":29,"title":30,"links":31,"groups":56},"concepts","Concepts",[32,35,38,41,44,47,50,53],{"title":33,"to":34,"status":14},"Requests and responses","\u002Fapi\u002Frequests-and-responses",{"title":36,"to":37,"status":14},"Identifiers","\u002Fapi\u002Fidentifiers",{"title":39,"to":40,"status":14},"Pagination","\u002Fapi\u002Fpagination",{"title":42,"to":43},"Errors","\u002Fapi\u002Ferrors",{"title":45,"to":46,"status":14},"Rate limits","\u002Fapi\u002Frate-limits",{"title":48,"to":49,"status":14},"Retries","\u002Fapi\u002Fretries-and-idempotency",{"title":51,"to":52,"status":14},"Security","\u002Fapi\u002Fsecurity",{"title":54,"to":55,"status":14},"Versioning","\u002Fapi\u002Fversioning",[],{"id":58,"title":59,"links":60,"groups":94},"resources","Guides",[61,64,67,70,73,76,79,82,85,88,91],{"title":62,"to":63,"status":14},"Students","\u002Fapi\u002Fguides\u002Fstudents",{"title":65,"to":66,"status":14},"Bulk registration","\u002Fapi\u002Fguides\u002Fbulk-registration",{"title":68,"to":69,"status":14},"Passwords","\u002Fapi\u002Fguides\u002Fpasswords",{"title":71,"to":72,"status":14},"Supervisors","\u002Fapi\u002Fguides\u002Fsupervisors",{"title":74,"to":75,"status":14},"Reference data","\u002Fapi\u002Fguides\u002Freference-data",{"title":77,"to":78,"status":14},"API account","\u002Fapi\u002Fguides\u002Fapi-account",{"title":80,"to":81,"status":14},"Sign-in links","\u002Fapi\u002Fguides\u002Fsign-in-links",{"title":83,"to":84,"status":14},"Exams","\u002Fapi\u002Fguides\u002Fexams",{"title":86,"to":87,"status":14},"Applications","\u002Fapi\u002Fguides\u002Fapplications",{"title":89,"to":90,"status":14},"Group challenges","\u002Fapi\u002Fguides\u002Fgroup-challenges",{"title":92,"to":93,"status":14},"Certificates and reports","\u002Fapi\u002Fguides\u002Fcertificates-and-reports",[],{"id":96,"title":97,"links":98,"groups":114},"tutorials","Tutorials",[99,102,105,108,111],{"title":100,"to":101,"status":14},"Register and apply","\u002Fapi\u002Ftutorials\u002Fregister-and-apply",{"title":103,"to":104,"status":14},"Send a student to the panel","\u002Fapi\u002Ftutorials\u002Fsend-student-to-panel",{"title":106,"to":107,"status":14},"Change an application","\u002Fapi\u002Ftutorials\u002Fchange-an-application",{"title":109,"to":110,"status":14},"Collect results","\u002Fapi\u002Ftutorials\u002Fcollect-results",{"title":112,"to":113,"status":14},"Token handling","\u002Fapi\u002Ftutorials\u002Ftoken-handling",[],{"id":116,"title":117,"links":118,"groups":125},"reference","Reference",[119,122],{"title":120,"to":121},"All endpoints","\u002Fapi\u002Freference",{"title":123,"to":124},"Sandbox console","\u002Fapi\u002Fconsole",[126,135,145,166,206,212,230,255,271],{"tag":127,"slug":128,"links":129},"Health","health",[130],{"title":131,"to":132,"method":133,"deprecated":134},"Check that the API is up","\u002Fapi\u002Freference\u002Fget-health","GET",false,{"tag":77,"slug":136,"links":137},"api-account",[138,142],{"title":139,"to":140,"method":141,"deprecated":134},"Revoke the token you send, before it expires","\u002Fapi\u002Freference\u002Frevoke-token","POST",{"title":143,"to":144,"method":133,"deprecated":134},"Fetch the API account your token belongs to","\u002Fapi\u002Freference\u002Fget-current-api-account",{"tag":74,"slug":146,"links":147},"reference-data",[148,151,154,157,160,163],{"title":149,"to":150,"method":133,"deprecated":134},"List the countries a student can be registered in","\u002Fapi\u002Freference\u002Flist-countries",{"title":152,"to":153,"method":133,"deprecated":134},"Fetch one country by its id","\u002Fapi\u002Freference\u002Fget-country",{"title":155,"to":156,"method":133,"deprecated":134},"List the grades a student can be registered with","\u002Fapi\u002Freference\u002Flist-grades",{"title":158,"to":159,"method":133,"deprecated":134},"Fetch one grade by its id","\u002Fapi\u002Freference\u002Fget-grade",{"title":161,"to":162,"method":133,"deprecated":134},"List the organizations and their ids","\u002Fapi\u002Freference\u002Flist-organizations",{"title":164,"to":165,"method":133,"deprecated":134},"Fetch one organization by its id","\u002Fapi\u002Freference\u002Fget-organization",{"tag":62,"slug":167,"links":168},"students",[169,172,175,178,181,184,187,191,194,197,200,203],{"title":170,"to":171,"method":133,"deprecated":134},"List your students","\u002Fapi\u002Freference\u002Flist-students",{"title":173,"to":174,"method":141,"deprecated":134},"Register a student","\u002Fapi\u002Freference\u002Fregister-student",{"title":176,"to":177,"method":141,"deprecated":134},"Check a registration without registering the student","\u002Fapi\u002Freference\u002Fcheck-student-registration",{"title":179,"to":180,"method":141,"deprecated":134},"Register many students at once","\u002Fapi\u002Freference\u002Fcreate-student-import",{"title":182,"to":183,"method":133,"deprecated":134},"Follow a batch of students you sent","\u002Fapi\u002Freference\u002Fget-student-import",{"title":185,"to":186,"method":133,"deprecated":134},"Fetch one of your students","\u002Fapi\u002Freference\u002Fget-student",{"title":188,"to":189,"method":190,"deprecated":134},"Update one of your students","\u002Fapi\u002Freference\u002Fupdate-student","PUT",{"title":192,"to":193,"method":190,"deprecated":134},"Set the sign-in password of one of your students","\u002Fapi\u002Freference\u002Fset-student-password",{"title":195,"to":196,"method":133,"deprecated":134},"List your students who can use this organization","\u002Fapi\u002Freference\u002Flist-org-students",{"title":198,"to":199,"method":133,"deprecated":134},"Fetch one of your students, if they can use this organization","\u002Fapi\u002Freference\u002Fget-org-student",{"title":201,"to":202,"method":190,"deprecated":134},"Update one of your students and give them access to this organization","\u002Fapi\u002Freference\u002Fupdate-org-student",{"title":204,"to":205,"method":190,"deprecated":134},"Link one of your students to a supervisor on this organization","\u002Fapi\u002Freference\u002Flink-student-supervisor",{"tag":80,"slug":207,"links":208},"sign-in-links",[209],{"title":210,"to":211,"method":141,"deprecated":134},"Create a single-use sign-in link for one of your students","\u002Fapi\u002Freference\u002Fcreate-signin-link",{"tag":83,"slug":213,"links":214},"exams",[215,218,221,224,227],{"title":216,"to":217,"method":133,"deprecated":134},"List the exams open for applications","\u002Fapi\u002Freference\u002Flist-exams",{"title":219,"to":220,"method":133,"deprecated":134},"List an organization’s exam categories","\u002Fapi\u002Freference\u002Flist-exam-categories",{"title":222,"to":223,"method":133,"deprecated":134},"Fetch one exam category","\u002Fapi\u002Freference\u002Fget-exam-category",{"title":225,"to":226,"method":133,"deprecated":134},"List the exams one of your students can apply to","\u002Fapi\u002Freference\u002Flist-available-exams",{"title":228,"to":229,"method":133,"deprecated":134},"Fetch one exam that is open for applications","\u002Fapi\u002Freference\u002Fget-exam",{"tag":86,"slug":231,"links":232},"applications",[233,236,239,242,245,248,251],{"title":234,"to":235,"method":133,"deprecated":134},"List your students’ applications in this organization","\u002Fapi\u002Freference\u002Flist-applications",{"title":237,"to":238,"method":141,"deprecated":134},"Enter one of your students for an exam","\u002Fapi\u002Freference\u002Fcreate-application",{"title":240,"to":241,"method":133,"deprecated":134},"List your students’ applications for one exam","\u002Fapi\u002Freference\u002Flist-exam-applications",{"title":243,"to":244,"method":133,"deprecated":134},"List one of your students’ applications in this organization","\u002Fapi\u002Freference\u002Flist-student-applications",{"title":246,"to":247,"method":133,"deprecated":134},"Fetch one of your students’ applications","\u002Fapi\u002Freference\u002Fget-application",{"title":249,"to":250,"method":190,"deprecated":134},"Move one of your students’ applications to another exam","\u002Fapi\u002Freference\u002Fmove-application",{"title":252,"to":253,"method":254,"deprecated":134},"Withdraw one of your students from an exam","\u002Fapi\u002Freference\u002Fdelete-application","DELETE",{"tag":256,"slug":257,"links":258},"Documents","documents",[259,262,265,268],{"title":260,"to":261,"method":133,"deprecated":134},"Download a certificate file","\u002Fapi\u002Freference\u002Fdownload-certificate",{"title":263,"to":264,"method":133,"deprecated":134},"List one of your students’ released certificates","\u002Fapi\u002Freference\u002Flist-student-certificates",{"title":266,"to":267,"method":133,"deprecated":134},"Download a result report file","\u002Fapi\u002Freference\u002Fdownload-report",{"title":269,"to":270,"method":133,"deprecated":134},"List one of your students’ released result reports","\u002Fapi\u002Freference\u002Flist-student-reports",{"tag":89,"slug":272,"links":273},"group-challenges",[274,277,280,283,286,289,292,295,298],{"title":275,"to":276,"method":133,"deprecated":134},"List the group challenges an organization runs","\u002Fapi\u002Freference\u002Flist-group-challenges",{"title":278,"to":279,"method":133,"deprecated":134},"Fetch one group challenge","\u002Fapi\u002Freference\u002Fget-group-challenge",{"title":281,"to":282,"method":133,"deprecated":134},"List the groups your students are in for a group challenge","\u002Fapi\u002Freference\u002Flist-group-challenge-groups",{"title":284,"to":285,"method":133,"deprecated":134},"Fetch one group, with its steps and files","\u002Fapi\u002Freference\u002Fget-group-challenge-group",{"title":287,"to":288,"method":133,"deprecated":134},"List what has happened in one group","\u002Fapi\u002Freference\u002Flist-group-challenge-activity",{"title":290,"to":291,"method":141,"deprecated":134},"Send a group’s finished work for one of your students","\u002Fapi\u002Freference\u002Fsubmit-group-challenge-work",{"title":293,"to":294,"method":141,"deprecated":134},"Submit one step of a group for one of your students","\u002Fapi\u002Freference\u002Fsubmit-group-challenge-step",{"title":296,"to":297,"method":133,"deprecated":134},"List your students’ eligibility and groups for a group challenge","\u002Fapi\u002Freference\u002Flist-group-challenge-students",{"title":299,"to":300,"method":133,"deprecated":134},"Fetch one of your students’ eligibility and group for a group challenge","\u002Fapi\u002Freference\u002Fget-group-challenge-student",{"id":302,"title":303,"links":304,"groups":316},"clients","Clients",[305,307,310,313],{"title":9,"to":306,"status":14},"\u002Fapi\u002Fclients",{"title":308,"to":309,"status":14},"Node.js","\u002Fapi\u002Fclients\u002Fnode",{"title":311,"to":312,"status":14},"PHP","\u002Fapi\u002Fclients\u002Fphp",{"title":314,"to":315,"status":14},"Build your own","\u002Fapi\u002Fclients\u002Fbuild-your-own",[],{"id":318,"title":319,"links":320,"groups":330},"agents","AI agents",[321,324,327],{"title":322,"to":323},"AI connections","\u002Fapi\u002Fmcp",{"title":325,"to":326},"What it can do","\u002Fapi\u002Fmcp\u002Ftools",{"title":328,"to":329},"Agent skills","\u002Fapi\u002Fskills",[],{"id":332,"title":333,"links":334,"groups":350},"help","Help",[335,338,341,344,347],{"title":336,"to":337,"status":14},"Glossary","\u002Fapi\u002Fglossary",{"title":339,"to":340,"status":14},"FAQ","\u002Fapi\u002Ffaq",{"title":342,"to":343,"status":14},"Troubleshooting","\u002Fapi\u002Ftroubleshooting",{"title":345,"to":346,"status":14},"Support","\u002Fapi\u002Fsupport",{"title":348,"to":349},"Changelog","\u002Fapi\u002Fchangelog",[],{"title":352,"version":353,"description":354,"baseUrl":355,"groups":356},"Main Team API","1.2.0","Register your students, enter them for exams, follow their applications, download their certificates and reports, and sign them in to an organization’s panel.\n\nEvery operation except the health check needs a bearer token: a JWT you sign yourself with HS256 and your account’s `apiSecret`. Put your `apiKey` in both the `kid` header and the `sub` claim, and set `iat` and `exp` at most 3600 seconds apart. Every authentication failure answers the same `401 unauthorized`.","https:\u002F\u002Fapi.main-team.org",[357,368,383,419,484,492,522,561,586],{"tag":127,"slug":128,"description":358,"guide":17,"operations":359},"Whether the API is up. No token needed, so it is the first call to make against an environment.",[360],{"operationId":361,"slug":362,"method":133,"path":363,"tag":127,"summary":131,"deprecated":134,"public":364,"permission":365,"scope":366,"order":367},"getHealth","get-health","\u002Fv1\u002Fhealth",true,null,"public",1,{"tag":77,"slug":136,"description":369,"guide":78,"operations":370},"The account your token belongs to, and revoking a token before it expires.",[371,378],{"operationId":372,"slug":373,"method":141,"path":374,"tag":77,"summary":139,"deprecated":134,"public":134,"permission":375,"scope":376,"order":377},"revokeToken","revoke-token","\u002Fv1\u002Fapi-account\u002Frevoke-token","api\u002F*:$org:$ID","flat",2,{"operationId":379,"slug":380,"method":133,"path":381,"tag":77,"summary":143,"deprecated":134,"public":134,"permission":375,"scope":376,"order":382},"getCurrentApiAccount","get-current-api-account","\u002Fv1\u002Fapi-account\u002Fvalidate-me",3,{"tag":74,"slug":146,"description":384,"guide":75,"operations":385},"Countries, grades and organizations. A student’s `country` and `grade` take these `_id`s, and so does every `:organizationId` in a path.",[386,392,397,403,408,414],{"operationId":387,"slug":388,"method":133,"path":389,"tag":74,"summary":149,"deprecated":134,"public":134,"permission":390,"scope":376,"order":391},"listCountries","list-countries","\u002Fv1\u002Fcountry","country\u002Fread:$org:$ID",4,{"operationId":393,"slug":394,"method":133,"path":395,"tag":74,"summary":152,"deprecated":134,"public":134,"permission":390,"scope":376,"order":396},"getCountry","get-country","\u002Fv1\u002Fcountry\u002F{id}",5,{"operationId":398,"slug":399,"method":133,"path":400,"tag":74,"summary":155,"deprecated":134,"public":134,"permission":401,"scope":376,"order":402},"listGrades","list-grades","\u002Fv1\u002Fgrade","grade\u002Fread:$org:$ID",6,{"operationId":404,"slug":405,"method":133,"path":406,"tag":74,"summary":158,"deprecated":134,"public":134,"permission":401,"scope":376,"order":407},"getGrade","get-grade","\u002Fv1\u002Fgrade\u002F{id}",7,{"operationId":409,"slug":410,"method":133,"path":411,"tag":74,"summary":161,"deprecated":134,"public":134,"permission":412,"scope":376,"order":413},"listOrganizations","list-organizations","\u002Fv1\u002Forganization","organization\u002Fread:$org:$ID",8,{"operationId":415,"slug":416,"method":133,"path":417,"tag":74,"summary":164,"deprecated":134,"public":134,"permission":412,"scope":376,"order":418},"getOrganization","get-organization","\u002Fv1\u002Forganization\u002F{id}",9,{"tag":62,"slug":167,"description":420,"guide":63,"operations":421},"Registering your students, reading and updating them, setting a password, and what each organization holds for them. You only ever see the students your account registered.",[422,428,433,438,443,448,453,458,464,470,475,479],{"operationId":423,"slug":424,"method":133,"path":425,"tag":62,"summary":170,"deprecated":134,"public":134,"permission":426,"scope":376,"order":427},"listStudents","list-students","\u002Fv1\u002Fstudent","student\u002Fread:$org:$ID",10,{"operationId":429,"slug":430,"method":141,"path":425,"tag":62,"summary":173,"deprecated":134,"public":134,"permission":431,"scope":376,"order":432},"registerStudent","register-student","student\u002Fcreate:$org:$ID",11,{"operationId":434,"slug":435,"method":141,"path":436,"tag":62,"summary":176,"deprecated":134,"public":134,"permission":431,"scope":376,"order":437},"checkStudentRegistration","check-student-registration","\u002Fv1\u002Fstudent\u002Fcheck",12,{"operationId":439,"slug":440,"method":141,"path":441,"tag":62,"summary":179,"deprecated":134,"public":134,"permission":431,"scope":376,"order":442},"createStudentImport","create-student-import","\u002Fv1\u002Fstudent\u002Fimport",13,{"operationId":444,"slug":445,"method":133,"path":446,"tag":62,"summary":182,"deprecated":134,"public":134,"permission":431,"scope":376,"order":447},"getStudentImport","get-student-import","\u002Fv1\u002Fstudent\u002Fimport\u002F{importId}",14,{"operationId":449,"slug":450,"method":133,"path":451,"tag":62,"summary":185,"deprecated":134,"public":134,"permission":426,"scope":376,"order":452},"getStudent","get-student","\u002Fv1\u002Fstudent\u002F{studentId}",15,{"operationId":454,"slug":455,"method":190,"path":451,"tag":62,"summary":188,"deprecated":134,"public":134,"permission":456,"scope":376,"order":457},"updateStudent","update-student","student\u002Fupdate:$org:$ID",16,{"operationId":459,"slug":460,"method":190,"path":461,"tag":62,"summary":192,"deprecated":134,"public":134,"permission":462,"scope":376,"order":463},"setStudentPassword","set-student-password","\u002Fv1\u002Fstudent\u002F{studentId}\u002Fpassword","auth\u002Fsignin:$org:$ID",17,{"operationId":465,"slug":466,"method":133,"path":467,"tag":62,"summary":195,"deprecated":134,"public":134,"permission":426,"scope":468,"order":469},"listOrgStudents","list-org-students","\u002Fv1\u002F{organizationId}\u002Fstudent","organization",18,{"operationId":471,"slug":472,"method":133,"path":473,"tag":62,"summary":198,"deprecated":134,"public":134,"permission":426,"scope":468,"order":474},"getOrgStudent","get-org-student","\u002Fv1\u002F{organizationId}\u002Fstudent\u002F{studentId}",19,{"operationId":476,"slug":477,"method":190,"path":473,"tag":62,"summary":201,"deprecated":134,"public":134,"permission":456,"scope":468,"order":478},"updateOrgStudent","update-org-student",20,{"operationId":480,"slug":481,"method":190,"path":482,"tag":62,"summary":204,"deprecated":134,"public":134,"permission":456,"scope":468,"order":483},"linkStudentSupervisor","link-student-supervisor","\u002Fv1\u002F{organizationId}\u002Fstudent\u002F{studentId}\u002Fsupervisor",21,{"tag":80,"slug":207,"description":485,"guide":81,"operations":486},"Links that sign one of your students into an organization’s panel. Each works once and expires two minutes after it is issued.",[487],{"operationId":488,"slug":489,"method":141,"path":490,"tag":80,"summary":210,"deprecated":134,"public":134,"permission":462,"scope":468,"order":491},"createSigninLink","create-signin-link","\u002Fv1\u002F{organizationId}\u002Fauth\u002Fsignin",22,{"tag":83,"slug":213,"description":493,"guide":84,"operations":494},"The exam categories and exams an organization runs, and the ones one of your students can apply to.",[495,501,507,512,517],{"operationId":496,"slug":497,"method":133,"path":498,"tag":83,"summary":216,"deprecated":134,"public":134,"permission":499,"scope":468,"order":500},"listExams","list-exams","\u002Fv1\u002F{organizationId}\u002Fexam","exam\u002Fread:$org:$ID",23,{"operationId":502,"slug":503,"method":133,"path":504,"tag":83,"summary":219,"deprecated":134,"public":134,"permission":505,"scope":468,"order":506},"listExamCategories","list-exam-categories","\u002Fv1\u002F{organizationId}\u002Fexam-category","exam-category\u002Fread:$org:$ID",24,{"operationId":508,"slug":509,"method":133,"path":510,"tag":83,"summary":222,"deprecated":134,"public":134,"permission":505,"scope":468,"order":511},"getExamCategory","get-exam-category","\u002Fv1\u002F{organizationId}\u002Fexam-category\u002F{categoryId}",25,{"operationId":513,"slug":514,"method":133,"path":515,"tag":83,"summary":225,"deprecated":134,"public":134,"permission":499,"scope":468,"order":516},"listAvailableExams","list-available-exams","\u002Fv1\u002F{organizationId}\u002Fexam\u002Favailable\u002F{studentId}",26,{"operationId":518,"slug":519,"method":133,"path":520,"tag":83,"summary":228,"deprecated":134,"public":134,"permission":499,"scope":468,"order":521},"getExam","get-exam","\u002Fv1\u002F{organizationId}\u002Fexam\u002F{examId}",27,{"tag":86,"slug":231,"description":523,"guide":87,"operations":524},"Entering your students for exams: creating, reading, moving and deleting their applications.",[525,531,536,541,546,551,556],{"operationId":526,"slug":527,"method":133,"path":528,"tag":86,"summary":234,"deprecated":134,"public":134,"permission":529,"scope":468,"order":530},"listApplications","list-applications","\u002Fv1\u002F{organizationId}\u002Fapplication","application\u002Fread:$org:$ID",28,{"operationId":532,"slug":533,"method":141,"path":528,"tag":86,"summary":237,"deprecated":134,"public":134,"permission":534,"scope":468,"order":535},"createApplication","create-application","application\u002Fcreate:$org:$ID",29,{"operationId":537,"slug":538,"method":133,"path":539,"tag":86,"summary":240,"deprecated":134,"public":134,"permission":529,"scope":468,"order":540},"listExamApplications","list-exam-applications","\u002Fv1\u002F{organizationId}\u002Fapplication\u002Fexam-applications\u002F{examId}",30,{"operationId":542,"slug":543,"method":133,"path":544,"tag":86,"summary":243,"deprecated":134,"public":134,"permission":529,"scope":468,"order":545},"listStudentApplications","list-student-applications","\u002Fv1\u002F{organizationId}\u002Fapplication\u002Fstudent-applications\u002F{studentId}",31,{"operationId":547,"slug":548,"method":133,"path":549,"tag":86,"summary":246,"deprecated":134,"public":134,"permission":529,"scope":468,"order":550},"getApplication","get-application","\u002Fv1\u002F{organizationId}\u002Fapplication\u002F{applicationId}",32,{"operationId":552,"slug":553,"method":190,"path":549,"tag":86,"summary":249,"deprecated":134,"public":134,"permission":554,"scope":468,"order":555},"moveApplication","move-application","application\u002Fupdate:$org:$ID",33,{"operationId":557,"slug":558,"method":254,"path":549,"tag":86,"summary":252,"deprecated":134,"public":134,"permission":559,"scope":468,"order":560},"deleteApplication","delete-application","application\u002Fdelete:$org:$ID",34,{"tag":256,"slug":257,"description":562,"guide":93,"operations":563},"Your students’ certificates and reports: listing them and downloading the files.",[564,570,575,581],{"operationId":565,"slug":566,"method":133,"path":567,"tag":256,"summary":260,"deprecated":134,"public":134,"permission":568,"scope":468,"order":569},"downloadCertificate","download-certificate","\u002Fv1\u002F{organizationId}\u002Fcertificate\u002Fdownload\u002F{certificateId}","certificate\u002Fread:$org:$ID",35,{"operationId":571,"slug":572,"method":133,"path":573,"tag":256,"summary":263,"deprecated":134,"public":134,"permission":568,"scope":468,"order":574},"listStudentCertificates","list-student-certificates","\u002Fv1\u002F{organizationId}\u002Fcertificate\u002F{userId}",36,{"operationId":576,"slug":577,"method":133,"path":578,"tag":256,"summary":266,"deprecated":134,"public":134,"permission":579,"scope":468,"order":580},"downloadReport","download-report","\u002Fv1\u002F{organizationId}\u002Freport\u002Fdownload\u002F{reportId}","report\u002Fread:$org:$ID",37,{"operationId":582,"slug":583,"method":133,"path":584,"tag":256,"summary":269,"deprecated":134,"public":134,"permission":579,"scope":468,"order":585},"listStudentReports","list-student-reports","\u002Fv1\u002F{organizationId}\u002Freport\u002F{userId}",38,{"tag":89,"slug":272,"description":587,"guide":90,"operations":588},"Online group challenges your students take part in: the challenges, which of your students can join, the groups they are in, each step and its files, what happened in a group, and submitting on your student’s behalf.",[589,595,600,605,610,615,621,626,631],{"operationId":590,"slug":591,"method":133,"path":592,"tag":89,"summary":275,"deprecated":134,"public":134,"permission":593,"scope":468,"order":594},"listGroupChallenges","list-group-challenges","\u002Fv1\u002F{organizationId}\u002Fgroup-challenge","group-challenge\u002Fread:$org:$ID",39,{"operationId":596,"slug":597,"method":133,"path":598,"tag":89,"summary":278,"deprecated":134,"public":134,"permission":593,"scope":468,"order":599},"getGroupChallenge","get-group-challenge","\u002Fv1\u002F{organizationId}\u002Fgroup-challenge\u002F{challengeId}",40,{"operationId":601,"slug":602,"method":133,"path":603,"tag":89,"summary":281,"deprecated":134,"public":134,"permission":593,"scope":468,"order":604},"listGroupChallengeGroups","list-group-challenge-groups","\u002Fv1\u002F{organizationId}\u002Fgroup-challenge\u002F{challengeId}\u002Fgroup",41,{"operationId":606,"slug":607,"method":133,"path":608,"tag":89,"summary":284,"deprecated":134,"public":134,"permission":593,"scope":468,"order":609},"getGroupChallengeGroup","get-group-challenge-group","\u002Fv1\u002F{organizationId}\u002Fgroup-challenge\u002F{challengeId}\u002Fgroup\u002F{groupId}",42,{"operationId":611,"slug":612,"method":133,"path":613,"tag":89,"summary":287,"deprecated":134,"public":134,"permission":593,"scope":468,"order":614},"listGroupChallengeActivity","list-group-challenge-activity","\u002Fv1\u002F{organizationId}\u002Fgroup-challenge\u002F{challengeId}\u002Fgroup\u002F{groupId}\u002Factivity",43,{"operationId":616,"slug":617,"method":141,"path":618,"tag":89,"summary":290,"deprecated":134,"public":134,"permission":619,"scope":468,"order":620},"submitGroupChallengeWork","submit-group-challenge-work","\u002Fv1\u002F{organizationId}\u002Fgroup-challenge\u002F{challengeId}\u002Fgroup\u002F{groupId}\u002Ffinal-submit","group-challenge\u002Fsubmit:$org:$ID",44,{"operationId":622,"slug":623,"method":141,"path":624,"tag":89,"summary":293,"deprecated":134,"public":134,"permission":619,"scope":468,"order":625},"submitGroupChallengeStep","submit-group-challenge-step","\u002Fv1\u002F{organizationId}\u002Fgroup-challenge\u002F{challengeId}\u002Fgroup\u002F{groupId}\u002Fstep\u002F{stepId}\u002Fsubmit",45,{"operationId":627,"slug":628,"method":133,"path":629,"tag":89,"summary":296,"deprecated":134,"public":134,"permission":593,"scope":468,"order":630},"listGroupChallengeStudents","list-group-challenge-students","\u002Fv1\u002F{organizationId}\u002Fgroup-challenge\u002F{challengeId}\u002Fstudent",46,{"operationId":632,"slug":633,"method":133,"path":634,"tag":89,"summary":299,"deprecated":134,"public":134,"permission":593,"scope":468,"order":635},"getGroupChallengeStudent","get-group-challenge-student","\u002Fv1\u002F{organizationId}\u002Fgroup-challenge\u002F{challengeId}\u002Fstudent\u002F{studentId}",47,{"operationId":361,"slug":362,"method":133,"path":363,"tag":127,"summary":131,"deprecated":134,"public":364,"permission":365,"scope":366,"order":367,"description":637,"permissions":638,"errors":639,"guide":365,"parameters":640,"requestBody":365,"responses":641,"successStatus":703,"kind":704,"paginated":134,"baseUrl":355,"tagDescription":358,"sandbox":364},"Answers `200` with `data.status` `ok` whenever the service is running. It needs no token and is not counted against your account’s rate limit, so it is the first call to make against an environment.\n\nIt says only that the service answers: it checks nothing the other operations depend on, so one of them can still fail while this answers `ok`.",[],[],[],{"200":642},{"content":643,"description":702},{"application\u002Fjson":644},{"schema":645},{"allOf":646},[647,687],{"x-ref":648,"description":649,"properties":650,"required":684,"type":682},"#\u002Fcomponents\u002Fschemas\u002FSuccessEnvelope","How every successful JSON response is wrapped. `data` is the result, and each operation declares its shape; list operations add `pagination`. `GET \u002Fv1\u002Fapi-account\u002Fvalidate-me` is the one operation that answers without this envelope.",{"success":651,"message":655,"pagination":659},{"description":652,"enum":653,"example":364,"type":654},"Always `true` on a success.",[364],"boolean",{"description":656,"example":657,"type":658},"A sentence saying what happened, written for a person. Branch on the status and on `data`, not on this.","Request completed successfully.","string",{"allOf":660,"description":683},[661],{"x-ref":662,"description":663,"properties":664,"required":677,"type":682},"#\u002Fcomponents\u002Fschemas\u002FPaginationMeta","Where one page sits in the whole list.",{"page":665,"limit":668,"total":671,"totalPages":675},{"description":666,"example":367,"minimum":367,"type":667},"The page returned, counting from 1.","number",{"description":669,"example":478,"maximum":670,"minimum":367,"type":667},"Items per page: the `limit` you sent, 20 if you sent none, and never more than 100.",100,{"description":672,"example":673,"minimum":674,"type":667},"Items across every page.",57,0,{"description":676,"example":382,"minimum":674,"type":667},"Pages at this `limit`: `total \u002F limit`, rounded up.",[678,679,680,681],"page","limit","total","totalPages","object","On list operations only.",[685,686],"success","message",{"properties":688,"required":700,"type":682},{"message":689,"data":690},{"example":657,"type":658},{"x-ref":691,"description":692,"properties":693,"required":698,"type":682},"#\u002Fcomponents\u002Fschemas\u002FHealthResponse","The service is up.",{"status":694},{"description":695,"enum":696,"example":697,"type":658},"Always `ok`: the service is running and answering. It says nothing about any particular operation.",[697],"ok",[699],"status",[701],"data","Success: `message` is \"Request completed successfully.\".","200","envelope",{"path":26},{"id":707,"title":131,"apiPath":363,"body":708,"deprecated":134,"description":1109,"extension":1110,"meta":1111,"method":133,"navigation":364,"operationId":361,"order":1112,"path":132,"permission":365,"public":364,"seo":1113,"stem":1114,"summary":131,"tag":127,"__hash__":1115},"apiReference\u002Fapi\u002Freference\u002Fget-health.md",{"type":709,"value":710,"toc":1107},"minimark",[711,1103],[712,713,714,740,876],"api-code-group",{},[715,716,722],"pre",{"className":717,"code":718,"filename":719,"language":720,"meta":721,"style":721},"language-bash shiki shiki-themes github-light-high-contrast github-dark-high-contrast","curl -sS 'https:\u002F\u002Fapi.main-team.org\u002Fv1\u002Fhealth'\n","curl","bash","",[723,724,725],"code",{"__ignoreMap":721},[726,727,729,732,736],"span",{"class":728,"line":367},"line",[726,730,719],{"class":731},"soyes",[726,733,735],{"class":734},"s-5SL"," -sS",[726,737,739],{"class":738},"sT6z2"," 'https:\u002F\u002Fapi.main-team.org\u002Fv1\u002Fhealth'\n",[715,741,745],{"className":742,"code":743,"filename":308,"language":744,"meta":721,"style":721},"language-js shiki shiki-themes github-light-high-contrast github-dark-high-contrast","const res = await fetch('https:\u002F\u002Fapi.main-team.org\u002Fv1\u002Fhealth');\nconst body = await res.json();\nif (!res.ok) throw new Error(`${res.status} ${body.error.code}: ${body.error.message}`);\nconsole.log(body.data);\n","js",[723,746,747,776,796,865],{"__ignoreMap":721},[726,748,749,753,756,759,762,766,770,773],{"class":728,"line":367},[726,750,752],{"class":751},"sHUrx","const",[726,754,755],{"class":734}," res",[726,757,758],{"class":751}," =",[726,760,761],{"class":751}," await",[726,763,765],{"class":764},"sKwhi"," fetch",[726,767,769],{"class":768},"suds8","(",[726,771,772],{"class":738},"'https:\u002F\u002Fapi.main-team.org\u002Fv1\u002Fhealth'",[726,774,775],{"class":768},");\n",[726,777,778,780,783,785,787,790,793],{"class":728,"line":377},[726,779,752],{"class":751},[726,781,782],{"class":734}," body",[726,784,758],{"class":751},[726,786,761],{"class":751},[726,788,789],{"class":768}," res.",[726,791,792],{"class":764},"json",[726,794,795],{"class":768},"();\n",[726,797,798,801,804,807,810,813,816,819,821,824,827,830,832,835,838,840,843,845,847,850,852,854,856,858,860,863],{"class":728,"line":382},[726,799,800],{"class":751},"if",[726,802,803],{"class":768}," (",[726,805,806],{"class":751},"!",[726,808,809],{"class":768},"res.ok) ",[726,811,812],{"class":751},"throw",[726,814,815],{"class":751}," new",[726,817,818],{"class":764}," Error",[726,820,769],{"class":768},[726,822,823],{"class":738},"`${",[726,825,826],{"class":768},"res",[726,828,829],{"class":738},".",[726,831,699],{"class":768},[726,833,834],{"class":738},"} ${",[726,836,837],{"class":768},"body",[726,839,829],{"class":738},[726,841,842],{"class":768},"error",[726,844,829],{"class":738},[726,846,723],{"class":768},[726,848,849],{"class":738},"}: ${",[726,851,837],{"class":768},[726,853,829],{"class":738},[726,855,842],{"class":768},[726,857,829],{"class":738},[726,859,686],{"class":768},[726,861,862],{"class":738},"}`",[726,864,775],{"class":768},[726,866,867,870,873],{"class":728,"line":391},[726,868,869],{"class":768},"console.",[726,871,872],{"class":764},"log",[726,874,875],{"class":768},"(body.data);\n",[715,877,881],{"className":878,"code":879,"filename":311,"language":880,"meta":721,"style":721},"language-php shiki shiki-themes github-light-high-contrast github-dark-high-contrast","\u003C?php\n$ch = curl_init('https:\u002F\u002Fapi.main-team.org\u002Fv1\u002Fhealth');\ncurl_setopt_array($ch, [\n    CURLOPT_RETURNTRANSFER => true,\n]);\n$response = curl_exec($ch);\nif ($response === false) {\n    throw new RuntimeException(curl_error($ch));\n}\n$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);\n$body = json_decode($response, true);\nif ($status >= 400) {\n    $error = $body['error'];\n    throw new RuntimeException(\"$status {$error['code']}: {$error['message']}\");\n}\nprint_r($body['data']);\n","php",[723,882,883,891,908,916,930,935,948,964,982,987,1005,1023,1038,1054,1086,1090],{"__ignoreMap":721},[726,884,885,888],{"class":728,"line":367},[726,886,887],{"class":751},"\u003C?",[726,889,890],{"class":734},"php\n",[726,892,893,896,899,902,904,906],{"class":728,"line":377},[726,894,895],{"class":768},"$ch ",[726,897,898],{"class":751},"=",[726,900,901],{"class":734}," curl_init",[726,903,769],{"class":768},[726,905,772],{"class":738},[726,907,775],{"class":768},[726,909,910,913],{"class":728,"line":382},[726,911,912],{"class":734},"curl_setopt_array",[726,914,915],{"class":768},"($ch, [\n",[726,917,918,921,924,927],{"class":728,"line":391},[726,919,920],{"class":734},"    CURLOPT_RETURNTRANSFER",[726,922,923],{"class":751}," =>",[726,925,926],{"class":734}," true",[726,928,929],{"class":768},",\n",[726,931,932],{"class":728,"line":396},[726,933,934],{"class":768},"]);\n",[726,936,937,940,942,945],{"class":728,"line":402},[726,938,939],{"class":768},"$response ",[726,941,898],{"class":751},[726,943,944],{"class":734}," curl_exec",[726,946,947],{"class":768},"($ch);\n",[726,949,950,952,955,958,961],{"class":728,"line":407},[726,951,800],{"class":751},[726,953,954],{"class":768}," ($response ",[726,956,957],{"class":751},"===",[726,959,960],{"class":734}," false",[726,962,963],{"class":768},") {\n",[726,965,966,969,971,974,976,979],{"class":728,"line":413},[726,967,968],{"class":751},"    throw",[726,970,815],{"class":751},[726,972,973],{"class":734}," RuntimeException",[726,975,769],{"class":768},[726,977,978],{"class":734},"curl_error",[726,980,981],{"class":768},"($ch));\n",[726,983,984],{"class":728,"line":418},[726,985,986],{"class":768},"}\n",[726,988,989,992,994,997,1000,1003],{"class":728,"line":427},[726,990,991],{"class":768},"$status ",[726,993,898],{"class":751},[726,995,996],{"class":734}," curl_getinfo",[726,998,999],{"class":768},"($ch, ",[726,1001,1002],{"class":734},"CURLINFO_RESPONSE_CODE",[726,1004,775],{"class":768},[726,1006,1007,1010,1012,1015,1018,1021],{"class":728,"line":432},[726,1008,1009],{"class":768},"$body ",[726,1011,898],{"class":751},[726,1013,1014],{"class":734}," json_decode",[726,1016,1017],{"class":768},"($response, ",[726,1019,1020],{"class":734},"true",[726,1022,775],{"class":768},[726,1024,1025,1027,1030,1033,1036],{"class":728,"line":437},[726,1026,800],{"class":751},[726,1028,1029],{"class":768}," ($status ",[726,1031,1032],{"class":751},">=",[726,1034,1035],{"class":734}," 400",[726,1037,963],{"class":768},[726,1039,1040,1043,1045,1048,1051],{"class":728,"line":442},[726,1041,1042],{"class":768},"    $error ",[726,1044,898],{"class":751},[726,1046,1047],{"class":768}," $body[",[726,1049,1050],{"class":738},"'error'",[726,1052,1053],{"class":768},"];\n",[726,1055,1056,1058,1060,1062,1064,1067,1070,1073,1076,1079,1081,1084],{"class":728,"line":447},[726,1057,968],{"class":751},[726,1059,815],{"class":751},[726,1061,973],{"class":734},[726,1063,769],{"class":768},[726,1065,1066],{"class":738},"\"",[726,1068,1069],{"class":768},"$status",[726,1071,1072],{"class":738}," {",[726,1074,1075],{"class":768},"$error",[726,1077,1078],{"class":738},"['code']}: {",[726,1080,1075],{"class":768},[726,1082,1083],{"class":738},"['message']}\"",[726,1085,775],{"class":768},[726,1087,1088],{"class":728,"line":452},[726,1089,986],{"class":768},[726,1091,1092,1095,1098,1101],{"class":728,"line":457},[726,1093,1094],{"class":734},"print_r",[726,1096,1097],{"class":768},"($body[",[726,1099,1100],{"class":738},"'data'",[726,1102,934],{"class":768},[1104,1105,1106],"style",{},"html pre.shiki code .soyes, html code.shiki .soyes{--shiki-default:#702C00;--shiki-dark:#FFB757}html pre.shiki code .s-5SL, html code.shiki .s-5SL{--shiki-default:#023B95;--shiki-dark:#91CBFF}html pre.shiki code .sT6z2, html code.shiki .sT6z2{--shiki-default:#032563;--shiki-dark:#ADDCFF}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);}html pre.shiki code .sHUrx, html code.shiki .sHUrx{--shiki-default:#A0111F;--shiki-dark:#FF9492}html pre.shiki code .sKwhi, html code.shiki .sKwhi{--shiki-default:#622CBC;--shiki-dark:#DBB7FF}html pre.shiki code .suds8, html code.shiki .suds8{--shiki-default:#0E1116;--shiki-dark:#F0F3F6}",{"title":721,"searchDepth":377,"depth":382,"links":1108},[],"Answers 200 with data.status ok whenever the service is running.","md",{},"1",{"title":131,"description":1109},"api\u002Freference\u002Fget-health","qB9-o2FMGc2cKrFa8GpF-a6qwT5GTTgJLM28mCFXWuc",1791554613399]