Create a new scorecard (candidate evaluation) for a person.
Job scoping: pass job_id to attach the scorecard to a specific job. candidate_id is auto-resolved from the (person_id, job_id) candidate record.
Criterion ratings: include criterion_ratings to score individual criteria from the template. Each entry must reference a criterion_id belonging to the template and include a rating, a comment, or both.
Team member assignment: the scorecard is recorded as created by the calling team member. Pass team_member_id only when authenticating with an API key (no implicit member context). Session and OAuth callers cannot attribute creation to a different member.
Whether to expose this scorecard on the client share link for the linked job. Only respected when job_id is set and is_draft is false. Defaults to false.
Team member UUID to record as the scorecard creator. Ignored for session and OAuth callers (the authenticated member is always recorded). Required for API-key auth, which has no implicit member context.
Per-criterion ratings and comments. Each entry must reference a criterion_id belonging to the assessment_template_id and must include a rating, a comment, or both.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Stardex Help Docs","description":"AI native ATS \u0026 CRM for search firms","colors":{"primary":"#5853f7","light":"#5853f7","dark":"#EDF3F9"},"logo":{"light":"https://mintcdn.com/stardex/Unebva7RlCeyAgPy/logo/light.svg?fit=max\u0026auto=format\u0026n=Unebva7RlCeyAgPy\u0026q=85\u0026s=6a32bc87265a1562f0ee3793cb4c66e7","dark":"https://mintcdn.com/stardex/Unebva7RlCeyAgPy/logo/dark.svg?fit=max\u0026auto=format\u0026n=Unebva7RlCeyAgPy\u0026q=85\u0026s=000def45485b23628fc81f156a6306cd"},"favicon":"https://mintcdn.com/stardex/Unebva7RlCeyAgPy/favicon.svg?fit=max\u0026auto=format\u0026n=Unebva7RlCeyAgPy\u0026q=85\u0026s=dbebacabd3552482bc8b3f787e61888d","api":{"mdx":{"auth":{"method":"bearer","name":"Authorization"},"server":"https://api.stardex.ai"}},"navbar":{"links":[{"href":"mailto:support@stardex.ai","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://stardex.com/jobs"}},"footer":{"socials":{"x":"https://x.com/stardexhq","linkedin":"https://linkedin.com/company/stardexhq"}},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Home page","icon":"book-open-cover","href":"https://www.stardex.com"},{"anchor":"Blog","icon":"newspaper","href":"https://www.stardex.com/blog"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"stardex","hasAudioNarration":false,"actualSubdomain":"stardex","customDomains":["docs.stardex.com"],"gitSource":{"type":"github","owner":"dotshq","repo":"ats-plus","deployBranch":"main","contentDirectory":"apps/docs","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae66f02e7a853c3110a3701","collectionId":"fb3cee1b-bb22-46e6-8462-defa0373305d","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae66f02e7a853c3110a3701"},"feedback":{"thumbs":true,"edits":true,"issues":true},"entitlements":{},"buildId":"6ae8f0317f07b925ab851864","clientVersion":"0.0.4045","searchFilterCounts":[{"language":"default","tag":"API Reference","count":180},{"language":"default","tag":"Help Center","count":86},{"language":"default","tag":"Core Features","count":35},{"language":"default","tag":"Settings \u0026 Customization","count":27},{"language":"default","tag":"Campaigns","count":23},{"language":"default","tag":"Persons","count":23},{"language":"default","tag":"Jobs","count":21},{"language":"default","tag":"Integrations","count":16},{"language":"default","tag":"Retainer Packs","count":12},{"language":"default","tag":"Email \u0026 other integrations","count":10}]},"assistantConfig":{},"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":"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":"byok-sep-25","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":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","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":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/scorecards/create-scorecard","slug":"/api-reference/scorecards/create-scorecard","pageMetadata":{"title":"Create scorecard","description":"Create a new scorecard (candidate evaluation) for a person.\n\n**Job scoping**: pass `job_id` to attach the scorecard to a specific job. `candidate_id` is auto-resolved from the (person_id, job_id) candidate record.\n\n**Criterion ratings**: include `criterion_ratings` to score individual criteria from the template. Each entry must reference a `criterion_id` belonging to the template and include a `rating`, a `comment`, or both.\n\n**Team member assignment**: the scorecard is recorded as created by the calling team member. Pass `team_member_id` only when authenticating with an API key (no implicit member context). Session and OAuth callers cannot attribute creation to a different member.","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/scorecards","href":"/api-reference/scorecards/create-scorecard","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n strong: \"strong\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Create a new scorecard (candidate evaluation) for a person.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Job scoping\"\n }), \": pass \", _jsx(_components.code, {\n children: \"job_id\"\n }), \" to attach the scorecard to a specific job. \", _jsx(_components.code, {\n children: \"candidate_id\"\n }), \" is auto-resolved from the (person_id, job_id) candidate record.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Criterion ratings\"\n }), \": include \", _jsx(_components.code, {\n children: \"criterion_ratings\"\n }), \" to score individual criteria from the template. Each entry must reference a \", _jsx(_components.code, {\n children: \"criterion_id\"\n }), \" belonging to the template and include a \", _jsx(_components.code, {\n children: \"rating\"\n }), \", a \", _jsx(_components.code, {\n children: \"comment\"\n }), \", or both.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Team member assignment\"\n }), \": the scorecard is recorded as created by the calling team member. Pass \", _jsx(_components.code, {\n children: \"team_member_id\"\n }), \" only when authenticating with an API key (no implicit member context). Session and OAuth callers cannot attribute creation to a different member.\"]\n })]\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":"Create scorecard","description":"Create a new scorecard (candidate evaluation) for a person.\n\n**Job scoping**: pass `job_id` to attach the scorecard to a specific job. `candidate_id` is auto-resolved from the (person_id, job_id) candidate record.\n\n**Criterion ratings**: include `criterion_ratings` to score individual criteria from the template. Each entry must reference a `criterion_id` belonging to the template and include a `rating`, a `comment`, or both.\n\n**Team member assignment**: the scorecard is recorded as created by the calling team member. Pass `team_member_id` only when authenticating with an API key (no implicit member context). Session and OAuth callers cannot attribute creation to a different member.","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/scorecards","href":"/api-reference/scorecards/create-scorecard","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"createScorecard","summary":"Create scorecard","description":"Create a new scorecard (candidate evaluation) for a person.\n\n**Job scoping**: pass `job_id` to attach the scorecard to a specific job. `candidate_id` is auto-resolved from the (person_id, job_id) candidate record.\n\n**Criterion ratings**: include `criterion_ratings` to score individual criteria from the template. Each entry must reference a `criterion_id` belonging to the template and include a `rating`, a `comment`, or both.\n\n**Team member assignment**: the scorecard is recorded as created by the calling team member. Pass `team_member_id` only when authenticating with an API key (no implicit member context). Session and OAuth callers cannot attribute creation to a different member.","tags":["Scorecards"],"requestBody":"87726363-e9b5-4272-be91-408675c2f3e8","responses":{"201":"2419268e-c1d8-4f48-9d5d-ee896d04ad58","400":"65f6f309-524f-42f2-81ba-6bc9b2039e2d","404":"1c9ada73-42e7-4845-bd40-374313ae7d66","500":"5542bf89-8ee9-422c-a990-27477a2f20e3"},"method":"post","type":"path","servers":["0f55f676-b9db-4dbe-b3e2-3132b8bc1690"],"security":["1a522db3-1c95-4503-bd27-0e07c9bb550d"],"path":"/v1/scorecards","baseUrlOptions":["https://api.stardex.ai"],"title":"Create scorecard","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"person_id":{"type":"string","format":"uuid","description":"Person UUID being evaluated (required).","isRequired":true,"uniqueKey":"person_id","typeLabel":"string\u003cuuid>"},"assessment_template_id":{"type":"string","format":"uuid","description":"Scorecard template UUID used to score the person (required).","isRequired":true,"uniqueKey":"assessment_template_id","typeLabel":"string\u003cuuid>"},"job_id":{"type":"string","format":"uuid","description":"Job UUID to scope this scorecard to. When set, the candidate_id is auto-resolved from the (person_id, job_id) candidate record.","uniqueKey":"job_id","typeLabel":"string\u003cuuid>"},"overall_rating":{"oneOf":[{"type":"number","minimum":0,"maximum":10,"description":"Overall score (0 to template rating_scale). Optional — leave null to score only at the criterion level.","uniqueKey":"overall_rating.oneOf.0","typeLabel":"number"},{"type":"null","minimum":0,"maximum":10,"description":"Overall score (0 to template rating_scale). Optional — leave null to score only at the criterion level.","uniqueKey":"overall_rating.oneOf.1","typeLabel":"null"}],"uniqueKey":"overall_rating","typeLabel":"number | null"},"overall_comment":{"type":"string","description":"Plain-text overall summary note.","uniqueKey":"overall_comment","typeLabel":"string"},"is_starred":{"type":"boolean","default":false,"description":"Whether to mark this scorecard as starred. Defaults to false.","uniqueKey":"is_starred","typeLabel":"boolean"},"is_draft":{"type":"boolean","default":false,"description":"Whether to save this scorecard as an incomplete draft. Drafts are excluded from people-list averages and client share links. Defaults to false.","uniqueKey":"is_draft","typeLabel":"boolean"},"visible_in_client_share_link":{"type":"boolean","default":false,"description":"Whether to expose this scorecard on the client share link for the linked job. Only respected when job_id is set and is_draft is false. Defaults to false.","uniqueKey":"visible_in_client_share_link","typeLabel":"boolean"},"team_member_id":{"type":"string","format":"uuid","description":"Team member UUID to record as the scorecard creator. Ignored for session and OAuth callers (the authenticated member is always recorded). Required for API-key auth, which has no implicit member context.","uniqueKey":"team_member_id","typeLabel":"string\u003cuuid>"},"criterion_ratings":{"type":"array","items":{"type":"object","properties":{"criterion_id":{"type":"string","format":"uuid","description":"Criterion UUID from the template (assessment_template_criteria.id).","isRequired":true,"uniqueKey":"criterion_ratings.items.[INDEX].criterion_id","typeLabel":"string\u003cuuid>"},"rating":{"oneOf":[{"type":"number","minimum":0,"maximum":10,"description":"Numeric score from 0 to the template rating_scale (max 10). At least one of rating or comment must be set.","uniqueKey":"criterion_ratings.items.[INDEX].rating.oneOf.0","typeLabel":"number"},{"type":"null","minimum":0,"maximum":10,"description":"Numeric score from 0 to the template rating_scale (max 10). At least one of rating or comment must be set.","uniqueKey":"criterion_ratings.items.[INDEX].rating.oneOf.1","typeLabel":"null"}],"uniqueKey":"criterion_ratings.items.[INDEX].rating","typeLabel":"number | null"},"comment":{"oneOf":[{"type":"string","description":"Plain-text comment for this criterion. Pass null or omit to leave only a numeric rating.","uniqueKey":"criterion_ratings.items.[INDEX].comment.oneOf.0","typeLabel":"string"},{"type":"null","description":"Plain-text comment for this criterion. Pass null or omit to leave only a numeric rating.","uniqueKey":"criterion_ratings.items.[INDEX].comment.oneOf.1","typeLabel":"null"}],"uniqueKey":"criterion_ratings.items.[INDEX].comment","typeLabel":"string | null"}},"required":["criterion_id"],"uniqueKey":"criterion_ratings.items.[INDEX]","typeLabel":"object"},"description":"Per-criterion ratings and comments. Each entry must reference a criterion_id belonging to the assessment_template_id and must include a rating, a comment, or both.","uniqueKey":"criterion_ratings","typeLabel":"object[]"}},"required":["person_id","assessment_template_id"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"person_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","assessment_template_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","job_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","overall_rating":5,"overall_comment":"\u003cstring>","is_starred":false,"is_draft":false,"visible_in_client_share_link":false,"team_member_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","criterion_ratings":[{"criterion_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","rating":5,"comment":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"2419268e-c1d8-4f48-9d5d-ee896d04ad58":{"description":"Scorecard created","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true],"isRequired":true,"uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Scorecard UUID.","isRequired":true,"uniqueKey":"data.id","typeLabel":"string\u003cuuid>"},"person_id":{"type":"string","format":"uuid","description":"Person UUID being evaluated.","isRequired":true,"uniqueKey":"data.person_id","typeLabel":"string\u003cuuid>"},"job_id":{"oneOf":[{"type":"string","format":"uuid","description":"Job UUID this scorecard is scoped to, or null for a person-level scorecard.","isRequired":true,"uniqueKey":"data.job_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","description":"Job UUID this scorecard is scoped to, or null for a person-level scorecard.","isRequired":true,"uniqueKey":"data.job_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.job_id","typeLabel":"string\u003cuuid> | null"},"candidate_id":{"oneOf":[{"type":"string","format":"uuid","description":"Candidate UUID (person+job) — auto-resolved when job_id is set and the person is a candidate on that job.","isRequired":true,"uniqueKey":"data.candidate_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","description":"Candidate UUID (person+job) — auto-resolved when job_id is set and the person is a candidate on that job.","isRequired":true,"uniqueKey":"data.candidate_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.candidate_id","typeLabel":"string\u003cuuid> | null"},"assessment_template_id":{"oneOf":[{"type":"string","format":"uuid","description":"Scorecard template UUID used to score.","isRequired":true,"uniqueKey":"data.assessment_template_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","description":"Scorecard template UUID used to score.","isRequired":true,"uniqueKey":"data.assessment_template_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.assessment_template_id","typeLabel":"string\u003cuuid> | null"},"template":{"type":"object","description":"Embedded template summary.","required":["id","name","rating_scale"],"properties":{"id":{"type":"string","format":"uuid","description":"Scorecard template UUID.","isRequired":true,"uniqueKey":"data.template.id","typeLabel":"string\u003cuuid>"},"name":{"type":"string","description":"Template name.","isRequired":true,"uniqueKey":"data.template.name","typeLabel":"string"},"rating_scale":{"type":"integer","description":"Template rating scale (3, 4, 5, or 10).","isRequired":true,"uniqueKey":"data.template.rating_scale","typeLabel":"integer"}},"isRequired":true,"uniqueKey":"data.template","typeLabel":"object"},"job":{"type":"object","description":"Embedded job summary (when job_id is set).","required":["id","title","company_name"],"properties":{"id":{"type":"string","format":"uuid","description":"Job UUID.","isRequired":true,"uniqueKey":"data.job.id","typeLabel":"string\u003cuuid>"},"title":{"type":"string","description":"Job title.","isRequired":true,"uniqueKey":"data.job.title","typeLabel":"string"},"company_name":{"oneOf":[{"type":"string","description":"Company name attached to the job.","isRequired":true,"uniqueKey":"data.job.company_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Company name attached to the job.","isRequired":true,"uniqueKey":"data.job.company_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.job.company_name","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"data.job","typeLabel":"object"},"created_by":{"type":"object","description":"Team member who created the scorecard.","required":["id","first_name","last_name"],"properties":{"id":{"type":"string","format":"uuid","description":"Team member UUID.","isRequired":true,"uniqueKey":"data.created_by.id","typeLabel":"string\u003cuuid>"},"first_name":{"oneOf":[{"type":"string","description":"First name.","isRequired":true,"uniqueKey":"data.created_by.first_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"First name.","isRequired":true,"uniqueKey":"data.created_by.first_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.created_by.first_name","typeLabel":"string | null"},"last_name":{"oneOf":[{"type":"string","description":"Last name.","isRequired":true,"uniqueKey":"data.created_by.last_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Last name.","isRequired":true,"uniqueKey":"data.created_by.last_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.created_by.last_name","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"data.created_by","typeLabel":"object"},"overall_rating":{"oneOf":[{"type":"number","description":"Overall numeric score (0 to template rating_scale). Null when only criterion-level ratings or a note were left.","isRequired":true,"uniqueKey":"data.overall_rating.oneOf.0","typeLabel":"number"},{"type":"null","description":"Overall numeric score (0 to template rating_scale). Null when only criterion-level ratings or a note were left.","isRequired":true,"uniqueKey":"data.overall_rating.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.overall_rating","typeLabel":"number | null"},"overall_comment":{"oneOf":[{"type":"string","description":"Plain-text overall summary note. Null when not provided.","isRequired":true,"uniqueKey":"data.overall_comment.oneOf.0","typeLabel":"string"},{"type":"null","description":"Plain-text overall summary note. Null when not provided.","isRequired":true,"uniqueKey":"data.overall_comment.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.overall_comment","typeLabel":"string | null"},"is_starred":{"type":"boolean","description":"Whether this scorecard is starred (highlighted as the primary scorecard).","isRequired":true,"uniqueKey":"data.is_starred","typeLabel":"boolean"},"is_draft":{"type":"boolean","description":"Whether this scorecard is an incomplete draft. Drafts can be resumed later and are excluded from people-list averages and client share links.","isRequired":true,"uniqueKey":"data.is_draft","typeLabel":"boolean"},"visible_in_client_share_link":{"type":"boolean","description":"Whether this scorecard is included on the client share link for the linked job.","isRequired":true,"uniqueKey":"data.visible_in_client_share_link","typeLabel":"boolean"},"criterion_ratings":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Criterion rating UUID.","isRequired":true,"uniqueKey":"data.criterion_ratings.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"criterion_id":{"type":"string","format":"uuid","description":"Assessment template criterion UUID.","isRequired":true,"uniqueKey":"data.criterion_ratings.items.[INDEX].criterion_id","typeLabel":"string\u003cuuid>"},"criterion_name":{"oneOf":[{"type":"string","description":"Display name of the criterion.","isRequired":true,"uniqueKey":"data.criterion_ratings.items.[INDEX].criterion_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Display name of the criterion.","isRequired":true,"uniqueKey":"data.criterion_ratings.items.[INDEX].criterion_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.criterion_ratings.items.[INDEX].criterion_name","typeLabel":"string | null"},"importance":{"oneOf":[{"type":"string","enum":["must_have","nice_to_have"],"description":"Criterion importance weighting.","isRequired":true,"uniqueKey":"data.criterion_ratings.items.[INDEX].importance.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["must_have","nice_to_have"],"description":"Criterion importance weighting.","isRequired":true,"uniqueKey":"data.criterion_ratings.items.[INDEX].importance.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.criterion_ratings.items.[INDEX].importance","typeLabel":"enum\u003cstring> | null"},"position":{"oneOf":[{"type":"number","description":"Display position of the criterion.","isRequired":true,"uniqueKey":"data.criterion_ratings.items.[INDEX].position.oneOf.0","typeLabel":"number"},{"type":"null","description":"Display position of the criterion.","isRequired":true,"uniqueKey":"data.criterion_ratings.items.[INDEX].position.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.criterion_ratings.items.[INDEX].position","typeLabel":"number | null"},"rating":{"oneOf":[{"type":"number","description":"Numeric score (0 to rating_scale). Null when only a comment was left.","isRequired":true,"uniqueKey":"data.criterion_ratings.items.[INDEX].rating.oneOf.0","typeLabel":"number"},{"type":"null","description":"Numeric score (0 to rating_scale). Null when only a comment was left.","isRequired":true,"uniqueKey":"data.criterion_ratings.items.[INDEX].rating.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.criterion_ratings.items.[INDEX].rating","typeLabel":"number | null"},"comment":{"oneOf":[{"type":"string","description":"Plain-text comment for this criterion. Null when no comment was left.","isRequired":true,"uniqueKey":"data.criterion_ratings.items.[INDEX].comment.oneOf.0","typeLabel":"string"},{"type":"null","description":"Plain-text comment for this criterion. Null when no comment was left.","isRequired":true,"uniqueKey":"data.criterion_ratings.items.[INDEX].comment.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.criterion_ratings.items.[INDEX].comment","typeLabel":"string | null"}},"required":["id","criterion_id","criterion_name","importance","position","rating","comment"],"uniqueKey":"data.criterion_ratings.items.[INDEX]","typeLabel":"object"},"description":"Per-criterion ratings and comments, sorted by criterion position.","isRequired":true,"uniqueKey":"data.criterion_ratings","typeLabel":"object[]"},"created_at":{"type":"string","description":"ISO 8601 creation timestamp.","isRequired":true,"uniqueKey":"data.created_at","typeLabel":"string"},"updated_at":{"type":"string","description":"ISO 8601 last-updated timestamp.","isRequired":true,"uniqueKey":"data.updated_at","typeLabel":"string"}},"required":["id","person_id","job_id","candidate_id","assessment_template_id","template","job","created_by","overall_rating","overall_comment","is_starred","is_draft","visible_in_client_share_link","criterion_ratings","created_at","updated_at"],"isRequired":true,"uniqueKey":"data","typeLabel":"object"}},"required":["success","data"],"uniqueKey":"","typeLabel":"object"},"example":{"success":true,"data":{"id":"ddddeeee-1111-2222-3333-444444444444","person_id":"123e4567-e89b-12d3-a456-426614174000","job_id":"456e7890-e12b-34d5-a678-901234567890","candidate_id":"eeeeffff-1111-2222-3333-444444444444","assessment_template_id":"aaaa1111-2222-3333-4444-555555555555","template":{"id":"aaaa1111-2222-3333-4444-555555555555","name":"Senior Backend Engineer Scorecard","rating_scale":5},"job":{"id":"456e7890-e12b-34d5-a678-901234567890","title":"Senior Backend Engineer","company_name":"Acme Inc."},"created_by":{"id":"567e8901-e23c-45d6-e789-012345678901","first_name":"Jane","last_name":"Smith"},"overall_rating":4.5,"overall_comment":"Strong systems-design depth and excellent async collaboration. Recommend moving forward.","is_starred":true,"is_draft":false,"visible_in_client_share_link":false,"criterion_ratings":[{"id":"cc11aa22-3333-4444-5555-666666666666","criterion_id":"bbbb1111-2222-3333-4444-555555555555","criterion_name":"System design depth","importance":"must_have","position":1,"rating":5,"comment":"Designed a multi-region payments service with clear failure-mode reasoning."},{"id":"cc11aa22-3333-4444-5555-777777777777","criterion_id":"cccc1111-2222-3333-4444-555555555555","criterion_name":"Async collaboration","importance":"nice_to_have","position":2,"rating":4,"comment":"Strong written communication; decision log was thorough."}],"created_at":"2026-06-01T10:00:00Z","updated_at":"2026-06-01T10:00:00Z"}},"examples":{"Example":{"title":"Example","value":{"success":true,"data":{"id":"ddddeeee-1111-2222-3333-444444444444","person_id":"123e4567-e89b-12d3-a456-426614174000","job_id":"456e7890-e12b-34d5-a678-901234567890","candidate_id":"eeeeffff-1111-2222-3333-444444444444","assessment_template_id":"aaaa1111-2222-3333-4444-555555555555","template":{"id":"aaaa1111-2222-3333-4444-555555555555","name":"Senior Backend Engineer Scorecard","rating_scale":5},"job":{"id":"456e7890-e12b-34d5-a678-901234567890","title":"Senior Backend Engineer","company_name":"Acme Inc."},"created_by":{"id":"567e8901-e23c-45d6-e789-012345678901","first_name":"Jane","last_name":"Smith"},"overall_rating":4.5,"overall_comment":"Strong systems-design depth and excellent async collaboration. Recommend moving forward.","is_starred":true,"is_draft":false,"visible_in_client_share_link":false,"criterion_ratings":[{"id":"cc11aa22-3333-4444-5555-666666666666","criterion_id":"bbbb1111-2222-3333-4444-555555555555","criterion_name":"System design depth","importance":"must_have","position":1,"rating":5,"comment":"Designed a multi-region payments service with clear failure-mode reasoning."},{"id":"cc11aa22-3333-4444-5555-777777777777","criterion_id":"cccc1111-2222-3333-4444-555555555555","criterion_name":"Async collaboration","importance":"nice_to_have","position":2,"rating":4,"comment":"Strong written communication; decision log was thorough."}],"created_at":"2026-06-01T10:00:00Z","updated_at":"2026-06-01T10:00:00Z"}}}},"exampleType":"examples"}},"exampleType":"examples"},"65f6f309-524f-42f2-81ba-6bc9b2039e2d":{"description":"Validation error","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[false],"description":"Always false for error responses.","isRequired":true,"uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"error":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code (e.g. \"VALIDATION_ERROR\", \"NOT_FOUND\").","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error description.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"type":"object","additionalProperties":{"oneOf":[{}],"uniqueKey":"error.details.additionalProperties","typeLabel":"any"},"description":"Extra facts about the error when they help you fix it, such as a limit and when it resets.","uniqueKey":"error.details","typeLabel":"object"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["success","error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":false,"error":{"code":"\u003cstring>","message":"\u003cstring>","details":{}}}}},"exampleType":"generated"}},"exampleType":"generated"},"1c9ada73-42e7-4845-bd40-374313ae7d66":{"description":"Resource not found","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[false],"description":"Always false for error responses.","isRequired":true,"uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"error":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code (e.g. \"VALIDATION_ERROR\", \"NOT_FOUND\").","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error description.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"type":"object","additionalProperties":{"oneOf":[{}],"uniqueKey":"error.details.additionalProperties","typeLabel":"any"},"description":"Extra facts about the error when they help you fix it, such as a limit and when it resets.","uniqueKey":"error.details","typeLabel":"object"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["success","error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":false,"error":{"code":"\u003cstring>","message":"\u003cstring>","details":{}}}}},"exampleType":"generated"}},"exampleType":"generated"},"5542bf89-8ee9-422c-a990-27477a2f20e3":{"description":"Internal server error","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[false],"description":"Always false for error responses.","isRequired":true,"uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"error":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code (e.g. \"VALIDATION_ERROR\", \"NOT_FOUND\").","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error description.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"type":"object","additionalProperties":{"oneOf":[{}],"uniqueKey":"error.details.additionalProperties","typeLabel":"any"},"description":"Extra facts about the error when they help you fix it, such as a limit and when it resets.","uniqueKey":"error.details","typeLabel":"object"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["success","error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":false,"error":{"code":"\u003cstring>","message":"\u003cstring>","details":{}}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"1a522db3-1c95-4503-bd27-0e07c9bb550d":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Authenticate with a Bearer token: API key, OAuth token, or session token.","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"0f55f676-b9db-4dbe-b3e2-3132b8bc1690":{"url":"https://api.stardex.ai","description":"Production API server"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Authenticate with a Bearer token: API key, OAuth token, or session token.","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Authenticate with a Bearer token: API key, OAuth token, or session token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"api-reference/openapi-v1.json"},"subdomain":"stardex","siteName":"Stardex Help Docs","title":"Create scorecard - Stardex Help Docs","navMaps":{"firstHrefInVersion":{"v1":{"href":"/api-reference/scorecards/create-scorecard","matchLevel":0},"v0 (Deprecated)":{"href":"/api-reference/introduction","matchLevel":3}},"firstHrefInLanguage":{}},"lastModified":"2026-11-02T20:19:18.435Z","originalFileLocation":"api-reference/scorecards/create-scorecard.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=\"Create a new scorecard (candidate evaluation) for a person. Job scoping: pass job_id to attach the scorecard to a specific job. candidate_id is auto-resolved from the (person_id, job_id) candidate record. Criterion ratings: include criterion_ratings to score individual criteria from the template. Each entry must reference a criterion_id belonging to the template and include a rating, a comment, or both. Team member assignment: the scorecard is recorded as created by the calling team member. Pass team_member_id only when authenticating with an API key (no implicit member context). Session and OAuth callers cannot attribute creation to a different member.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Stardex Help Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/stardex/joPRbrJhRInrO3yB/_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/stardex/joPRbrJhRInrO3yB/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/stardex/joPRbrJhRInrO3yB/_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/stardex/joPRbrJhRInrO3yB/_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/stardex/joPRbrJhRInrO3yB/_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/stardex/joPRbrJhRInrO3yB/_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/stardex/joPRbrJhRInrO3yB/_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/stardex/joPRbrJhRInrO3yB/_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/stardex/joPRbrJhRInrO3yB/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create scorecard - Stardex Help Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Create a new scorecard (candidate evaluation) for a person. Job scoping: pass job_id to attach the scorecard to a specific job. candidate_id is auto-resolved from the (person_id, job_id) candidate record. Criterion ratings: include criterion_ratings to score individual criteria from the template. Each entry must reference a criterion_id belonging to the template and include a rating, a comment, or both. Team member assignment: the scorecard is recorded as created by the calling team member. Pass team_member_id only when authenticating with an API key (no implicit member context). Session and OAuth callers cannot attribute creation to a different member.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Stardex Help Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.stardex.com/api-reference/scorecards/create-scorecard\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://stardex.mintlify.app/_mintlify/api/og/v2?division=Scorecards\u0026amp;title=Create+scorecard\u0026amp;description=Create+a+new+scorecard+%28candidate+evaluation%29+for+a+person.%0A%0A**Job+scoping**%3A+pass+%60job_id%60+to+attach+the+scorecard+to+a+specific+job.+%60candidate_id%60+is+auto-re\u0026amp;theme=2ff938ec1d7da32d63cb34ec\u0026amp;signature=9ea612da89885e79ae8d83831fa99ed50fb2878ecc254f0e725e8db14ed16fb5\">\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=\"Create scorecard - Stardex Help Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Create a new scorecard (candidate evaluation) for a person. Job scoping: pass job_id to attach the scorecard to a specific job. candidate_id is auto-resolved from the (person_id, job_id) candidate record. Criterion ratings: include criterion_ratings to score individual criteria from the template. Each entry must reference a criterion_id belonging to the template and include a rating, a comment, or both. Team member assignment: the scorecard is recorded as created by the calling team member. Pass team_member_id only when authenticating with an API key (no implicit member context). Session and OAuth callers cannot attribute creation to a different member.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://stardex.mintlify.app/_mintlify/api/og/v2?division=Scorecards\u0026amp;title=Create+scorecard\u0026amp;description=Create+a+new+scorecard+%28candidate+evaluation%29+for+a+person.%0A%0A**Job+scoping**%3A+pass+%60job_id%60+to+attach+the+scorecard+to+a+specific+job.+%60candidate_id%60+is+auto-re\u0026amp;theme=2ff938ec1d7da32d63cb34ec\u0026amp;signature=9ea612da89885e79ae8d83831fa99ed50fb2878ecc254f0e725e8db14ed16fb5\">\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/stardex/joPRbrJhRInrO3yB/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Stardex Help Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#5853f7\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.stardex.com/api-reference/scorecards/create-scorecard\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/scorecards/create-scorecard.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.stardex.com/#organization\",\"name\":\"Stardex Help Docs\",\"url\":\"https://docs.stardex.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/stardex/Unebva7RlCeyAgPy/logo/light.svg?fit=max\u0026auto=format\u0026n=Unebva7RlCeyAgPy\u0026q=85\u0026s=6a32bc87265a1562f0ee3793cb4c66e7\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.stardex.com#website\",\"name\":\"Stardex Help Docs\",\"url\":\"https://docs.stardex.com\",\"publisher\":{\"@id\":\"https://docs.stardex.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.stardex.com/api-reference/scorecards/create-scorecard#webpage\",\"url\":\"https://docs.stardex.com/api-reference/scorecards/create-scorecard\",\"name\":\"Create scorecard\",\"description\":\"Create a new scorecard (candidate evaluation) for a person. Job scoping: pass job_id to attach the scorecard to a specific job. candidate_id is auto-resolved from the (person_id, job_id) candidate record. Criterion ratings: include criterion_ratings to score individual criteria from the template. Each entry must reference a criterion_id belonging to the template and include a rating, a comment, or both. Team member assignment: the scorecard is recorded as created by the calling team member. Pass team_member_id only when authenticating with an API key (no implicit member context). Session and OAuth callers cannot attribute creation to a different member.\",\"dateModified\":\"2026-11-02T20:19:18.435Z\",\"isPartOf\":{\"@id\":\"https://docs.stardex.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.stardex.com/api-reference/scorecards/create-scorecard#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.stardex.com/api-reference/scorecards/create-scorecard#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Scorecards\",\"item\":\"https://docs.stardex.com/api-reference/scorecards/search-scorecard-templates\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create scorecard\",\"item\":\"https://docs.stardex.com/api-reference/scorecards/create-scorecard\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.stardex.com/api-reference/scorecards/create-scorecard#apireference\",\"headline\":\"Create scorecard\",\"name\":\"Create scorecard\",\"description\":\"Create a new scorecard (candidate evaluation) for a person. Job scoping: pass job_id to attach the scorecard to a specific job. candidate_id is auto-resolved from the (person_id, job_id) candidate record. Criterion ratings: include criterion_ratings to score individual criteria from the template. Each entry must reference a criterion_id belonging to the template and include a rating, a comment, or both. Team member assignment: the scorecard is recorded as created by the calling team member. Pass team_member_id only when authenticating with an API key (no implicit member context). Session and OAuth callers cannot attribute creation to a different member.\",\"url\":\"https://docs.stardex.com/api-reference/scorecards/create-scorecard\",\"mainEntityOfPage\":{\"@id\":\"https://docs.stardex.com/api-reference/scorecards/create-scorecard#webpage\"},\"dateModified\":\"2026-11-02T20:19:18.435Z\",\"publisher\":{\"@id\":\"https://docs.stardex.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.stardex.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Stardex Help Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Stardex Help Docs","nav":{"global":{"anchors":[{"anchor":"Home page","icon":"book-open-cover","href":"https://www.stardex.com"},{"anchor":"Blog","icon":"newspaper","href":"https://www.stardex.com/blog"}]},"tabs":[{"tab":"Guides","hidden":true,"pages":[{"title":"Guides","href":"/help-center/ai-activity-updates"}]},{"tab":"Help Center","pages":[{"title":"Help Center","href":"/help-center"}]},{"tab":"Changelog","hidden":true,"pages":[{"title":"Changelog","href":"/changelog-stardex"}]},{"tab":"API Reference","versions":[{"version":"v1","groups":[{"group":"API Documentation","pages":[{"title":"Introduction","href":"/api-reference/introduction-v1"},{"title":"Enrolling people in campaigns","href":"/api-reference/campaigns-guide"}]},{"group":"Activity Reports","pages":[{"title":"Generate an activity \u0026 stage-change report","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/activity-reports","href":"/api-reference/activity-reports/generate-an-activity-\u0026-stage-change-report"}]},{"group":"Automations","pages":[{"title":"Search automations","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/automations/search","href":"/api-reference/automations/search-automations"},{"title":"List automation trigger types","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/automations/trigger-types","href":"/api-reference/automations/list-automation-trigger-types"},{"title":"List automation action types","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/automations/action-types","href":"/api-reference/automations/list-automation-action-types"},{"title":"List automation run statuses","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/automations/run-statuses","href":"/api-reference/automations/list-automation-run-statuses"},{"title":"Get automation by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/automations/{id}","href":"/api-reference/automations/get-automation-by-id"},{"title":"Archive automation","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json delete /v1/automations/{id}","href":"/api-reference/automations/archive-automation"},{"title":"Update automation","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json patch /v1/automations/{id}","href":"/api-reference/automations/update-automation"},{"title":"Create automation","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/automations","href":"/api-reference/automations/create-automation"},{"title":"Search automation runs","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/automations/{id}/runs/search","href":"/api-reference/automations/search-automation-runs"},{"title":"Get automation run by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/automations/runs/{runId}","href":"/api-reference/automations/get-automation-run-by-id"}]},{"group":"Calendar Meetings","pages":[{"title":"List calendar meetings","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/calendar-meetings","href":"/api-reference/calendar-meetings/list-calendar-meetings"},{"title":"Get calendar meeting by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/calendar-meetings/{id}","href":"/api-reference/calendar-meetings/get-calendar-meeting-by-id"}]},{"group":"Campaigns","pages":[{"title":"Search campaigns","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/campaigns/search","href":"/api-reference/campaigns/search-campaigns"},{"title":"List campaign types","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/campaigns/types","href":"/api-reference/campaigns/list-campaign-types"},{"title":"List campaign variables","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/campaigns/variables","href":"/api-reference/campaigns/list-campaign-variables"},{"title":"List sending mailboxes","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/campaigns/mailboxes","href":"/api-reference/campaigns/list-sending-mailboxes"},{"title":"Get campaign by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/campaigns/{id}","href":"/api-reference/campaigns/get-campaign-by-id"},{"title":"Update campaign","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json patch /v1/campaigns/{id}","href":"/api-reference/campaigns/update-campaign"},{"title":"Create campaign","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/campaigns","href":"/api-reference/campaigns/create-campaign"},{"title":"Add campaign step","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/campaigns/{id}/steps","href":"/api-reference/campaigns/add-campaign-step"},{"title":"Delete campaign step","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json delete /v1/campaigns/{id}/steps/{step_id}","href":"/api-reference/campaigns/delete-campaign-step"},{"title":"Update campaign step","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json patch /v1/campaigns/{id}/steps/{step_id}","href":"/api-reference/campaigns/update-campaign-step"},{"title":"Reorder campaign steps","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/campaigns/{id}/steps/reorder","href":"/api-reference/campaigns/reorder-campaign-steps"},{"title":"List enrollment status groups","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/campaigns/enrollment-statuses","href":"/api-reference/campaigns/list-enrollment-status-groups"},{"title":"Prepare an enrollment","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/campaigns/{id}/enrollment-batches","href":"/api-reference/campaigns/prepare-an-enrollment"},{"title":"Get an enrollment batch","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/campaigns/{id}/enrollment-batches/{batch_id}","href":"/api-reference/campaigns/get-an-enrollment-batch"},{"title":"Get one person in a batch","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/campaigns/{id}/enrollment-batches/{batch_id}/recipients/{recipient_id}","href":"/api-reference/campaigns/get-one-person-in-a-batch"},{"title":"Change one person in a batch","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json patch /v1/campaigns/{id}/enrollment-batches/{batch_id}/recipients/{recipient_id}","href":"/api-reference/campaigns/change-one-person-in-a-batch"},{"title":"Add people to a batch","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/campaigns/{id}/enrollment-batches/{batch_id}/recipients","href":"/api-reference/campaigns/add-people-to-a-batch"},{"title":"Start an enrollment","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/campaigns/{id}/enrollment-batches/{batch_id}/start","href":"/api-reference/campaigns/start-an-enrollment"},{"title":"Discard an enrollment batch","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/campaigns/{id}/enrollment-batches/{batch_id}/discard","href":"/api-reference/campaigns/discard-an-enrollment-batch"},{"title":"Search enrollees","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/campaigns/{id}/enrollments/search","href":"/api-reference/campaigns/search-enrollees"},{"title":"Get an enrollee","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/campaigns/{id}/enrollments/{enrollment_id}","href":"/api-reference/campaigns/get-an-enrollee"},{"title":"Edit an enrollee's upcoming step","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json patch /v1/campaigns/{id}/enrollments/{enrollment_id}/steps/{step_id}","href":"/api-reference/campaigns/edit-an-enrollees-upcoming-step"},{"title":"Stop enrollees","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/campaigns/{id}/enrollments/stop","href":"/api-reference/campaigns/stop-enrollees"}]},{"group":"Candidates","pages":[{"title":"Update candidate stage","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/candidates/update-stage","href":"/api-reference/candidates/update-candidate-stage"},{"title":"List rejection reasons","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/candidates/rejection-reasons","href":"/api-reference/candidates/list-rejection-reasons"},{"title":"Get candidate by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/candidates/{id}","href":"/api-reference/candidates/get-candidate-by-id"},{"title":"Remove candidate from job","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json delete /v1/candidates/{id}","href":"/api-reference/candidates/remove-candidate-from-job"}]},{"group":"Client Contacts","pages":[{"title":"List client contact statuses","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/client-contacts/statuses","href":"/api-reference/client-contacts/list-client-contact-statuses"},{"title":"List client contacts","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/client-contacts","href":"/api-reference/client-contacts/list-client-contacts"},{"title":"Create client contact","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/client-contacts","href":"/api-reference/client-contacts/create-client-contact"},{"title":"Get client contact by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/client-contacts/{id}","href":"/api-reference/client-contacts/get-client-contact-by-id"},{"title":"Update client contact","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json patch /v1/client-contacts/{id}","href":"/api-reference/client-contacts/update-client-contact"}]},{"group":"Companies","pages":[{"title":"List company client statuses","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/companies/statuses","href":"/api-reference/companies/list-company-client-statuses"},{"title":"Search companies","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/companies/search","href":"/api-reference/companies/search-companies"},{"title":"Create or update company","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/companies","href":"/api-reference/companies/create-or-update-company"},{"title":"Get company by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/companies/{id}","href":"/api-reference/companies/get-company-by-id"},{"title":"Update company","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json patch /v1/companies/{id}","href":"/api-reference/companies/update-company"},{"title":"List company document types","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/companies/document-types","href":"/api-reference/companies/list-company-document-types"},{"title":"Get company documents","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/companies/{id}/documents","href":"/api-reference/companies/get-company-documents"},{"title":"Upload company document","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/companies/{id}/documents","href":"/api-reference/companies/upload-company-document"}]},{"group":"Company Activities","pages":[{"title":"List company activity types","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/company-activities/types","href":"/api-reference/company-activities/list-company-activity-types"},{"title":"List company activities","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/company-activities","href":"/api-reference/company-activities/list-company-activities"},{"title":"Create company activity (note)","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/company-activities","href":"/api-reference/company-activities/create-company-activity-note"},{"title":"Get company activity by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/company-activities/{id}","href":"/api-reference/company-activities/get-company-activity-by-id"},{"title":"Update company activity (note) by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json patch /v1/company-activities/{id}","href":"/api-reference/company-activities/update-company-activity-note-by-id"}]},{"group":"Company Insights","pages":[{"title":"List AI-extracted insights for a company","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/company-insights","href":"/api-reference/company-insights/list-ai-extracted-insights-for-a-company"},{"title":"Edit content or dismiss/restore an insight","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json patch /v1/company-insights/{id}","href":"/api-reference/company-insights/edit-content-or-dismissrestore-an-insight"},{"title":"Dismiss multiple insights at once","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/company-insights/bulk-dismiss","href":"/api-reference/company-insights/dismiss-multiple-insights-at-once"},{"title":"Manually extract insights from an activity","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/company-insights/trigger","href":"/api-reference/company-insights/manually-extract-insights-from-an-activity"}]},{"group":"Custom Fields","pages":[{"title":"Get person custom field definitions","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/custom-fields/persons","href":"/api-reference/custom-fields/get-person-custom-field-definitions"},{"title":"Get company custom field definitions","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/custom-fields/companies","href":"/api-reference/custom-fields/get-company-custom-field-definitions"},{"title":"Get job custom field definitions","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/custom-fields/jobs","href":"/api-reference/custom-fields/get-job-custom-field-definitions"},{"title":"Get deal custom field definitions","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/custom-fields/deals","href":"/api-reference/custom-fields/get-deal-custom-field-definitions"}]},{"group":"Deal Activities","pages":[{"title":"List deal activities","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/deal-activities","href":"/api-reference/deal-activities/list-deal-activities"},{"title":"Create deal activity (note)","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/deal-activities","href":"/api-reference/deal-activities/create-deal-activity-note"},{"title":"Get deal activity by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/deal-activities/{id}","href":"/api-reference/deal-activities/get-deal-activity-by-id"},{"title":"Update deal activity (note) by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json patch /v1/deal-activities/{id}","href":"/api-reference/deal-activities/update-deal-activity-note-by-id"}]},{"group":"Deals","pages":[{"title":"List deal statuses","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/deals/statuses","href":"/api-reference/deals/list-deal-statuses"},{"title":"Search deals","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/deals/search","href":"/api-reference/deals/search-deals"},{"title":"Get deal by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/deals/{id}","href":"/api-reference/deals/get-deal-by-id"},{"title":"Archive deal","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json delete /v1/deals/{id}","href":"/api-reference/deals/archive-deal"},{"title":"Update deal","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json patch /v1/deals/{id}","href":"/api-reference/deals/update-deal"},{"title":"Create deal","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/deals","href":"/api-reference/deals/create-deal"}]},{"group":"Retainer Packs","pages":[{"title":"List fee statuses","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/fee-statuses","href":"/api-reference/retainer-packs/list-fee-statuses"},{"title":"List retainer packs","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/retainer-packs","href":"/api-reference/retainer-packs/list-retainer-packs"},{"title":"Create a retainer pack","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/retainer-packs","href":"/api-reference/retainer-packs/create-a-retainer-pack"},{"title":"Get a retainer pack","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/retainer-packs/{id}","href":"/api-reference/retainer-packs/get-a-retainer-pack"},{"title":"Delete a retainer pack","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json delete /v1/retainer-packs/{id}","href":"/api-reference/retainer-packs/delete-a-retainer-pack"},{"title":"Update a retainer pack","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json patch /v1/retainer-packs/{id}","href":"/api-reference/retainer-packs/update-a-retainer-pack"},{"title":"Close a retainer pack","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/retainer-packs/{id}/close","href":"/api-reference/retainer-packs/close-a-retainer-pack"},{"title":"Reopen a retainer pack","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/retainer-packs/{id}/reopen","href":"/api-reference/retainer-packs/reopen-a-retainer-pack"},{"title":"Add an adjustment to a closed retainer pack","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/retainer-packs/{id}/adjustments","href":"/api-reference/retainer-packs/add-an-adjustment-to-a-closed-retainer-pack"},{"title":"Delete a retainer pack adjustment","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json delete /v1/retainer-packs/{id}/adjustments/{adjustment_id}","href":"/api-reference/retainer-packs/delete-a-retainer-pack-adjustment"},{"title":"Delete an open retainer from a pack","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json delete /v1/retainer-packs/{id}/retainers/{retainer_id}","href":"/api-reference/retainer-packs/delete-an-open-retainer-from-a-pack"},{"title":"Replace a claimed retainer's split","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json put /v1/retainer-packs/{id}/retainers/{retainer_id}/split","href":"/api-reference/retainer-packs/replace-a-claimed-retainers-split"}]},{"group":"Job Activities","pages":[{"title":"List job activities","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/job-activities","href":"/api-reference/job-activities/list-job-activities"},{"title":"Create job activity (note)","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/job-activities","href":"/api-reference/job-activities/create-job-activity-note"},{"title":"Get job activity by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/job-activities/{id}","href":"/api-reference/job-activities/get-job-activity-by-id"},{"title":"Update job activity (note) by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json patch /v1/job-activities/{id}","href":"/api-reference/job-activities/update-job-activity-note-by-id"}]},{"group":"Job Offers","pages":[{"title":"List job offer statuses","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/job-offers/statuses","href":"/api-reference/job-offers/list-job-offer-statuses"},{"title":"List job offers","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/job-offers","href":"/api-reference/job-offers/list-job-offers"}]},{"group":"Jobs","pages":[{"title":"List jobs (deprecated)","deprecated":true,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/jobs","href":"/api-reference/jobs/list-jobs-deprecated"},{"title":"Create job","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/jobs","href":"/api-reference/jobs/create-job"},{"title":"Search jobs","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/jobs/search","href":"/api-reference/jobs/search-jobs"},{"title":"Get job by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/jobs/{id}","href":"/api-reference/jobs/get-job-by-id"},{"title":"Update job","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json patch /v1/jobs/{id}","href":"/api-reference/jobs/update-job"},{"title":"List job candidates","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/jobs/{id}/candidates","href":"/api-reference/jobs/list-job-candidates"},{"title":"List job applicants","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/jobs/{id}/applicants","href":"/api-reference/jobs/list-job-applicants"},{"title":"List job document types","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/jobs/document-types","href":"/api-reference/jobs/list-job-document-types"},{"title":"Get job documents","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/jobs/{id}/documents","href":"/api-reference/jobs/get-job-documents"},{"title":"Upload job document","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/jobs/{id}/documents","href":"/api-reference/jobs/upload-job-document"},{"title":"Add job target companies","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/jobs/{id}/target-companies","href":"/api-reference/jobs/add-job-target-companies"},{"title":"Remove job target companies","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json delete /v1/jobs/{id}/target-companies","href":"/api-reference/jobs/remove-job-target-companies"},{"title":"List job team member roles","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/jobs/team-member-roles","href":"/api-reference/jobs/list-job-team-member-roles"},{"title":"Get job pack retainer split","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/jobs/{id}/pack-retainer-split","href":"/api-reference/jobs/get-job-pack-retainer-split"},{"title":"Set job pack retainer split","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json put /v1/jobs/{id}/pack-retainer-split","href":"/api-reference/jobs/set-job-pack-retainer-split"},{"title":"List job referral partners","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/jobs/{id}/referral-partners","href":"/api-reference/jobs/list-job-referral-partners"},{"title":"Add job referral partner","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/jobs/{id}/referral-partners","href":"/api-reference/jobs/add-job-referral-partner"},{"title":"Remove job referral partner","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json delete /v1/jobs/{id}/referral-partners/{client_contact_id}","href":"/api-reference/jobs/remove-job-referral-partner"},{"title":"Update job referral partner","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json patch /v1/jobs/{id}/referral-partners/{client_contact_id}","href":"/api-reference/jobs/update-job-referral-partner"},{"title":"List job statuses","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/jobs/statuses","href":"/api-reference/jobs/list-job-statuses"},{"title":"List pipeline stages","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/jobs/pipeline-stages","href":"/api-reference/jobs/list-pipeline-stages"}]},{"group":"Lists","pages":[{"title":"Search lists","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/lists/search","href":"/api-reference/lists/search-lists"},{"title":"Get list by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/lists/{id}","href":"/api-reference/lists/get-list-by-id"},{"title":"Create list","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/lists","href":"/api-reference/lists/create-list"},{"title":"Add list items","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/lists/{id}/items","href":"/api-reference/lists/add-list-items"},{"title":"Remove list items","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json delete /v1/lists/{id}/items","href":"/api-reference/lists/remove-list-items"}]},{"group":"Meeting Recordings","pages":[{"title":"List meeting recordings","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/meeting-recordings","href":"/api-reference/meeting-recordings/list-meeting-recordings"},{"title":"Get meeting recording by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/meeting-recordings/{id}","href":"/api-reference/meeting-recordings/get-meeting-recording-by-id"}]},{"group":"Person Activities","pages":[{"title":"List person activity types","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/person-activities/types","href":"/api-reference/person-activities/list-person-activity-types"},{"title":"Create person activity","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/person-activities","href":"/api-reference/person-activities/create-person-activity"},{"title":"Get person activity by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/person-activities/{id}","href":"/api-reference/person-activities/get-person-activity-by-id"},{"title":"Delete person activity by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json delete /v1/person-activities/{id}","href":"/api-reference/person-activities/delete-person-activity-by-id"},{"title":"Update person activity by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json patch /v1/person-activities/{id}","href":"/api-reference/person-activities/update-person-activity-by-id"}]},{"group":"Persons","pages":[{"title":"List person reference types","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/persons/reference-types","href":"/api-reference/persons/list-person-reference-types"},{"title":"Create person reference","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/persons/{id}/references","href":"/api-reference/persons/create-person-reference"},{"title":"Delete person reference","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json delete /v1/persons/{id}/references/{reference_id}","href":"/api-reference/persons/delete-person-reference"},{"title":"Update person reference","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json patch /v1/persons/{id}/references/{reference_id}","href":"/api-reference/persons/update-person-reference"},{"title":"List persons (deprecated)","deprecated":true,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/persons","href":"/api-reference/persons/list-persons-deprecated"},{"title":"Create person","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/persons","href":"/api-reference/persons/create-person"},{"title":"Advanced person search","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/persons/search","href":"/api-reference/persons/advanced-person-search"},{"title":"Get person by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/persons/{id}","href":"/api-reference/persons/get-person-by-id"},{"title":"Update person","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json patch /v1/persons/{id}","href":"/api-reference/persons/update-person"},{"title":"Create person compensation","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/persons/{id}/compensations","href":"/api-reference/persons/create-person-compensation"},{"title":"Delete person compensation","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json delete /v1/persons/{id}/compensations/{compensation_id}","href":"/api-reference/persons/delete-person-compensation"},{"title":"Update person compensation","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json patch /v1/persons/{id}/compensations/{compensation_id}","href":"/api-reference/persons/update-person-compensation"},{"title":"Get unified person activities","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/persons/{id}/activities","href":"/api-reference/persons/get-unified-person-activities"},{"title":"Get person documents","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/persons/{id}/documents","href":"/api-reference/persons/get-person-documents"},{"title":"Upload person document","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/persons/{id}/documents","href":"/api-reference/persons/upload-person-document"},{"title":"List person document types","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/persons/document-types","href":"/api-reference/persons/list-person-document-types"},{"title":"Set preferred email (bulk)","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/persons/preferred-email","href":"/api-reference/persons/set-preferred-email-bulk"},{"title":"Set preferred phone (bulk)","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/persons/preferred-phone","href":"/api-reference/persons/set-preferred-phone-bulk"},{"title":"Mark emails as bounced (bulk)","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/persons/email-bounced","href":"/api-reference/persons/mark-emails-as-bounced-bulk"},{"title":"Remove emails (bulk)","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/persons/emails/delete","href":"/api-reference/persons/remove-emails-bulk"},{"title":"Set preferred email","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/persons/{id}/preferred-email","href":"/api-reference/persons/set-preferred-email"},{"title":"Set preferred phone","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/persons/{id}/preferred-phone","href":"/api-reference/persons/set-preferred-phone"},{"title":"Enrich person contact details","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/persons/{id}/enrich","href":"/api-reference/persons/enrich-person-contact-details"}]},{"group":"Scorecards","pages":[{"title":"Search scorecard templates","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/scorecard-templates/search","href":"/api-reference/scorecards/search-scorecard-templates"},{"title":"Get scorecard template by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/scorecard-templates/{id}","href":"/api-reference/scorecards/get-scorecard-template-by-id"},{"title":"Archive scorecard template","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json delete /v1/scorecard-templates/{id}","href":"/api-reference/scorecards/archive-scorecard-template"},{"title":"Update scorecard template","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json patch /v1/scorecard-templates/{id}","href":"/api-reference/scorecards/update-scorecard-template"},{"title":"Create scorecard template","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/scorecard-templates","href":"/api-reference/scorecards/create-scorecard-template"},{"title":"Search scorecards","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/scorecards/search","href":"/api-reference/scorecards/search-scorecards"},{"title":"Get scorecard by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/scorecards/{id}","href":"/api-reference/scorecards/get-scorecard-by-id"},{"title":"Delete scorecard","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json delete /v1/scorecards/{id}","href":"/api-reference/scorecards/delete-scorecard"},{"title":"Update scorecard","description":"Update an existing scorecard. Only provided fields are modified.\n\n**Criterion ratings**: when `criterion_ratings` is provided, all existing criterion ratings on this scorecard are replaced. Pass an empty array to clear them.\n\n**Team member assignment**: `last_updated_by` is the calling team member. Pass `team_member_id` only when authenticating with an API key.","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json patch /v1/scorecards/{id}","href":"/api-reference/scorecards/update-scorecard"},{"title":"Create scorecard","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/scorecards","href":"/api-reference/scorecards/create-scorecard"}]},{"group":"Tasks","pages":[{"title":"Search tasks","description":"Search and filter tasks with pagination and sorting.\n\n**Filters**: `keywords` (full-text search on task content), `task_types` (array of enum values), `related_to` + `related_record_type` (entity association), `is_completed` (boolean), `owner_ids` (assigned team members), `due_date_start` / `due_date_end` (date range — tasks with no due date are excluded).\n\n**Sorting**: `sort_by` — one of `created_at` (default), `updated_at`, `due_date`. `sort_order` — `asc` or `desc` (default).\n\n**Pagination**: `offset` and `limit` (max 100).","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/tasks/search","href":"/api-reference/tasks/search-tasks"},{"title":"Get task by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/tasks/{id}","href":"/api-reference/tasks/get-task-by-id"},{"title":"Delete task","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json delete /v1/tasks/{id}","href":"/api-reference/tasks/delete-task"},{"title":"Update task","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json patch /v1/tasks/{id}","href":"/api-reference/tasks/update-task"},{"title":"Create task","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/tasks","href":"/api-reference/tasks/create-task"}]},{"group":"Team Capacity","pages":[{"title":"Get the Team Capacity report","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/team-capacity","href":"/api-reference/team-capacity/get-the-team-capacity-report"},{"title":"Update Team Capacity settings","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json patch /v1/team-capacity/settings","href":"/api-reference/team-capacity/update-team-capacity-settings"}]},{"group":"Team Members","pages":[{"title":"List team members","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/team-members","href":"/api-reference/team-members/list-team-members"},{"title":"Get team member by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/team-members/{id}","href":"/api-reference/team-members/get-team-member-by-id"}]},{"group":"Webhooks","pages":[{"title":"Get webhook management portal URL","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/webhooks/portal","href":"/api-reference/webhooks/get-webhook-management-portal-url"}]}]},{"version":"v0 (Deprecated)","pages":[{"title":"v0 (Deprecated)","href":"/api-reference/introduction"}]}]},{"tab":"Zapier API Reference","hidden":true,"pages":[{"title":"Zapier API Reference","href":"/api-reference/zapier-introduction"}]}]},"basePath":"","title":"Create scorecard - Stardex Help Docs","buildId":"dpl_36EDyZCDfRuoUD9af5CH4M1bqY2h","deploymentId":"dpl_36EDyZCDfRuoUD9af5CH4M1bqY2h","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DCDCdBVX.js","utils-ME8dDnLe.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-0e84ACsd.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-wgRBj-ia.js","snippetPresets-C11Sgb-o.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-C0lapOpP.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-ZeRQV8fF.js","shallow-BupWh095.js","getApiPlaygroundDisplay-BnYQO2Ss.js","CodeSnippet-RKKOc8c_.js","CodeSnippets-Drf_m8wS.js","Page-Bevw23-4.js","getPastedJson-u6QiPzNZ.js","icon-Bb-CBSxO.js","MethodPill-F7l5AI7V.js","DuplicateIcon-IiAXkdSg.js","createIcon-FliI8EBc.js","DynamicMarkdown-B62XqCSI.js","SectionHeading-Dj31pT03.js","axios-vUo_bRtp.js","Markdown-BOgQCTwD.js","clsx-BIWXJmsZ.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-DKZWslLH.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-UDqbR6xh.js"]}