{
"error": "Field is required.",
"name": "interview_result_id"
}
{
"error": "Field is required.",
"name": "interview_result_id"
}
{
"error": "Field is required.",
"name": "interview_result_id"
}
{
"error": "Field is required.",
"name": "interview_result_id"
}
{
"error": "Field is required.",
"name": "interview_result_id"
}
Candidates
Get a candidate
One candidate as the admin’s candidate page shows it: profile, applications with their steps, stand-alone interview results, tags, counts and the duplicate flag; with include, also notes, duplicates, document requests, tasks and segments. Applications to positions hidden from you (position access) are left out; a candidate hidden from you is not found. Recorded in the audit log as a view of the candidate.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"JobMojito Developer / Agent","description":"AI Interview and assessment conversational platform documentation","colors":{"primary":"#639C42","light":"#ACCC37","dark":"#15803D"},"logo":{"light":"https://mintcdn.com/jobmojito/DU7xAw61G9kqV1zG/images/jobmojito-light.svg?fit=max\u0026auto=format\u0026n=DU7xAw61G9kqV1zG\u0026q=85\u0026s=6c00cb5f3104ffb6325dacc0818bba69","dark":"https://mintcdn.com/jobmojito/DU7xAw61G9kqV1zG/images/jobmojito-dark.svg?fit=max\u0026auto=format\u0026n=DU7xAw61G9kqV1zG\u0026q=85\u0026s=a05ab0ca109d7a225b08ccac00f9c486","href":"https://jobmojito.com"},"favicon":{"light":"https://mintcdn.com/jobmojito/DU7xAw61G9kqV1zG/images/favicon-light.svg?fit=max\u0026auto=format\u0026n=DU7xAw61G9kqV1zG\u0026q=85\u0026s=f300813ab120824238a790b6905dceee","dark":"https://mintcdn.com/jobmojito/DU7xAw61G9kqV1zG/images/favicon-dark.svg?fit=max\u0026auto=format\u0026n=DU7xAw61G9kqV1zG\u0026q=85\u0026s=2104ff9e7b9fd23fbe5954886c0aafbe"},"navbar":{"links":[{"href":"https://jobmojito.com/support","label":"Support"},{"href":"https://jobmojito.com","label":"Homepage"},{"href":"https://app.jobmojito.com","label":"App"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.mintlify.com"}},"footer":{"socials":{"linkedin":"https://linkedin.com/company/jobmojito"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"toc"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"jobmojito","hasAudioNarration":false,"actualSubdomain":"jobmojito","customDomains":["developer.jobmojito.com"],"gitSource":{"type":"github","owner":"mintlify-community","repo":"docs-jobmojito-fee23398","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6af1dfb6ee06d45cdd87d014","clientVersion":"0.0.4094","searchFilterCounts":[{"language":"default","tag":"API Reference","count":82},{"language":"default","tag":"Admin","count":19},{"language":"default","tag":"Cookbooks","count":17},{"language":"default","tag":"Webhooks","count":14},{"language":"default","tag":"MCP","count":13},{"language":"default","tag":"Candidates","count":12},{"language":"default","tag":"Interviews","count":10},{"language":"default","tag":"Connect","count":8},{"language":"default","tag":"Reports","count":7},{"language":"default","tag":"Results","count":7}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/candidates/get-a-candidate","slug":"/api-reference/candidates/get-a-candidate","pageMetadata":{"title":"Get a candidate","description":"One candidate as the admin's candidate page shows it: profile, applications with their steps, stand-alone interview results, tags, counts and the duplicate flag; with include, also notes, duplicates, document requests, tasks and segments. Applications to positions hidden from you (position access) are left out; a candidate hidden from you is not found. Recorded in the audit log as a view of the candidate.","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi get /merchant-candidate-get","href":"/api-reference/candidates/get-a-candidate","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"One candidate as the admin’s candidate page shows it: profile, applications with their steps, stand-alone interview results, tags, counts and the duplicate flag; with include, also notes, duplicates, document requests, tasks and segments. Applications to positions hidden from you (position access) are left out; a candidate hidden from you is not found. Recorded in the audit log as a view of the candidate.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Get a candidate","description":"One candidate as the admin's candidate page shows it: profile, applications with their steps, stand-alone interview results, tags, counts and the duplicate flag; with include, also notes, duplicates, document requests, tasks and segments. Applications to positions hidden from you (position access) are left out; a candidate hidden from you is not found. Recorded in the audit log as a view of the candidate.","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi get /merchant-candidate-get","href":"/api-reference/candidates/get-a-candidate","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Candidates"],"summary":"Get a candidate","description":"One candidate as the admin's candidate page shows it: profile, applications with their steps, stand-alone interview results, tags, counts and the duplicate flag; with include, also notes, duplicates, document requests, tasks and segments. Applications to positions hidden from you (position access) are left out; a candidate hidden from you is not found. Recorded in the audit log as a view of the candidate.","security":["0910cff1-fb77-4878-84e6-53f4a3666867"],"parameters":["2b3e80ce-7d72-461e-b5f8-1cda8127d5e7","9e35f10b-c7c2-4d3b-a8b1-658f5824803a"],"responses":{"200":"969896f0-6128-46f1-97b6-afbefd8f70c0","401":"453375ed-2275-47c1-8d55-c2b197b4a5b2","403":"265f75a4-6b68-4912-b957-7b45834e6ac4","404":"ee62b2a6-8d5e-4c55-9289-61076030adca","422":"e1de38dd-a563-428c-ac1e-3bdf4be7fd02","500":"071f0c7c-089f-494d-acd5-29c0218dcf54"},"method":"get","type":"path","servers":["454fcb62-7052-4847-a728-ecf5ade065a6"],"path":"/merchant-candidate-get","baseUrlOptions":["https://cool.jobmojito.com/functions/v1"],"title":"Get a candidate","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"2b3e80ce-7d72-461e-b5f8-1cda8127d5e7":{"schema":{"type":"string","format":"uuid","description":"Candidate id (profile_interview.id).","isRequired":true,"uniqueKey":"","typeLabel":"string\u003cuuid>"},"required":true,"name":"candidate_id","in":"query"},"9e35f10b-c7c2-4d3b-a8b1-658f5824803a":{"schema":{"type":"string","description":"Comma list of extra sections: notes, duplicates, documents, tasks, segments. Default: none of them.","example":"notes,tasks","isRequired":false,"uniqueKey":"","typeLabel":"string"},"required":false,"name":"include","in":"query"}},"responses":{"969896f0-6128-46f1-97b6-afbefd8f70c0":{"description":"The candidate.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","description":"Candidate id (profile_interview.id).","isRequired":true,"uniqueKey":"data.id","typeLabel":"string"},"merchant_id":{"type":"string","description":"The company (merchant.id).","isRequired":true,"uniqueKey":"data.merchant_id","typeLabel":"string"},"status":{"type":"string","description":"Record state: active, draft or archived.","isRequired":true,"uniqueKey":"data.status","typeLabel":"string"},"applications":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Application id (position_result.id).","isRequired":true,"uniqueKey":"data.applications.items.[INDEX].id","typeLabel":"string"},"position_id":{"type":"string","description":"Position id (position_def_set.id).","isRequired":true,"uniqueKey":"data.applications.items.[INDEX].position_id","typeLabel":"string"},"position_name":{"type":"string","description":"Position name.","uniqueKey":"data.applications.items.[INDEX].position_name","typeLabel":"string"},"status":{"type":"string","description":"Application state: draft, active, archived, deleted, preparing or completed.","uniqueKey":"data.applications.items.[INDEX].status","typeLabel":"string"},"decision_status":{"type":"string","description":"Decision: recruiter_accept, recruiter_reject, recruiter_action, ai_accept, ai_reject, candidate_action or processing.","uniqueKey":"data.applications.items.[INDEX].decision_status","typeLabel":"string"},"outcome":{"type":"string","description":"Outcome: pending, hired or declined.","uniqueKey":"data.applications.items.[INDEX].outcome","typeLabel":"string"},"outcome_at":{"type":"string","description":"When the outcome was set (ISO 8601).","uniqueKey":"data.applications.items.[INDEX].outcome_at","typeLabel":"string"},"decision_reason_id":{"type":"string","description":"Decision reason id (from merchant-reason-list).","uniqueKey":"data.applications.items.[INDEX].decision_reason_id","typeLabel":"string"},"decision_reason_note":{"type":"string","description":"Note on the decision.","uniqueKey":"data.applications.items.[INDEX].decision_reason_note","typeLabel":"string"},"withdrawn_at":{"type":"string","description":"When the application was withdrawn (ISO 8601).","uniqueKey":"data.applications.items.[INDEX].withdrawn_at","typeLabel":"string"},"assigned_profile_id":{"type":"string","description":"Recruiter assigned to the application (profile.id).","uniqueKey":"data.applications.items.[INDEX].assigned_profile_id","typeLabel":"string"},"is_test":{"type":"boolean","description":"A test application.","uniqueKey":"data.applications.items.[INDEX].is_test","typeLabel":"boolean"},"current_step_id":{"type":"string","description":"The current step (position_result_step.id).","uniqueKey":"data.applications.items.[INDEX].current_step_id","typeLabel":"string"},"created_at":{"type":"string","description":"Applied (ISO 8601).","uniqueKey":"data.applications.items.[INDEX].created_at","typeLabel":"string"},"updated_at":{"type":"string","description":"Last changed (ISO 8601).","uniqueKey":"data.applications.items.[INDEX].updated_at","typeLabel":"string"},"steps":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Application step id (position_result_step.id).","isRequired":true,"uniqueKey":"data.applications.items.[INDEX].steps.items.[INDEX].id","typeLabel":"string"},"position_step_id":{"type":"string","description":"Position step id (position_def_step.id).","uniqueKey":"data.applications.items.[INDEX].steps.items.[INDEX].position_step_id","typeLabel":"string"},"name":{"type":"string","description":"Step name (the step type when unnamed).","uniqueKey":"data.applications.items.[INDEX].steps.items.[INDEX].name","typeLabel":"string"},"type":{"type":"string","description":"Step type: pre-screening, interview, invited, meeting, external_assessment or certo_verification.","uniqueKey":"data.applications.items.[INDEX].steps.items.[INDEX].type","typeLabel":"string"},"sequence_no":{"type":"number","description":"Order in the process.","uniqueKey":"data.applications.items.[INDEX].steps.items.[INDEX].sequence_no","typeLabel":"number"},"status":{"type":"string","description":"Step state: draft, active, archived, deleted, preparing or completed.","uniqueKey":"data.applications.items.[INDEX].steps.items.[INDEX].status","typeLabel":"string"},"decision_status":{"type":"string","description":"Decision: recruiter_accept, recruiter_reject, recruiter_action, ai_accept, ai_reject, candidate_action or processing.","uniqueKey":"data.applications.items.[INDEX].steps.items.[INDEX].decision_status","typeLabel":"string"},"processing_status":{"type":"string","description":"Analysis state: new, processing, completed or failed.","uniqueKey":"data.applications.items.[INDEX].steps.items.[INDEX].processing_status","typeLabel":"string"},"decision_reason_id":{"type":"string","description":"Decision reason id (from merchant-reason-list).","uniqueKey":"data.applications.items.[INDEX].steps.items.[INDEX].decision_reason_id","typeLabel":"string"},"skipped_at":{"type":"string","description":"When the step was skipped (ISO 8601).","uniqueKey":"data.applications.items.[INDEX].steps.items.[INDEX].skipped_at","typeLabel":"string"},"interview_result_id":{"type":"string","description":"Interview result of the step (interview_result.id).","uniqueKey":"data.applications.items.[INDEX].steps.items.[INDEX].interview_result_id","typeLabel":"string"},"pre_screening_id":{"type":"string","description":"Pre-screening of the step (interview_result_pre_screening.id).","uniqueKey":"data.applications.items.[INDEX].steps.items.[INDEX].pre_screening_id","typeLabel":"string"},"created_at":{"type":"string","description":"When the candidate reached the step (ISO 8601).","uniqueKey":"data.applications.items.[INDEX].steps.items.[INDEX].created_at","typeLabel":"string"}},"required":["id"],"uniqueKey":"data.applications.items.[INDEX].steps.items.[INDEX]","typeLabel":"object"},"description":"The steps reached, in process order.","uniqueKey":"data.applications.items.[INDEX].steps","typeLabel":"object[]"}},"required":["id","position_id"],"uniqueKey":"data.applications.items.[INDEX]","typeLabel":"object"},"description":"Applications to positions visible to you, newest first.","isRequired":true,"uniqueKey":"data.applications","typeLabel":"object[]"},"interviews":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Interview result id (interview_result.id).","isRequired":true,"uniqueKey":"data.interviews.items.[INDEX].id","typeLabel":"string"},"interview_id":{"type":"string","description":"Interview id (interview_def_set.id).","uniqueKey":"data.interviews.items.[INDEX].interview_id","typeLabel":"string"},"interview_name":{"type":"string","description":"Interview name.","uniqueKey":"data.interviews.items.[INDEX].interview_name","typeLabel":"string"},"type":{"type":"string","description":"interview, assessment, persona_interview or public_avatar.","uniqueKey":"data.interviews.items.[INDEX].type","typeLabel":"string"},"status":{"type":"string","description":"Record state: active, draft, archived or deleted.","uniqueKey":"data.interviews.items.[INDEX].status","typeLabel":"string"},"processing_status":{"type":"string","description":"Analysis state: new, processing, completed or failed.","uniqueKey":"data.interviews.items.[INDEX].processing_status","typeLabel":"string"},"score":{"type":"number","description":"Score.","uniqueKey":"data.interviews.items.[INDEX].score","typeLabel":"number"},"recruiter_go_next_round":{"type":"boolean","description":"The recruiter decision: true next round, false rejected.","uniqueKey":"data.interviews.items.[INDEX].recruiter_go_next_round","typeLabel":"boolean"},"outcome":{"type":"string","description":"Outcome: pending, hired or declined.","uniqueKey":"data.interviews.items.[INDEX].outcome","typeLabel":"string"},"decision_reason_id":{"type":"string","description":"Decision reason id (from merchant-reason-list).","uniqueKey":"data.interviews.items.[INDEX].decision_reason_id","typeLabel":"string"},"is_test":{"type":"boolean","description":"A test result.","uniqueKey":"data.interviews.items.[INDEX].is_test","typeLabel":"boolean"},"created_at":{"type":"string","description":"Started (ISO 8601).","uniqueKey":"data.interviews.items.[INDEX].created_at","typeLabel":"string"}},"required":["id"],"uniqueKey":"data.interviews.items.[INDEX]","typeLabel":"object"},"description":"Stand-alone interview results (not part of an application), newest first.","isRequired":true,"uniqueKey":"data.interviews","typeLabel":"object[]"},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Tag id (profile_interview_tag.id).","isRequired":true,"uniqueKey":"data.tags.items.[INDEX].id","typeLabel":"string"},"name":{"type":"string","description":"Tag name.","isRequired":true,"uniqueKey":"data.tags.items.[INDEX].name","typeLabel":"string"},"color":{"type":"string","enum":["default","accent","success","warning","danger"],"description":"Tag colour: default, accent, success, warning or danger.","isRequired":true,"uniqueKey":"data.tags.items.[INDEX].color","typeLabel":"enum\u003cstring>"}},"required":["id","name","color"],"uniqueKey":"data.tags.items.[INDEX]","typeLabel":"object"},"description":"Tags on the candidate.","isRequired":true,"uniqueKey":"data.tags","typeLabel":"object[]"},"auto_tags":{"type":"array","items":{"type":"string","uniqueKey":"data.auto_tags.items.[INDEX]","typeLabel":"string"},"description":"Automatic tags (recent_applicant, completed_interview, no_show, inactive_90d, previous_applicant, prospect, possible_duplicate, careers_chat_lead).","isRequired":true,"uniqueKey":"data.auto_tags","typeLabel":"string[]"},"counts":{"type":"object","properties":{"notes":{"type":"integer","description":"Notes you can read: on the candidate, its visible interview results and pre-screenings.","isRequired":true,"uniqueKey":"data.counts.notes","typeLabel":"integer"},"segments":{"type":"integer","description":"Saved segments the candidate is in.","isRequired":true,"uniqueKey":"data.counts.segments","typeLabel":"integer"},"open_tasks":{"type":"integer","description":"Open tasks you can see (the tasks feature).","uniqueKey":"data.counts.open_tasks","typeLabel":"integer"},"open_document_requests":{"type":"integer","description":"Open document requests (the document_requests feature).","uniqueKey":"data.counts.open_document_requests","typeLabel":"integer"}},"required":["notes","segments"],"description":"Counts.","isRequired":true,"uniqueKey":"data.counts","typeLabel":"object"},"profile_id":{"type":"string","description":"The candidate's platform account (profile.id), when linked.","uniqueKey":"data.profile_id","typeLabel":"string"},"name":{"type":"string","description":"Name.","uniqueKey":"data.name","typeLabel":"string"},"email":{"type":"string","description":"Contact e-mail.","uniqueKey":"data.email","typeLabel":"string"},"email_auth":{"type":"string","description":"Sign-in e-mail.","uniqueKey":"data.email_auth","typeLabel":"string"},"phone_number":{"type":"string","description":"Phone number.","uniqueKey":"data.phone_number","typeLabel":"string"},"emoji":{"type":"string","description":"Emoji marker.","uniqueKey":"data.emoji","typeLabel":"string"},"external_id":{"type":"string","description":"Id in the company's own or ATS system.","uniqueKey":"data.external_id","typeLabel":"string"},"linked_in":{"type":"string","description":"LinkedIn URL.","uniqueKey":"data.linked_in","typeLabel":"string"},"physical_address":{"type":"string","description":"Address.","uniqueKey":"data.physical_address","typeLabel":"string"},"mojito_language_code":{"type":"string","description":"Platform language code.","uniqueKey":"data.mojito_language_code","typeLabel":"string"},"avatar_url":{"type":"string","description":"Avatar image URL.","uniqueKey":"data.avatar_url","typeLabel":"string"},"avatar_local_path":{"type":"string","description":"Avatar storage path.","uniqueKey":"data.avatar_local_path","typeLabel":"string"},"time_zone":{"type":"string","description":"IANA time zone.","uniqueKey":"data.time_zone","typeLabel":"string"},"skills":{"type":"array","items":{"type":"string","uniqueKey":"data.skills.items.[INDEX]","typeLabel":"string"},"description":"Skills read from the latest CV.","uniqueKey":"data.skills","typeLabel":"string[]"},"last_login_at":{"type":"string","description":"Last sign-in (ISO 8601).","uniqueKey":"data.last_login_at","typeLabel":"string"},"created_at":{"type":"string","description":"Created (ISO 8601).","uniqueKey":"data.created_at","typeLabel":"string"},"updated_at":{"type":"string","description":"Last changed (ISO 8601).","uniqueKey":"data.updated_at","typeLabel":"string"},"source_channel":{"type":"string","description":"First-touch channel (linkedin, indeed, referral, sourced, ...; untracked when unknown).","uniqueKey":"data.source_channel","typeLabel":"string"},"is_prospect":{"type":"boolean","description":"Sourced and never applied (prospects feature; left out when it is off).","uniqueKey":"data.is_prospect","typeLabel":"boolean"},"owner_profile_ids":{"type":"array","items":{"type":"string","uniqueKey":"data.owner_profile_ids.items.[INDEX]","typeLabel":"string"},"description":"Recruiters owning the candidate's visible applications (profile.id; the candidate_assignment feature).","uniqueKey":"data.owner_profile_ids","typeLabel":"string[]"},"custom_fields":{"type":"object","additionalProperties":{"oneOf":[{},{"type":"null","uniqueKey":"data.custom_fields.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.custom_fields.additionalProperties","typeLabel":"null"},"description":"Company-defined candidate fields (key: value; the custom_fields feature).","uniqueKey":"data.custom_fields","typeLabel":"object"},"duplicate_flag":{"type":"object","properties":{"open_count":{"type":"integer","description":"Open possible duplicates.","isRequired":true,"uniqueKey":"data.duplicate_flag.open_count","typeLabel":"integer"},"top_score":{"type":"number","description":"Highest match score.","uniqueKey":"data.duplicate_flag.top_score","typeLabel":"number"}},"required":["open_count"],"description":"Open possible duplicates (the duplicate_detection feature; left out when none).","uniqueKey":"data.duplicate_flag","typeLabel":"object"},"notes":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Note id (interview_result_comments.id or interview_result_pre_screening_comments.id).","isRequired":true,"uniqueKey":"data.notes.items.[INDEX].id","typeLabel":"string"},"target":{"type":"string","enum":["candidate","result","pre_screening"],"description":"What the note is on: the candidate, an interview result or a pre-screening.","isRequired":true,"uniqueKey":"data.notes.items.[INDEX].target","typeLabel":"enum\u003cstring>"},"visibility":{"type":"string","enum":["team","private"],"description":"team: the company sees it; private: only its author.","isRequired":true,"uniqueKey":"data.notes.items.[INDEX].visibility","typeLabel":"enum\u003cstring>"},"result_id":{"type":"string","description":"Interview result id (interview_result.id), for target result.","uniqueKey":"data.notes.items.[INDEX].result_id","typeLabel":"string"},"pre_screening_id":{"type":"string","description":"Pre-screening id (interview_result_pre_screening.id), for target pre_screening.","uniqueKey":"data.notes.items.[INDEX].pre_screening_id","typeLabel":"string"},"text":{"type":"string","description":"The note.","uniqueKey":"data.notes.items.[INDEX].text","typeLabel":"string"},"author_profile_id":{"type":"string","description":"Author (profile.id).","uniqueKey":"data.notes.items.[INDEX].author_profile_id","typeLabel":"string"},"author_name":{"type":"string","description":"Author name.","uniqueKey":"data.notes.items.[INDEX].author_name","typeLabel":"string"},"score_adjustment":{"type":"number","description":"Score adjustment of result feedback (0 for notes on the candidate).","uniqueKey":"data.notes.items.[INDEX].score_adjustment","typeLabel":"number"},"created_at":{"type":"string","description":"Written (ISO 8601).","uniqueKey":"data.notes.items.[INDEX].created_at","typeLabel":"string"}},"required":["id","target","visibility"],"uniqueKey":"data.notes.items.[INDEX]","typeLabel":"object"},"description":"With include=notes: up to 200 notes you can read, newest first. Another person's private note is never returned.","uniqueKey":"data.notes","typeLabel":"object[]"},"duplicates":{"type":"array","items":{"type":"object","properties":{"duplicate_id":{"type":"string","description":"Duplicate pair id (profile_interview_duplicate.id).","isRequired":true,"uniqueKey":"data.duplicates.items.[INDEX].duplicate_id","typeLabel":"string"},"other_candidate_id":{"type":"string","description":"The other candidate (profile_interview.id).","isRequired":true,"uniqueKey":"data.duplicates.items.[INDEX].other_candidate_id","typeLabel":"string"},"other_name":{"type":"string","description":"Its name.","uniqueKey":"data.duplicates.items.[INDEX].other_name","typeLabel":"string"},"other_email":{"type":"string","description":"Its e-mail.","uniqueKey":"data.duplicates.items.[INDEX].other_email","typeLabel":"string"},"other_phone":{"type":"string","description":"Its phone number.","uniqueKey":"data.duplicates.items.[INDEX].other_phone","typeLabel":"string"},"other_created_at":{"type":"string","description":"Created (ISO 8601).","uniqueKey":"data.duplicates.items.[INDEX].other_created_at","typeLabel":"string"},"other_applications":{"type":"array","items":{"type":"object","properties":{"application_id":{"type":"string","description":"Application id (position_result.id).","uniqueKey":"data.duplicates.items.[INDEX].other_applications.items.[INDEX].application_id","typeLabel":"string"},"position_name":{"type":"string","description":"Position name.","uniqueKey":"data.duplicates.items.[INDEX].other_applications.items.[INDEX].position_name","typeLabel":"string"},"status":{"type":"string","description":"Application state.","uniqueKey":"data.duplicates.items.[INDEX].other_applications.items.[INDEX].status","typeLabel":"string"}},"uniqueKey":"data.duplicates.items.[INDEX].other_applications.items.[INDEX]","typeLabel":"object"},"description":"Its applications to positions visible to you.","uniqueKey":"data.duplicates.items.[INDEX].other_applications","typeLabel":"object[]"},"score":{"type":"number","description":"Match score 0 to 100.","uniqueKey":"data.duplicates.items.[INDEX].score","typeLabel":"number"},"reasons":{"type":"array","items":{"type":"string","uniqueKey":"data.duplicates.items.[INDEX].reasons.items.[INDEX]","typeLabel":"string"},"description":"Which signals matched, each once: email, phone, name, name_dob, linkedin or cv.","uniqueKey":"data.duplicates.items.[INDEX].reasons","typeLabel":"string[]"},"reason_details":{"type":"array","items":{"type":"object","properties":{"signal":{"type":"string","description":"email, phone, name, name_dob, linkedin or cv.","isRequired":true,"uniqueKey":"data.duplicates.items.[INDEX].reason_details.items.[INDEX].signal","typeLabel":"string"},"detail":{"type":"string","description":"The matching value (the e-mail, phone, name or LinkedIn address); absent for cv and name_dob.","uniqueKey":"data.duplicates.items.[INDEX].reason_details.items.[INDEX].detail","typeLabel":"string"}},"required":["signal"],"uniqueKey":"data.duplicates.items.[INDEX].reason_details.items.[INDEX]","typeLabel":"object"},"description":"Each match with its value.","uniqueKey":"data.duplicates.items.[INDEX].reason_details","typeLabel":"object[]"},"status":{"type":"string","description":"open, dismissed or merged.","uniqueKey":"data.duplicates.items.[INDEX].status","typeLabel":"string"}},"required":["duplicate_id","other_candidate_id"],"uniqueKey":"data.duplicates.items.[INDEX]","typeLabel":"object"},"description":"With include=duplicates: open possible duplicates visible to you.","uniqueKey":"data.duplicates","typeLabel":"object[]"},"documents":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Document request id (profile_interview_document_request.id).","isRequired":true,"uniqueKey":"data.documents.items.[INDEX].id","typeLabel":"string"},"status":{"type":"string","description":"open, completed or cancelled.","uniqueKey":"data.documents.items.[INDEX].status","typeLabel":"string"},"message":{"type":"string","description":"Message to the candidate.","uniqueKey":"data.documents.items.[INDEX].message","typeLabel":"string"},"due_date":{"type":"string","description":"Due date (YYYY-MM-DD).","uniqueKey":"data.documents.items.[INDEX].due_date","typeLabel":"string"},"created_at":{"type":"string","description":"Requested (ISO 8601).","uniqueKey":"data.documents.items.[INDEX].created_at","typeLabel":"string"},"completed_at":{"type":"string","description":"Completed (ISO 8601).","uniqueKey":"data.documents.items.[INDEX].completed_at","typeLabel":"string"},"cancelled_at":{"type":"string","description":"Cancelled (ISO 8601).","uniqueKey":"data.documents.items.[INDEX].cancelled_at","typeLabel":"string"},"application_id":{"type":"string","description":"Application (position_result.id).","uniqueKey":"data.documents.items.[INDEX].application_id","typeLabel":"string"},"position_id":{"type":"string","description":"Position (position_def_set.id).","uniqueKey":"data.documents.items.[INDEX].position_id","typeLabel":"string"},"position_name":{"type":"string","description":"Position name.","uniqueKey":"data.documents.items.[INDEX].position_name","typeLabel":"string"},"created_by_name":{"type":"string","description":"Who requested it.","uniqueKey":"data.documents.items.[INDEX].created_by_name","typeLabel":"string"},"reviewed_at":{"type":"string","description":"When a recruiter reviewed the uploads (ISO 8601).","uniqueKey":"data.documents.items.[INDEX].reviewed_at","typeLabel":"string"},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Item id (profile_interview_document_request_item.id).","isRequired":true,"uniqueKey":"data.documents.items.[INDEX].\\items.items.[INDEX].id","typeLabel":"string"},"title":{"type":"string","description":"Document asked for.","uniqueKey":"data.documents.items.[INDEX].\\items.items.[INDEX].title","typeLabel":"string"},"description":{"type":"string","description":"Details.","uniqueKey":"data.documents.items.[INDEX].\\items.items.[INDEX].description","typeLabel":"string"},"required":{"type":"boolean","description":"Required.","uniqueKey":"data.documents.items.[INDEX].\\items.items.[INDEX].required","typeLabel":"boolean"},"uploaded_at":{"type":"string","description":"Uploaded (ISO 8601).","uniqueKey":"data.documents.items.[INDEX].\\items.items.[INDEX].uploaded_at","typeLabel":"string"},"file_name":{"type":"string","description":"Uploaded file name.","uniqueKey":"data.documents.items.[INDEX].\\items.items.[INDEX].file_name","typeLabel":"string"}},"required":["id"],"uniqueKey":"data.documents.items.[INDEX].\\items.items.[INDEX]","typeLabel":"object"},"description":"The documents asked for.","uniqueKey":"data.documents.items.[INDEX].\\items","typeLabel":"object[]"}},"required":["id"],"uniqueKey":"data.documents.items.[INDEX]","typeLabel":"object"},"description":"With include=documents: document requests, newest first.","uniqueKey":"data.documents","typeLabel":"object[]"},"tasks":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Task id (merchant_task.id).","isRequired":true,"uniqueKey":"data.tasks.items.[INDEX].id","typeLabel":"string"},"title":{"type":"string","description":"Title.","uniqueKey":"data.tasks.items.[INDEX].title","typeLabel":"string"},"notes":{"type":"string","description":"Notes.","uniqueKey":"data.tasks.items.[INDEX].notes","typeLabel":"string"},"status":{"type":"string","description":"open, done or cancelled.","uniqueKey":"data.tasks.items.[INDEX].status","typeLabel":"string"},"due_at":{"type":"string","description":"Due (ISO 8601).","uniqueKey":"data.tasks.items.[INDEX].due_at","typeLabel":"string"},"due_state":{"type":"string","description":"overdue, today, upcoming or none.","uniqueKey":"data.tasks.items.[INDEX].due_state","typeLabel":"string"},"assignee_profile_id":{"type":"string","description":"Assignee (profile.id).","uniqueKey":"data.tasks.items.[INDEX].assignee_profile_id","typeLabel":"string"},"assignee_name":{"type":"string","description":"Assignee name.","uniqueKey":"data.tasks.items.[INDEX].assignee_name","typeLabel":"string"},"created_by_name":{"type":"string","description":"Who made it.","uniqueKey":"data.tasks.items.[INDEX].created_by_name","typeLabel":"string"},"created_at":{"type":"string","description":"Created (ISO 8601).","uniqueKey":"data.tasks.items.[INDEX].created_at","typeLabel":"string"},"completed_at":{"type":"string","description":"Completed (ISO 8601).","uniqueKey":"data.tasks.items.[INDEX].completed_at","typeLabel":"string"},"position_id":{"type":"string","description":"Position the task is about (position_def_set.id).","uniqueKey":"data.tasks.items.[INDEX].position_id","typeLabel":"string"},"interview_id":{"type":"string","description":"Interview the task is about (interview_def_set.id).","uniqueKey":"data.tasks.items.[INDEX].interview_id","typeLabel":"string"},"definition_name":{"type":"string","description":"Name of that position or interview.","uniqueKey":"data.tasks.items.[INDEX].definition_name","typeLabel":"string"},"application_id":{"type":"string","description":"Application the task is about (position_result.id).","uniqueKey":"data.tasks.items.[INDEX].application_id","typeLabel":"string"}},"required":["id"],"uniqueKey":"data.tasks.items.[INDEX]","typeLabel":"object"},"description":"With include=tasks: up to 100 tasks on the candidate you can see, open first.","uniqueKey":"data.tasks","typeLabel":"object[]"},"segments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Segment id (profile_interview_segment.id).","isRequired":true,"uniqueKey":"data.segments.items.[INDEX].id","typeLabel":"string"},"name":{"type":"string","description":"Segment name.","isRequired":true,"uniqueKey":"data.segments.items.[INDEX].name","typeLabel":"string"},"kind":{"type":"string","description":"dynamic or static.","isRequired":true,"uniqueKey":"data.segments.items.[INDEX].kind","typeLabel":"string"}},"required":["id","name","kind"],"uniqueKey":"data.segments.items.[INDEX]","typeLabel":"object"},"description":"With include=segments: the saved segments the candidate is in.","uniqueKey":"data.segments","typeLabel":"object[]"},"unavailable":{"type":"array","items":{"type":"object","properties":{"section":{"type":"string","description":"The section asked for.","isRequired":true,"uniqueKey":"data.unavailable.items.[INDEX].section","typeLabel":"string"},"switch":{"type":"string","description":"The company switch that is off.","isRequired":true,"uniqueKey":"data.unavailable.items.[INDEX].switch","typeLabel":"string"}},"required":["section","switch"],"uniqueKey":"data.unavailable.items.[INDEX]","typeLabel":"object"},"description":"Sections asked for but left out because their switch is off.","uniqueKey":"data.unavailable","typeLabel":"object[]"}},"required":["id","merchant_id","status","applications","interviews","tags","auto_tags","counts"],"isRequired":true,"uniqueKey":"data","typeLabel":"object"}},"required":["data"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"data":{"id":"\u003cstring>","merchant_id":"\u003cstring>","status":"\u003cstring>","applications":[{"id":"\u003cstring>","position_id":"\u003cstring>","position_name":"\u003cstring>","status":"\u003cstring>","decision_status":"\u003cstring>","outcome":"\u003cstring>","outcome_at":"\u003cstring>","decision_reason_id":"\u003cstring>","decision_reason_note":"\u003cstring>","withdrawn_at":"\u003cstring>","assigned_profile_id":"\u003cstring>","is_test":true,"current_step_id":"\u003cstring>","created_at":"\u003cstring>","updated_at":"\u003cstring>","steps":[{"id":"\u003cstring>","position_step_id":"\u003cstring>","name":"\u003cstring>","type":"\u003cstring>","sequence_no":123,"status":"\u003cstring>","decision_status":"\u003cstring>","processing_status":"\u003cstring>","decision_reason_id":"\u003cstring>","skipped_at":"\u003cstring>","interview_result_id":"\u003cstring>","pre_screening_id":"\u003cstring>","created_at":"\u003cstring>"}]}],"interviews":[{"id":"\u003cstring>","interview_id":"\u003cstring>","interview_name":"\u003cstring>","type":"\u003cstring>","status":"\u003cstring>","processing_status":"\u003cstring>","score":123,"recruiter_go_next_round":true,"outcome":"\u003cstring>","decision_reason_id":"\u003cstring>","is_test":true,"created_at":"\u003cstring>"}],"tags":[{"id":"\u003cstring>","name":"\u003cstring>","color":"default"}],"auto_tags":["\u003cstring>"],"counts":{"notes":123,"segments":123,"open_tasks":123,"open_document_requests":123},"profile_id":"\u003cstring>","name":"\u003cstring>","email":"\u003cstring>","email_auth":"\u003cstring>","phone_number":"\u003cstring>","emoji":"\u003cstring>","external_id":"\u003cstring>","linked_in":"\u003cstring>","physical_address":"\u003cstring>","mojito_language_code":"\u003cstring>","avatar_url":"\u003cstring>","avatar_local_path":"\u003cstring>","time_zone":"\u003cstring>","skills":["\u003cstring>"],"last_login_at":"\u003cstring>","created_at":"\u003cstring>","updated_at":"\u003cstring>","source_channel":"\u003cstring>","is_prospect":true,"owner_profile_ids":["\u003cstring>"],"custom_fields":{},"duplicate_flag":{"open_count":123,"top_score":123},"notes":[{"id":"\u003cstring>","target":"candidate","visibility":"team","result_id":"\u003cstring>","pre_screening_id":"\u003cstring>","text":"\u003cstring>","author_profile_id":"\u003cstring>","author_name":"\u003cstring>","score_adjustment":123,"created_at":"\u003cstring>"}],"duplicates":[{"duplicate_id":"\u003cstring>","other_candidate_id":"\u003cstring>","other_name":"\u003cstring>","other_email":"\u003cstring>","other_phone":"\u003cstring>","other_created_at":"\u003cstring>","other_applications":[{"application_id":"\u003cstring>","position_name":"\u003cstring>","status":"\u003cstring>"}],"score":123,"reasons":["\u003cstring>"],"reason_details":[{"signal":"\u003cstring>","detail":"\u003cstring>"}],"status":"\u003cstring>"}],"documents":[{"id":"\u003cstring>","status":"\u003cstring>","message":"\u003cstring>","due_date":"\u003cstring>","created_at":"\u003cstring>","completed_at":"\u003cstring>","cancelled_at":"\u003cstring>","application_id":"\u003cstring>","position_id":"\u003cstring>","position_name":"\u003cstring>","created_by_name":"\u003cstring>","reviewed_at":"\u003cstring>","items":[{"id":"\u003cstring>","title":"\u003cstring>","description":"\u003cstring>","required":true,"uploaded_at":"\u003cstring>","file_name":"\u003cstring>"}]}],"tasks":[{"id":"\u003cstring>","title":"\u003cstring>","notes":"\u003cstring>","status":"\u003cstring>","due_at":"\u003cstring>","due_state":"\u003cstring>","assignee_profile_id":"\u003cstring>","assignee_name":"\u003cstring>","created_by_name":"\u003cstring>","created_at":"\u003cstring>","completed_at":"\u003cstring>","position_id":"\u003cstring>","interview_id":"\u003cstring>","definition_name":"\u003cstring>","application_id":"\u003cstring>"}],"segments":[{"id":"\u003cstring>","name":"\u003cstring>","kind":"\u003cstring>"}],"unavailable":[{"section":"\u003cstring>","switch":"\u003cstring>"}]}}}},"exampleType":"generated"}},"exampleType":"generated"},"453375ed-2275-47c1-8d55-c2b197b4a5b2":{"description":"Missing or invalid access token.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Field is required.","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"name":{"type":"string","example":"interview_result_id","uniqueKey":"name","typeLabel":"string"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"Field is required.","name":"interview_result_id"}}},"exampleType":"generated"}},"exampleType":"generated"},"265f75a4-6b68-4912-b957-7b45834e6ac4":{"description":"Not staff of the candidate's company.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Field is required.","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"name":{"type":"string","example":"interview_result_id","uniqueKey":"name","typeLabel":"string"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"Field is required.","name":"interview_result_id"}}},"exampleType":"generated"}},"exampleType":"generated"},"ee62b2a6-8d5e-4c55-9289-61076030adca":{"description":"No such candidate, or not visible to you.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Field is required.","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"name":{"type":"string","example":"interview_result_id","uniqueKey":"name","typeLabel":"string"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"Field is required.","name":"interview_result_id"}}},"exampleType":"generated"}},"exampleType":"generated"},"e1de38dd-a563-428c-ac1e-3bdf4be7fd02":{"description":"Validation error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Field is required.","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"name":{"type":"string","example":"interview_result_id","uniqueKey":"name","typeLabel":"string"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"Field is required.","name":"interview_result_id"}}},"exampleType":"generated"}},"exampleType":"generated"},"071f0c7c-089f-494d-acd5-29c0218dcf54":{"description":"Server error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Field is required.","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"name":{"type":"string","example":"interview_result_id","uniqueKey":"name","typeLabel":"string"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"Field is required.","name":"interview_result_id"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"0910cff1-fb77-4878-84e6-53f4a3666867":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Supabase JWT — `Authorization: Bearer \u003ctoken>`.","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"454fcb62-7052-4847-a728-ecf5ade065a6":{"url":"https://cool.jobmojito.com/functions/v1","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Supabase JWT — `Authorization: Bearer \u003ctoken>`.","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Supabase JWT — `Authorization: Bearer \u003ctoken>`.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"https://cool.jobmojito.com/functions/v1/openapi"},"subdomain":"jobmojito","siteName":"JobMojito Developer / Agent","title":"Get a candidate - JobMojito Developer / Agent","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-09T15:00:44.466Z","originalFileLocation":"api-reference/candidates/get-a-candidate.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"One candidate as the admin\u0026#x27;s candidate page shows it: profile, applications with their steps, stand-alone interview results, tags, counts and the duplicate flag; with include, also notes, duplicates, document requests, tasks and segments. Applications to positions hidden from you (position access) are left out; a candidate hidden from you is not found. Recorded in the audit log as a view of the candidate.\">\u003cmeta data-mint-head name=\"application-name\" content=\"JobMojito Developer / Agent\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/jobmojito/GZwP9Qkfq6UpkrB8/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/jobmojito/GZwP9Qkfq6UpkrB8/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/jobmojito/GZwP9Qkfq6UpkrB8/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/jobmojito/GZwP9Qkfq6UpkrB8/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/jobmojito/GZwP9Qkfq6UpkrB8/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/jobmojito/GZwP9Qkfq6UpkrB8/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/jobmojito/GZwP9Qkfq6UpkrB8/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/jobmojito/GZwP9Qkfq6UpkrB8/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/jobmojito/GZwP9Qkfq6UpkrB8/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get a candidate - JobMojito Developer / Agent\">\u003cmeta data-mint-head property=\"og:description\" content=\"One candidate as the admin\u0026#x27;s candidate page shows it: profile, applications with their steps, stand-alone interview results, tags, counts and the duplicate flag; with include, also notes, duplicates, document requests, tasks and segments. Applications to positions hidden from you (position access) are left out; a candidate hidden from you is not found. Recorded in the audit log as a view of the candidate.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"JobMojito Developer / Agent\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developer.jobmojito.com/api-reference/candidates/get-a-candidate\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://jobmojito.mintlify.site/_mintlify/api/og/v2?division=Candidates\u0026amp;title=Get+a+candidate\u0026amp;description=One+candidate+as+the+admin%27s+candidate+page+shows+it%3A+profile%2C+applications+with+their+steps%2C+stand-alone+interview+results%2C+tags%2C+counts+and+the+duplicate+flag\u0026amp;theme=87c5e3cf7199050cbbf4cb49\u0026amp;signature=f2b829bd7a5b96116643db153fc2644d1b3be26378e0f7e21351579fbfa8346c\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Get a candidate - JobMojito Developer / Agent\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"One candidate as the admin\u0026#x27;s candidate page shows it: profile, applications with their steps, stand-alone interview results, tags, counts and the duplicate flag; with include, also notes, duplicates, document requests, tasks and segments. Applications to positions hidden from you (position access) are left out; a candidate hidden from you is not found. Recorded in the audit log as a view of the candidate.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://jobmojito.mintlify.site/_mintlify/api/og/v2?division=Candidates\u0026amp;title=Get+a+candidate\u0026amp;description=One+candidate+as+the+admin%27s+candidate+page+shows+it%3A+profile%2C+applications+with+their+steps%2C+stand-alone+interview+results%2C+tags%2C+counts+and+the+duplicate+flag\u0026amp;theme=87c5e3cf7199050cbbf4cb49\u0026amp;signature=f2b829bd7a5b96116643db153fc2644d1b3be26378e0f7e21351579fbfa8346c\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/jobmojito/GZwP9Qkfq6UpkrB8/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"JobMojito Developer / Agent\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#639C42\">\u003clink data-mint-head rel=\"canonical\" href=\"https://developer.jobmojito.com/api-reference/candidates/get-a-candidate\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/candidates/get-a-candidate.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://developer.jobmojito.com/#organization\",\"name\":\"JobMojito Developer / Agent\",\"url\":\"https://developer.jobmojito.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/jobmojito/DU7xAw61G9kqV1zG/images/jobmojito-light.svg?fit=max\u0026auto=format\u0026n=DU7xAw61G9kqV1zG\u0026q=85\u0026s=6c00cb5f3104ffb6325dacc0818bba69\"}},{\"@type\":\"WebSite\",\"@id\":\"https://developer.jobmojito.com#website\",\"name\":\"JobMojito Developer / Agent\",\"url\":\"https://developer.jobmojito.com\",\"publisher\":{\"@id\":\"https://developer.jobmojito.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://developer.jobmojito.com/api-reference/candidates/get-a-candidate#webpage\",\"url\":\"https://developer.jobmojito.com/api-reference/candidates/get-a-candidate\",\"name\":\"Get a candidate\",\"description\":\"One candidate as the admin's candidate page shows it: profile, applications with their steps, stand-alone interview results, tags, counts and the duplicate flag; with include, also notes, duplicates, document requests, tasks and segments. Applications to positions hidden from you (position access) are left out; a candidate hidden from you is not found. Recorded in the audit log as a view of the candidate.\",\"dateModified\":\"2026-11-09T15:00:44.466Z\",\"isPartOf\":{\"@id\":\"https://developer.jobmojito.com#website\"},\"breadcrumb\":{\"@id\":\"https://developer.jobmojito.com/api-reference/candidates/get-a-candidate#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developer.jobmojito.com/api-reference/candidates/get-a-candidate#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Candidates\",\"item\":\"https://developer.jobmojito.com/api-reference/candidates/list-candidates\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get a candidate\",\"item\":\"https://developer.jobmojito.com/api-reference/candidates/get-a-candidate\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developer.jobmojito.com/api-reference/candidates/get-a-candidate#apireference\",\"headline\":\"Get a candidate\",\"name\":\"Get a candidate\",\"description\":\"One candidate as the admin's candidate page shows it: profile, applications with their steps, stand-alone interview results, tags, counts and the duplicate flag; with include, also notes, duplicates, document requests, tasks and segments. Applications to positions hidden from you (position access) are left out; a candidate hidden from you is not found. Recorded in the audit log as a view of the candidate.\",\"url\":\"https://developer.jobmojito.com/api-reference/candidates/get-a-candidate\",\"mainEntityOfPage\":{\"@id\":\"https://developer.jobmojito.com/api-reference/candidates/get-a-candidate#webpage\"},\"dateModified\":\"2026-11-09T15:00:44.466Z\",\"publisher\":{\"@id\":\"https://developer.jobmojito.com/#organization\"},\"isPartOf\":{\"@id\":\"https://developer.jobmojito.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"JobMojito Developer / Agent\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"JobMojito Developer / Agent","nav":{"global":null,"tabs":[{"tab":"Welcome","pages":[{"title":"Welcome","href":"/welcome"}]},{"tab":"API Reference","groups":[{"group":"Interviews","pages":[{"title":"Create a new interview","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /job-interview-create","href":"/api-reference/interviews/create-a-new-interview"},{"title":"Create an interview from an array of questions","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /job-interview-create-from-array","href":"/api-reference/interviews/create-an-interview-from-an-array-of-questions"},{"title":"Create an interview for a candidate and return an access token URL","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /job-interview-create-for-candidate-with-token","href":"/api-reference/interviews/create-an-interview-for-a-candidate-and-return-an-access-token-url"},{"title":"Create a role-play — coaching persona or interview-portal role-play (choose with `portal`)","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /persona-create","href":"/api-reference/interviews/create-a-role-play-—-coaching-persona-or-interview-portal-role-play-choose-with-`portal`"},{"title":"Get interview definition","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi get /job-interview-get","href":"/api-reference/interviews/get-interview-definition"},{"title":"Update an interview or position","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /job-interview-update","href":"/api-reference/interviews/update-an-interview-or-position"},{"title":"Set interview state","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /job-interview-set-state","href":"/api-reference/interviews/set-interview-state"},{"title":"Generate a signed interview URL","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /job-interview-token","href":"/api-reference/interviews/generate-a-signed-interview-url"},{"title":"Register users for an interview","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /job-interview-register-users","href":"/api-reference/interviews/register-users-for-an-interview"},{"title":"List interview definitions","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi get /merchant-interview-list","href":"/api-reference/interviews/list-interview-definitions"}]},{"group":"Positions","pages":[{"title":"Set the steps of a draft position","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /merchant-position-process-save","href":"/api-reference/positions/set-the-steps-of-a-draft-position"},{"title":"Change the settings of a position step","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /merchant-position-step-update","href":"/api-reference/positions/change-the-settings-of-a-position-step"},{"title":"Create, change or delete a meeting slot","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /merchant-meeting-slot-manage","href":"/api-reference/positions/create-change-or-delete-a-meeting-slot"},{"title":"Copy a position","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /merchant-position-duplicate","href":"/api-reference/positions/copy-a-position"},{"title":"Copy an interview","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /merchant-interview-duplicate","href":"/api-reference/positions/copy-an-interview"}]},{"group":"Coaching catalogue","pages":[{"title":"Create a coaching catalogue directory","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /catalogue-tag-create","href":"/api-reference/coaching-catalogue/create-a-coaching-catalogue-directory"},{"title":"Update a coaching catalogue directory","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /catalogue-tag-update","href":"/api-reference/coaching-catalogue/update-a-coaching-catalogue-directory"},{"title":"Get a coaching catalogue directory","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi get /catalogue-tag-get","href":"/api-reference/coaching-catalogue/get-a-coaching-catalogue-directory"},{"title":"List coaching catalogue directories","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi get /catalogue-tag-list","href":"/api-reference/coaching-catalogue/list-coaching-catalogue-directories"}]},{"group":"Results","pages":[{"title":"Get interview result details with transcript","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi get /job-interview-details","href":"/api-reference/results/get-interview-result-details-with-transcript"},{"title":"Generate an interview report","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /job-interview-pdf","href":"/api-reference/results/generate-an-interview-report"},{"title":"Request another interview attempt","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /job-interview-result-request-another-attempt","href":"/api-reference/results/request-another-interview-attempt"},{"title":"Record an external assessment result","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /assessment-result-set","href":"/api-reference/results/record-an-external-assessment-result"},{"title":"List interview results","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi get /merchant-result-list","href":"/api-reference/results/list-interview-results"},{"title":"Get daily event analytics","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi get /merchant-analytics","href":"/api-reference/results/get-daily-event-analytics"},{"title":"Get merchant credit usage","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi get /merchant-analytics-credits-used","href":"/api-reference/results/get-merchant-credit-usage"}]},{"group":"Reports","pages":[{"title":"List report datasets, fields and measures","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi get /report-catalog","href":"/api-reference/reports/list-report-datasets-fields-and-measures"},{"title":"List custom reports","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi get /report-list","href":"/api-reference/reports/list-custom-reports"},{"title":"Get a custom report definition","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi get /report-get","href":"/api-reference/reports/get-a-custom-report-definition"},{"title":"Run a custom report","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi get /report-run","href":"/api-reference/reports/run-a-custom-report"},{"title":"Check and run an unsaved report","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /report-preview","href":"/api-reference/reports/check-and-run-an-unsaved-report"},{"title":"Create a custom report","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /report-create","href":"/api-reference/reports/create-a-custom-report"},{"title":"Update a custom report","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /report-update","href":"/api-reference/reports/update-a-custom-report"}]},{"group":"Candidates","pages":[{"title":"List candidates","description":"Paginated list of a merchant's candidates (the admin-portal candidates list), scoped to your token's merchant (or a merchant_id override). Capped at 1000 records per page. Filters: activity tab, source, text, emoji, owner, kind, channel, mentioned_me; or a search with the segment builder's rules (rules) or a saved segment's members (segment_id). Candidates hidden from you by position access are never listed. Each read is recorded in the company audit log.","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi get /merchant-candidate-list","href":"/api-reference/candidates/list-candidates"},{"title":"Get a candidate","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi get /merchant-candidate-get","href":"/api-reference/candidates/get-a-candidate"},{"title":"Add a note to a candidate","description":"Adds a note on a candidate or on one of its interview results, as the admin's feedback box does: kind comment, no score adjustment. Owners, recruiters, admins and hiring managers, on candidates and results visible to them. A private note (the private_notes feature) is seen by you alone. Each colleague in mention_profile_ids (the mentions feature) gets one e-mail with the candidate's name and the first 500 characters of the note; colleagues who cannot open the candidate are skipped. Nothing is sent to the candidate. Notes cannot be changed or deleted through the API.","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /merchant-candidate-note-add","href":"/api-reference/candidates/add-a-note-to-a-candidate"},{"title":"Tag candidates","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /merchant-candidate-tags-set","href":"/api-reference/candidates/tag-candidates"},{"title":"Create, change or delete a candidate tag","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /merchant-candidate-tag-manage","href":"/api-reference/candidates/create-change-or-delete-a-candidate-tag"},{"title":"List candidate filter options","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi get /merchant-candidate-filter-options","href":"/api-reference/candidates/list-candidate-filter-options"},{"title":"Preview merging two candidates","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi get /merchant-candidate-merge-preview","href":"/api-reference/candidates/preview-merging-two-candidates"},{"title":"Merge two candidates","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /merchant-candidate-merge","href":"/api-reference/candidates/merge-two-candidates"},{"title":"Dismiss a possible duplicate","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /merchant-candidate-duplicate-dismiss","href":"/api-reference/candidates/dismiss-a-possible-duplicate"},{"title":"List candidate segments","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi get /merchant-segment-list","href":"/api-reference/candidates/list-candidate-segments"},{"title":"Create, change or delete a candidate segment","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /merchant-segment-manage","href":"/api-reference/candidates/create-change-or-delete-a-candidate-segment"},{"title":"Download a candidate document","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi get /merchant-document-download","href":"/api-reference/candidates/download-a-candidate-document"}]},{"group":"Tasks","pages":[{"title":"List tasks","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi get /merchant-task-list","href":"/api-reference/tasks/list-tasks"},{"title":"Create or change a task","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /merchant-task-save","href":"/api-reference/tasks/create-or-change-a-task"}]},{"group":"Document requests","pages":[{"title":"List document requests","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi get /merchant-document-request-list","href":"/api-reference/document-requests/list-document-requests"},{"title":"Ask a candidate for documents","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /merchant-document-request-create","href":"/api-reference/document-requests/ask-a-candidate-for-documents"},{"title":"Cancel a document request or mark it reviewed","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /merchant-document-request-update","href":"/api-reference/document-requests/cancel-a-document-request-or-mark-it-reviewed"}]},{"group":"Reasons","pages":[{"title":"List the company's reasons","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi get /merchant-reason-list","href":"/api-reference/reasons/list-the-companys-reasons"},{"title":"Get one of the company's reasons","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi get /merchant-reason-get","href":"/api-reference/reasons/get-one-of-the-companys-reasons"},{"title":"Create, change or archive a reason","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /merchant-reason-save","href":"/api-reference/reasons/create-change-or-archive-a-reason"}]},{"group":"Knowledge base","pages":[{"title":"Upload a knowledge base document","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /knowledge-base-document-upload","href":"/api-reference/knowledge-base/upload-a-knowledge-base-document"},{"title":"List knowledge base documents and their interview limits","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi get /knowledge-base-document-list","href":"/api-reference/knowledge-base/list-knowledge-base-documents-and-their-interview-limits"},{"title":"Change which interviews can use a document","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /knowledge-base-document-set-interviews","href":"/api-reference/knowledge-base/change-which-interviews-can-use-a-document"},{"title":"List knowledge base stores","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi get /knowledge-base-store-list","href":"/api-reference/knowledge-base/list-knowledge-base-stores"},{"title":"Create or change a knowledge base store","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /knowledge-base-store-save","href":"/api-reference/knowledge-base/create-or-change-a-knowledge-base-store"}]},{"group":"Resume \u0026 Form verification","pages":[{"title":"Create or update a pre-screening position","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /pre-screening-create","href":"/api-reference/resume-\u0026-form-verification/create-or-update-a-pre-screening-position"},{"title":"Run pre-screening on a plaintext resume","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /job-interview-pre-screening-api-resume-text","href":"/api-reference/resume-\u0026-form-verification/run-pre-screening-on-a-plaintext-resume"},{"title":"Pre-screen a candidate from a binary resume upload","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /job-interview-pre-screening-api-resume-binary","href":"/api-reference/resume-\u0026-form-verification/pre-screen-a-candidate-from-a-binary-resume-upload"}]},{"group":"Admin","pages":[{"title":"Invite admin / merchant-team or coaching users","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /invite-users","href":"/api-reference/admin/invite-admin-merchant-team-or-coaching-users"},{"title":"List sub-merchants","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi get /merchant-sub-merchant-list","href":"/api-reference/admin/list-sub-merchants"},{"title":"List the company's users","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi get /merchant-user-list","href":"/api-reference/admin/list-the-companys-users"},{"title":"List avatar templates","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi get /merchant-avatar-list","href":"/api-reference/admin/list-avatar-templates"},{"title":"Get merchant status","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi get /merchant-status","href":"/api-reference/admin/get-merchant-status"},{"title":"List platform languages","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi get /platform-languages-list","href":"/api-reference/admin/list-platform-languages"},{"title":"Get the portal configuration (branding, portals, brands, pages)","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi get /portal-configuration-get","href":"/api-reference/admin/get-the-portal-configuration-branding-portals-brands-pages"},{"title":"Update the portal configuration (branding, portals, brands, pages)","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /portal-configuration-update","href":"/api-reference/admin/update-the-portal-configuration-branding-portals-brands-pages"},{"title":"Publish a brand stylesheet","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /portal-css-publish","href":"/api-reference/admin/publish-a-brand-stylesheet"},{"title":"Get the component style guide","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi get /portal-component-styles","href":"/api-reference/admin/get-the-component-style-guide"},{"title":"Save a component style","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /portal-component-styles","href":"/api-reference/admin/save-a-component-style"},{"title":"Generate component style alternatives","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /portal-component-styles-generate","href":"/api-reference/admin/generate-component-style-alternatives"},{"title":"List the media library","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi get /media-list","href":"/api-reference/admin/list-the-media-library"},{"title":"Start uploading a media file","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /media-upload-start","href":"/api-reference/admin/start-uploading-a-media-file"},{"title":"Finish uploading a media file","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /media-upload-finish","href":"/api-reference/admin/finish-uploading-a-media-file"},{"title":"Describe a media file","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /media-update","href":"/api-reference/admin/describe-a-media-file"},{"title":"Delete a media file","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /media-delete","href":"/api-reference/admin/delete-a-media-file"},{"title":"List the media library folders","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi get /media-folders","href":"/api-reference/admin/list-the-media-library-folders"},{"title":"Create, rename or delete a media library folder","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /media-folders","href":"/api-reference/admin/create-rename-or-delete-a-media-library-folder"}]},{"group":"Feedback","pages":[{"title":"Submit a feature request","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /merchant-feature-request","href":"/api-reference/feedback/submit-a-feature-request"},{"title":"Report a technical issue","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi post /merchant-technical-issue","href":"/api-reference/feedback/report-a-technical-issue"}]}]},{"tab":"Webhooks","pages":[{"title":"Webhooks","href":"/api-reference/webhooks/interview-result-submitted"}]},{"tab":"Cookbooks","pages":[{"title":"Cookbooks","href":"/cookbooks"}]},{"tab":"Skills","pages":[{"title":"Skills","href":"/skills/overview"}]},{"tab":"MCP","pages":[{"title":"MCP","href":"/mcp/overview"}]}]},"basePath":"","title":"Get a candidate - JobMojito Developer / Agent","buildId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","deploymentId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-C-hEh3I2.js","utils-CnF4QiUD.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C7PVNbel.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-8ytevL2A.js","snippetPresets-BT1alx3v.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BLXC0i_W.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CyLIGI9_.js","shallow-DC0lGVIW.js","getApiPlaygroundDisplay-CgDQ85tN.js","CodeSnippet-6-I-Gpv9.js","CodeSnippets-BAk1kDdu.js","Page-C945cI-W.js","getPastedJson-B276RuWN.js","icon-BqP8etTm.js","MethodPill-DM6sbxG1.js","DuplicateIcon-PyJglOaE.js","createIcon-CMeOMAc_.js","DynamicMarkdown-BoyYAA8K.js","SectionHeading-DAYv3gvZ.js","axios-vUo_bRtp.js","Markdown-BhTTmazV.js","clsx-CR-RHrVC.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CBUH0-zX.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BmARFYNC.js"]}