{
"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
List candidate segments
The company’s saved candidate segments with their member counts, or, with segment_id, one segment in full: rules, analytics and the positions it feeds. Counts leave out candidates hidden from you by position access. To list the members, use the candidate search (merchant-candidate-list).
Segments, last changed first; with segment_id, that one segment.
Show child attributes
{"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/list-candidate-segments","slug":"/api-reference/candidates/list-candidate-segments","pageMetadata":{"title":"List candidate segments","description":"The company's saved candidate segments with their member counts, or, with segment_id, one segment in full: rules, analytics and the positions it feeds. Counts leave out candidates hidden from you by position access. To list the members, use the candidate search (merchant-candidate-list).","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi get /merchant-segment-list","href":"/api-reference/candidates/list-candidate-segments","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: \"The company’s saved candidate segments with their member counts, or, with segment_id, one segment in full: rules, analytics and the positions it feeds. Counts leave out candidates hidden from you by position access. To list the members, use the candidate search (merchant-candidate-list).\"\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":"List candidate segments","description":"The company's saved candidate segments with their member counts, or, with segment_id, one segment in full: rules, analytics and the positions it feeds. Counts leave out candidates hidden from you by position access. To list the members, use the candidate search (merchant-candidate-list).","deprecated":null,"version":null,"openapi":"https://cool.jobmojito.com/functions/v1/openapi get /merchant-segment-list","href":"/api-reference/candidates/list-candidate-segments","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Candidates"],"summary":"List candidate segments","description":"The company's saved candidate segments with their member counts, or, with segment_id, one segment in full: rules, analytics and the positions it feeds. Counts leave out candidates hidden from you by position access. To list the members, use the candidate search (merchant-candidate-list).","security":["cb879026-4b5c-40c9-9377-437df26c1c67"],"parameters":["6f9399b4-ce2a-4286-bedf-202a7386d186","266b92c7-36a7-4412-ac22-5a582c6d8b9d"],"responses":{"200":"022e2ece-098c-412d-a0eb-52b2aab84601","401":"bc30d24d-5131-435c-81a8-0a4ecf3b9e37","403":"2142c940-729a-4b7e-85fa-8f41e604b83e","404":"1994131d-0e1b-4e74-8523-ab0774ca8663","422":"c4f32db7-dc8d-40a4-b939-33e0a7c50eca","500":"a44cc488-e40b-4fe0-9fc5-e3dab4892c9f"},"method":"get","type":"path","servers":["454fcb62-7052-4847-a728-ecf5ade065a6"],"path":"/merchant-segment-list","baseUrlOptions":["https://cool.jobmojito.com/functions/v1"],"title":"List candidate segments","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"6f9399b4-ce2a-4286-bedf-202a7386d186":{"schema":{"type":"string","format":"uuid","description":"Optional merchant to scope to. Admins and sub-merchant operators only; other callers always use their token's merchant.","example":"28106cba-1c27-4e53-b149-32113e5e8e31","isRequired":false,"uniqueKey":"","typeLabel":"string\u003cuuid>"},"required":false,"name":"merchant_id","in":"query"},"266b92c7-36a7-4412-ac22-5a582c6d8b9d":{"schema":{"type":"string","format":"uuid","description":"Segment id (profile_interview_segment.id). With it, the answer holds that one segment with its rules, analytics and position links.","isRequired":false,"uniqueKey":"","typeLabel":"string\u003cuuid>"},"required":false,"name":"segment_id","in":"query"}},"responses":{"022e2ece-098c-412d-a0eb-52b2aab84601":{"description":"The segments.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Segment id (profile_interview_segment.id).","isRequired":true,"uniqueKey":"data.items.[INDEX].id","typeLabel":"string"},"name":{"type":"string","description":"Segment name.","isRequired":true,"uniqueKey":"data.items.[INDEX].name","typeLabel":"string"},"kind":{"type":"string","enum":["dynamic","static"],"description":"dynamic: members are the candidates matching the rules now; static: a fixed list of candidates.","isRequired":true,"uniqueKey":"data.items.[INDEX].kind","typeLabel":"enum\u003cstring>"},"member_count":{"type":"integer","description":"Members visible to you.","isRequired":true,"uniqueKey":"data.items.[INDEX].member_count","typeLabel":"integer"},"description":{"type":"string","description":"Description.","uniqueKey":"data.items.[INDEX].description","typeLabel":"string"},"created_by_name":{"type":"string","description":"Who made it.","uniqueKey":"data.items.[INDEX].created_by_name","typeLabel":"string"},"created_at":{"type":"string","description":"Created (ISO 8601).","uniqueKey":"data.items.[INDEX].created_at","typeLabel":"string"},"updated_at":{"type":"string","description":"Last changed (ISO 8601).","uniqueKey":"data.items.[INDEX].updated_at","typeLabel":"string"},"last_action_at":{"type":"string","description":"When a bulk action last ran on it (ISO 8601).","uniqueKey":"data.items.[INDEX].last_action_at","typeLabel":"string"},"rules":{"type":"object","properties":{"match":{"type":"string","enum":["all","any"],"description":"all: a candidate matches every rule; any: at least one.","isRequired":true,"uniqueKey":"data.items.[INDEX].rules.match","typeLabel":"enum\u003cstring>"},"rules":{"type":"array","items":{"type":"object","additionalProperties":{"oneOf":[{},{"type":"null","uniqueKey":"data.items.[INDEX].rules.rules.items.[INDEX].additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].rules.rules.items.[INDEX].additionalProperties","typeLabel":"null"},"uniqueKey":"data.items.[INDEX].rules.rules.items.[INDEX]","typeLabel":"object"},"description":"Up to 20 rules, each { field, op, values | value | days | from | to }, as merchant-candidate-list (rules) accepts them; for example { \"field\": \"tag\", \"op\": \"any\", \"values\": [\"\u003ctag id>\"] }.","isRequired":true,"uniqueKey":"data.items.[INDEX].rules.rules","typeLabel":"object[]"}},"required":["match","rules"],"description":"The rules of a dynamic segment: { match, rules } as merchant-candidate-list takes them (static segments have none). A list answers them only with segment_id.","uniqueKey":"data.items.[INDEX].rules","typeLabel":"object"},"analytics":{"type":"object","properties":{"size":{"type":"integer","description":"Members visible to you.","isRequired":true,"uniqueKey":"data.items.[INDEX].analytics.size","typeLabel":"integer"},"reachable_email":{"type":"integer","description":"Members who can be e-mailed (consent and address).","isRequired":true,"uniqueKey":"data.items.[INDEX].analytics.reachable_email","typeLabel":"integer"},"reachable_sms":{"type":"integer","description":"Members who can get a text message.","isRequired":true,"uniqueKey":"data.items.[INDEX].analytics.reachable_sms","typeLabel":"integer"},"by_status":{"type":"array","items":{"type":"object","properties":{"key":{"oneOf":[{"type":"string","description":"The value (null: unknown).","isRequired":true,"uniqueKey":"data.items.[INDEX].analytics.by_status.items.[INDEX].key.oneOf.0","typeLabel":"string"},{"type":"null","description":"The value (null: unknown).","isRequired":true,"uniqueKey":"data.items.[INDEX].analytics.by_status.items.[INDEX].key.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].analytics.by_status.items.[INDEX].key","typeLabel":"string | null"},"count":{"type":"integer","description":"Members with it.","isRequired":true,"uniqueKey":"data.items.[INDEX].analytics.by_status.items.[INDEX].count","typeLabel":"integer"}},"required":["key","count"],"uniqueKey":"data.items.[INDEX].analytics.by_status.items.[INDEX]","typeLabel":"object"},"description":"Members by application status (invited, in_progress, completed, accepted, rejected, hired, declined, archived).","isRequired":true,"uniqueKey":"data.items.[INDEX].analytics.by_status","typeLabel":"object[]"},"by_country":{"type":"array","items":{"type":"object","properties":{"key":{"oneOf":[{"type":"string","description":"The value (null: unknown).","isRequired":true,"uniqueKey":"data.items.[INDEX].analytics.by_country.items.[INDEX].key.oneOf.0","typeLabel":"string"},{"type":"null","description":"The value (null: unknown).","isRequired":true,"uniqueKey":"data.items.[INDEX].analytics.by_country.items.[INDEX].key.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].analytics.by_country.items.[INDEX].key","typeLabel":"string | null"},"count":{"type":"integer","description":"Members with it.","isRequired":true,"uniqueKey":"data.items.[INDEX].analytics.by_country.items.[INDEX].count","typeLabel":"integer"}},"required":["key","count"],"uniqueKey":"data.items.[INDEX].analytics.by_country.items.[INDEX]","typeLabel":"object"},"description":"Members by country code.","isRequired":true,"uniqueKey":"data.items.[INDEX].analytics.by_country","typeLabel":"object[]"},"by_source":{"type":"array","items":{"type":"object","properties":{"key":{"oneOf":[{"type":"string","description":"The value (null: unknown).","isRequired":true,"uniqueKey":"data.items.[INDEX].analytics.by_source.items.[INDEX].key.oneOf.0","typeLabel":"string"},{"type":"null","description":"The value (null: unknown).","isRequired":true,"uniqueKey":"data.items.[INDEX].analytics.by_source.items.[INDEX].key.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].analytics.by_source.items.[INDEX].key","typeLabel":"string | null"},"count":{"type":"integer","description":"Members with it.","isRequired":true,"uniqueKey":"data.items.[INDEX].analytics.by_source.items.[INDEX].count","typeLabel":"integer"}},"required":["key","count"],"uniqueKey":"data.items.[INDEX].analytics.by_source.items.[INDEX]","typeLabel":"object"},"description":"Members by source channel.","isRequired":true,"uniqueKey":"data.items.[INDEX].analytics.by_source","typeLabel":"object[]"},"by_position":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Position id (position_def_set.id) or interview id (interview_def_set.id).","isRequired":true,"uniqueKey":"data.items.[INDEX].analytics.by_position.items.[INDEX].id","typeLabel":"string"},"name":{"type":"string","description":"Its name.","isRequired":true,"uniqueKey":"data.items.[INDEX].analytics.by_position.items.[INDEX].name","typeLabel":"string"},"count":{"type":"integer","description":"Members who applied or were invited.","isRequired":true,"uniqueKey":"data.items.[INDEX].analytics.by_position.items.[INDEX].count","typeLabel":"integer"}},"required":["id","name","count"],"uniqueKey":"data.items.[INDEX].analytics.by_position.items.[INDEX]","typeLabel":"object"},"description":"The 20 positions and interviews with the most members.","isRequired":true,"uniqueKey":"data.items.[INDEX].analytics.by_position","typeLabel":"object[]"},"applied_by_month":{"type":"array","items":{"type":"object","properties":{"month":{"type":"string","description":"YYYY-MM.","example":"2026-10","isRequired":true,"uniqueKey":"data.items.[INDEX].analytics.applied_by_month.items.[INDEX].month","typeLabel":"string"},"count":{"type":"integer","description":"Applications that month.","isRequired":true,"uniqueKey":"data.items.[INDEX].analytics.applied_by_month.items.[INDEX].count","typeLabel":"integer"}},"required":["month","count"],"uniqueKey":"data.items.[INDEX].analytics.applied_by_month.items.[INDEX]","typeLabel":"object"},"description":"Applications of members in the last 12 months.","isRequired":true,"uniqueKey":"data.items.[INDEX].analytics.applied_by_month","typeLabel":"object[]"},"auto_tags":{"type":"array","items":{"type":"object","properties":{"key":{"oneOf":[{"type":"string","description":"The value (null: unknown).","isRequired":true,"uniqueKey":"data.items.[INDEX].analytics.auto_tags.items.[INDEX].key.oneOf.0","typeLabel":"string"},{"type":"null","description":"The value (null: unknown).","isRequired":true,"uniqueKey":"data.items.[INDEX].analytics.auto_tags.items.[INDEX].key.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].analytics.auto_tags.items.[INDEX].key","typeLabel":"string | null"},"count":{"type":"integer","description":"Members with it.","isRequired":true,"uniqueKey":"data.items.[INDEX].analytics.auto_tags.items.[INDEX].count","typeLabel":"integer"}},"required":["key","count"],"uniqueKey":"data.items.[INDEX].analytics.auto_tags.items.[INDEX]","typeLabel":"object"},"description":"Members by automatic tag (recent_applicant, completed_interview, no_show, inactive_90d, ...).","isRequired":true,"uniqueKey":"data.items.[INDEX].analytics.auto_tags","typeLabel":"object[]"},"recent_actions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Bulk action id (profile_interview_bulk_action.id).","isRequired":true,"uniqueKey":"data.items.[INDEX].analytics.recent_actions.items.[INDEX].id","typeLabel":"string"},"kind":{"type":"string","description":"What the action did (invite, email, sms, whatsapp, tag, ...).","isRequired":true,"uniqueKey":"data.items.[INDEX].analytics.recent_actions.items.[INDEX].kind","typeLabel":"string"},"status":{"type":"string","description":"Its state.","isRequired":true,"uniqueKey":"data.items.[INDEX].analytics.recent_actions.items.[INDEX].status","typeLabel":"string"},"total":{"type":"integer","description":"Candidates it covered.","isRequired":true,"uniqueKey":"data.items.[INDEX].analytics.recent_actions.items.[INDEX].total","typeLabel":"integer"},"done":{"type":"integer","description":"Done.","isRequired":true,"uniqueKey":"data.items.[INDEX].analytics.recent_actions.items.[INDEX].done","typeLabel":"integer"},"skipped":{"type":"integer","description":"Skipped.","isRequired":true,"uniqueKey":"data.items.[INDEX].analytics.recent_actions.items.[INDEX].skipped","typeLabel":"integer"},"failed":{"type":"integer","description":"Failed.","isRequired":true,"uniqueKey":"data.items.[INDEX].analytics.recent_actions.items.[INDEX].failed","typeLabel":"integer"},"created_at":{"type":"string","description":"When it started (ISO 8601).","uniqueKey":"data.items.[INDEX].analytics.recent_actions.items.[INDEX].created_at","typeLabel":"string"},"finished_at":{"type":"string","description":"When it finished (ISO 8601).","uniqueKey":"data.items.[INDEX].analytics.recent_actions.items.[INDEX].finished_at","typeLabel":"string"}},"required":["id","kind","status","total","done","skipped","failed"],"uniqueKey":"data.items.[INDEX].analytics.recent_actions.items.[INDEX]","typeLabel":"object"},"description":"The last 20 bulk actions run on this segment (read only).","isRequired":true,"uniqueKey":"data.items.[INDEX].analytics.recent_actions","typeLabel":"object[]"}},"required":["size","reachable_email","reachable_sms","by_status","by_country","by_source","by_position","applied_by_month","auto_tags","recent_actions"],"description":"With segment_id only: counts over the members.","uniqueKey":"data.items.[INDEX].analytics","typeLabel":"object"},"links":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Link id (profile_interview_segment_position_link.id).","isRequired":true,"uniqueKey":"data.items.[INDEX].links.items.[INDEX].id","typeLabel":"string"},"def_id":{"type":"string","description":"Position id (position_def_set.id) or interview id (interview_def_set.id).","isRequired":true,"uniqueKey":"data.items.[INDEX].links.items.[INDEX].def_id","typeLabel":"string"},"def_kind":{"type":"string","enum":["position","interview"],"description":"What def_id is.","isRequired":true,"uniqueKey":"data.items.[INDEX].links.items.[INDEX].def_kind","typeLabel":"enum\u003cstring>"},"mode":{"type":"string","enum":["approval","automatic"],"description":"Re-engagement mode: approval (a recruiter approves each invitation) or automatic.","isRequired":true,"uniqueKey":"data.items.[INDEX].links.items.[INDEX].mode","typeLabel":"enum\u003cstring>"},"def_name":{"type":"string","description":"Its name.","uniqueKey":"data.items.[INDEX].links.items.[INDEX].def_name","typeLabel":"string"},"def_status":{"type":"string","description":"Its status.","uniqueKey":"data.items.[INDEX].links.items.[INDEX].def_status","typeLabel":"string"},"created_at":{"type":"string","description":"When the link was made (ISO 8601).","uniqueKey":"data.items.[INDEX].links.items.[INDEX].created_at","typeLabel":"string"}},"required":["id","def_id","def_kind","mode"],"uniqueKey":"data.items.[INDEX].links.items.[INDEX]","typeLabel":"object"},"description":"With segment_id only: positions and interviews this segment feeds for re-engagement (read only; empty without the segments_v2 switch).","uniqueKey":"data.items.[INDEX].links","typeLabel":"object[]"}},"required":["id","name","kind","member_count"],"uniqueKey":"data.items.[INDEX]","typeLabel":"object"},"description":"Segments, last changed first; with segment_id, that one segment.","isRequired":true,"uniqueKey":"data","typeLabel":"object[]"}},"required":["data"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"data":[{"id":"\u003cstring>","name":"\u003cstring>","kind":"dynamic","member_count":123,"description":"\u003cstring>","created_by_name":"\u003cstring>","created_at":"\u003cstring>","updated_at":"\u003cstring>","last_action_at":"\u003cstring>","rules":{"match":"all","rules":[{}]},"analytics":{"size":123,"reachable_email":123,"reachable_sms":123,"by_status":[{"key":"\u003cstring>","count":123}],"by_country":[{"key":"\u003cstring>","count":123}],"by_source":[{"key":"\u003cstring>","count":123}],"by_position":[{"id":"\u003cstring>","name":"\u003cstring>","count":123}],"applied_by_month":[{"month":"2026-10","count":123}],"auto_tags":[{"key":"\u003cstring>","count":123}],"recent_actions":[{"id":"\u003cstring>","kind":"\u003cstring>","status":"\u003cstring>","total":123,"done":123,"skipped":123,"failed":123,"created_at":"\u003cstring>","finished_at":"\u003cstring>"}]},"links":[{"id":"\u003cstring>","def_id":"\u003cstring>","def_kind":"position","mode":"approval","def_name":"\u003cstring>","def_status":"\u003cstring>","created_at":"\u003cstring>"}]}]}}},"exampleType":"generated"}},"exampleType":"generated"},"bc30d24d-5131-435c-81a8-0a4ecf3b9e37":{"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"},"2142c940-729a-4b7e-85fa-8f41e604b83e":{"description":"Not staff of this 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"},"1994131d-0e1b-4e74-8523-ab0774ca8663":{"description":"No such segment.","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"},"c4f32db7-dc8d-40a4-b939-33e0a7c50eca":{"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"},"a44cc488-e40b-4fe0-9fc5-e3dab4892c9f":{"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":{"cb879026-4b5c-40c9-9377-437df26c1c67":{"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":"List candidate segments - JobMojito Developer / Agent","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-09T15:00:44.553Z","originalFileLocation":"api-reference/candidates/list-candidate-segments.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=\"The company\u0026#x27;s saved candidate segments with their member counts, or, with segment_id, one segment in full: rules, analytics and the positions it feeds. Counts leave out candidates hidden from you by position access. To list the members, use the candidate search (merchant-candidate-list).\">\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=\"List candidate segments - JobMojito Developer / Agent\">\u003cmeta data-mint-head property=\"og:description\" content=\"The company\u0026#x27;s saved candidate segments with their member counts, or, with segment_id, one segment in full: rules, analytics and the positions it feeds. Counts leave out candidates hidden from you by position access. To list the members, use the candidate search (merchant-candidate-list).\">\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/list-candidate-segments\">\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=List+candidate+segments\u0026amp;description=The+company%27s+saved+candidate+segments+with+their+member+counts%2C+or%2C+with+segment_id%2C+one+segment+in+full%3A+rules%2C+analytics+and+the+positions+it+feeds.+Counts+l\u0026amp;theme=87c5e3cf7199050cbbf4cb49\u0026amp;signature=ba97162ce804e30063729f9eb2a483e539520fa999a695db5220221b44a48b80\">\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=\"List candidate segments - JobMojito Developer / Agent\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"The company\u0026#x27;s saved candidate segments with their member counts, or, with segment_id, one segment in full: rules, analytics and the positions it feeds. Counts leave out candidates hidden from you by position access. To list the members, use the candidate search (merchant-candidate-list).\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://jobmojito.mintlify.site/_mintlify/api/og/v2?division=Candidates\u0026amp;title=List+candidate+segments\u0026amp;description=The+company%27s+saved+candidate+segments+with+their+member+counts%2C+or%2C+with+segment_id%2C+one+segment+in+full%3A+rules%2C+analytics+and+the+positions+it+feeds.+Counts+l\u0026amp;theme=87c5e3cf7199050cbbf4cb49\u0026amp;signature=ba97162ce804e30063729f9eb2a483e539520fa999a695db5220221b44a48b80\">\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/list-candidate-segments\">\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/list-candidate-segments.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/list-candidate-segments#webpage\",\"url\":\"https://developer.jobmojito.com/api-reference/candidates/list-candidate-segments\",\"name\":\"List candidate segments\",\"description\":\"The company's saved candidate segments with their member counts, or, with segment_id, one segment in full: rules, analytics and the positions it feeds. Counts leave out candidates hidden from you by position access. To list the members, use the candidate search (merchant-candidate-list).\",\"dateModified\":\"2026-11-09T15:00:44.553Z\",\"isPartOf\":{\"@id\":\"https://developer.jobmojito.com#website\"},\"breadcrumb\":{\"@id\":\"https://developer.jobmojito.com/api-reference/candidates/list-candidate-segments#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developer.jobmojito.com/api-reference/candidates/list-candidate-segments#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Candidates\",\"item\":\"https://developer.jobmojito.com/api-reference/candidates/list-candidates\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"List candidate segments\",\"item\":\"https://developer.jobmojito.com/api-reference/candidates/list-candidate-segments\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developer.jobmojito.com/api-reference/candidates/list-candidate-segments#apireference\",\"headline\":\"List candidate segments\",\"name\":\"List candidate segments\",\"description\":\"The company's saved candidate segments with their member counts, or, with segment_id, one segment in full: rules, analytics and the positions it feeds. Counts leave out candidates hidden from you by position access. To list the members, use the candidate search (merchant-candidate-list).\",\"url\":\"https://developer.jobmojito.com/api-reference/candidates/list-candidate-segments\",\"mainEntityOfPage\":{\"@id\":\"https://developer.jobmojito.com/api-reference/candidates/list-candidate-segments#webpage\"},\"dateModified\":\"2026-11-09T15:00:44.553Z\",\"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","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","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","description":"Marks a possible-duplicate pair as not a duplicate. Both records stay as they are and the pair is not suggested again. Owners, recruiters and admins; both candidates must be visible to you. Needs the duplicate detection switch (duplicate_detection). Dismissing a pair already dismissed changes nothing. Nothing is sent to the candidates.","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","description":"Saves a candidate segment (create or change name, description and rules), deletes one, or adds and removes members of a static segment. Owners, recruiters and admins. Members can only be candidates visible to you; a hidden member is never removed. Deleting cannot be undone through the API. Nothing is sent to candidates: segments only group them.","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":"List candidate segments - 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"]}