Retrieve a list of all pipeline stages configured for opportunities. Each stage represents a step in the sales workflow (e.g., Qualification, Proposal, Negotiation, Closed Won).
GET
/
pipeline
/
opportunities
/
stages
Get opportunity pipeline stages
curl --request GET \ --url https://api.gospott.com/pipeline/opportunities/stages \ --header 'x-api-key: <api-key>'
List of opportunity pipeline stages ordered by position
Show child attributes
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Spott","description":"Documentation for Spott — the AI-native recruitment platform.","colors":{"primary":"#f0610f","light":"#f0610f","dark":"#f0610f"},"logo":{"light":"https://mintcdn.com/spott-docs/Zvbuq2vKGY56oD57/logo/light.svg?fit=max\u0026auto=format\u0026n=Zvbuq2vKGY56oD57\u0026q=85\u0026s=914d6f30a1192b291746dbcd2fc7e0fa","dark":"https://mintcdn.com/spott-docs/Zvbuq2vKGY56oD57/logo/dark.svg?fit=max\u0026auto=format\u0026n=Zvbuq2vKGY56oD57\u0026q=85\u0026s=e88bff4f96607e119e55398351566d54"},"favicon":"https://mintcdn.com/spott-docs/DowUiFW036iA_b71/favicon.png?fit=max\u0026auto=format\u0026n=DowUiFW036iA_b71\u0026q=85\u0026s=4729be45c4d1269ed0fafc43f45bc501","appearance":{"default":"light"},"navbar":{"links":[{"href":"https://spott.io","label":"Website"}],"primary":{"type":"button","label":"Go to app","href":"https://app.spott.io"}},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/spottai","website":"https://spott.io"}},"integrations":{"ga4":{"measurementId":"G-5GMF3213NR"}},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Go to app","icon":"arrow-up-right-from-square","href":"https://app.spott.io"},{"anchor":"Support","icon":"life-ring","href":"/docs/get-started/faq"}]},"languages":[{"language":"en","default":true,"href":""},{"language":"fr","href":"fr"},{"language":"nl","href":"nl"},{"language":"de","href":"de"},{"language":"es","href":"es"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"spott-docs","hasAudioNarration":false,"actualSubdomain":"spott-docs","customDomains":["docs.spott.io"],"gitSource":{"type":"github","owner":"spott-hr","repo":"spott-docs-external","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"collectionId":"f0073665-2f52-4bb5-aaa0-43ce286699bb","liveDeploymentHistoryId":"6adf7247b1764000030afb98","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6adf7247b1764000030afb98"},"feedback":{"thumbs":true},"entitlements":{},"buildId":"6adf7247b1764000030afb98","clientVersion":"0.0.3971","searchFilterCounts":[{"language":"en","tag":"API","count":215},{"language":"en","tag":"Private API","count":211},{"language":"de","tag":"Anleitungen","count":90},{"language":"en","tag":"Guides","count":90},{"language":"es","tag":"Guías","count":90},{"language":"fr","tag":"Guides","count":90},{"language":"nl","tag":"Gidsen","count":90},{"language":"en","tag":"Webhooks","count":55},{"language":"en","tag":"Webhook events","count":54},{"language":"en","tag":"Candidates","count":46},{"language":"de","tag":"Integrationen","count":36},{"language":"en","tag":"Integrations","count":36},{"language":"es","tag":"Integraciones","count":36},{"language":"fr","tag":"Intégrations","count":36},{"language":"nl","tag":"Integraties","count":36},{"language":"de","tag":"Einstellungen und Verwaltung","count":26},{"language":"en","tag":"Settings \u0026 Admin","count":26},{"language":"es","tag":"Configuración y administración","count":26},{"language":"fr","tag":"Paramètres et administration","count":26},{"language":"nl","tag":"Instellingen en beheer","count":26},{"language":"en","tag":"Jobs","count":24},{"language":"en","tag":"Custom Attributes","count":22},{"language":"de","tag":"Einstieg","count":16},{"language":"es","tag":"Primeros pasos","count":16},{"language":"fr","tag":"Prise en main","count":16},{"language":"nl","tag":"Onboarding","count":16},{"language":"de","tag":"Stellen","count":12},{"language":"es","tag":"Vacantes","count":12},{"language":"fr","tag":"Postes","count":12},{"language":"nl","tag":"Vacatures","count":12},{"language":"de","tag":"Kandidaten","count":11},{"language":"de","tag":"Unternehmen, Kontakte und Opportunities","count":11},{"language":"de","tag":"Erste Schritte","count":11},{"language":"de","tag":"Telefonie und Messaging","count":11},{"language":"es","tag":"Candidatos","count":11},{"language":"es","tag":"Empresas, contactos y oportunidades","count":11},{"language":"es","tag":"Introducción","count":11},{"language":"es","tag":"Telefonía y mensajería","count":11},{"language":"fr","tag":"Candidats","count":11},{"language":"fr","tag":"Entreprises, contacts et opportunités","count":11},{"language":"fr","tag":"Démarrer","count":11},{"language":"fr","tag":"Téléphonie et messagerie","count":11},{"language":"nl","tag":"Kandidaten","count":11},{"language":"nl","tag":"Bedrijven, contacten en opportuniteiten","count":11},{"language":"nl","tag":"Aan de slag","count":11},{"language":"nl","tag":"Telefonie en berichten","count":11},{"language":"de","tag":"Kommunikation","count":10},{"language":"es","tag":"Comunicación","count":10},{"language":"fr","tag":"Communication","count":10},{"language":"nl","tag":"Communicatie","count":10}]},"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":"editor-v7-file-tree","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":"pause-universal-search-reconcile","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":"per-site-search-delta","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":"editor-private-page-search","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":"editor-nav-generations","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":"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":"editor-agent-model-picker","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":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"@media (min-width:1024px){#sidebar{top:112px!important;height:calc(100dvh - 112px)!important}}.your-turn{margin:2rem 0;padding:1.25rem 1.5rem;border:1px solid rgb(240 97 15/.25);border-left:3px solid #f0610f;border-radius:.75rem;background:rgb(240 97 15/.04)}.dark .your-turn{border-color:rgb(240 97 15/.3);border-left-color:#f0610f;background:rgb(240 97 15/.07)}.your-turn h2{margin-top:0;margin-bottom:.75rem;font-size:.8125rem;font-weight:600;letter-spacing:.06em;text-transform:uppercase;color:#f0610f}.your-turn>:last-child{margin-bottom:0}.your-turn ul.contains-task-list{margin:0;padding-left:0;list-style:none}.your-turn ul.contains-task-list li.task-list-item{position:relative;margin:0;padding:.25rem 0 .25rem 1.75rem;list-style:none}.your-turn ul.contains-task-list li.task-list-item::before,.your-turn ul.contains-task-list li.task-list-item::marker{content:none;display:none}.your-turn li.task-list-item input[type=checkbox]{position:absolute;left:0;top:.45rem;width:1rem;height:1rem;margin:0;accent-color:#f0610f}.your-turn[data-interactive=true] li.task-list-item,.your-turn[data-interactive=true] li.task-list-item input[type=checkbox]{cursor:pointer}.your-turn[data-interactive=true] li.task-list-item:hover{color:#f0610f}.your-turn li.task-list-item.is-done{opacity:.55;text-decoration:line-through;text-decoration-color:rgb(240 97 15/.5)}.in-this-section{margin:0 0 2rem;padding:1rem 1.25rem;border:1px solid rgb(15 23 42/.08);border-radius:.75rem;background:rgb(15 23 42/.025);font-size:.9375rem;line-height:1.65}.dark .in-this-section{border-color:rgb(255 255 255/.1);background:rgb(255 255 255/.03)}.in-this-section>:first-child{margin-top:0}.in-this-section>:last-child{margin-bottom:0}.in-this-section .section-links{margin-top:.875rem;padding-top:.875rem;border-top:1px solid rgb(15 23 42/.08)}.dark .in-this-section .section-links{border-top-color:rgb(255 255 255/.1)}.in-this-section .section-links ol{margin:0;padding-left:1.25rem}.in-this-section .section-links li{margin:.25rem 0}.nav-hint{margin:0 0 2rem;font-size:.875rem;line-height:1.6;color:rgb(15 23 42/.6)}.dark .nav-hint{color:rgb(255 255 255/.55)}.nav-hint strong{font-weight:600;color:inherit}.nav-hint>:first-child{margin-top:0}.nav-hint>:last-child{margin-bottom:0}.dark img[src*=\"/brands/chatgpt\"],.dark img[src*=\"/integrations/logos/daidalo\"],.dark img[src*=\"/integrations/logos/juicebox\"],.dark img[src*=\"/integrations/logos/pin.\"]{background:#fff;border-radius:3px;padding:1px;box-sizing:border-box}.mdx-content img[src^=\"/images/\"]{border-radius:12px}.shots{display:flex;flex-wrap:wrap;align-items:flex-start;gap:.75rem;margin:1rem 0 1.5rem}.shots>p,.shots>span{margin:0}.mdx-content .shots img{width:220px;max-width:100%;height:auto;margin:0;border:1px solid rgb(15 23 42/.1);border-radius:8px;box-shadow:0 1px 2px rgb(15 23 42/.06);cursor:zoom-in;transition:box-shadow .15s ease,border-color .15s ease}.mdx-content .shots img:hover{border-color:rgb(240 97 15/.5);box-shadow:0 4px 12px rgb(15 23 42/.12)}.dark .mdx-content .shots img{border-color:rgb(255 255 255/.12)}"}],"page":{"pagePath":"api-reference/opportunities/get-opportunity-pipeline-stages","slug":"/api-reference/opportunities/get-opportunity-pipeline-stages","pageMetadata":{"title":"Get opportunity pipeline stages","description":"Retrieve a list of all pipeline stages configured for opportunities. Each stage represents a step in the sales workflow (e.g., Qualification, Proposal, Negotiation, Closed Won).","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /pipeline/opportunities/stages","href":"/api-reference/opportunities/get-opportunity-pipeline-stages","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: \"Retrieve a list of all pipeline stages configured for opportunities. Each stage represents a step in the sales workflow (e.g., Qualification, Proposal, Negotiation, Closed Won).\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Get opportunity pipeline stages","description":"Retrieve a list of all pipeline stages configured for opportunities. Each stage represents a step in the sales workflow (e.g., Qualification, Proposal, Negotiation, Closed Won).","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /pipeline/opportunities/stages","href":"/api-reference/opportunities/get-opportunity-pipeline-stages","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"description":"Retrieve a list of all pipeline stages configured for opportunities. Each stage represents a step in the sales workflow (e.g., Qualification, Proposal, Negotiation, Closed Won).","operationId":"getOpportunityStages","parameters":[],"responses":{"200":"501c988c-39c6-4518-afd9-7ef48a928030","400":"bed22681-1f0c-4d67-bbca-a583a5419ac3","401":"46c78a49-e4af-4172-901c-7b63e625f6cf","404":"754d94cc-edc3-48b2-a72a-53d6cc4123fc","409":"c2ceb979-8435-4dd9-8824-f04886b6f80d","429":"983da903-9193-4409-98ba-be8da47c3573","500":"2e741ef9-7ea5-46d8-ae21-b0d043b2cb34"},"security":["6e2a8149-fe3f-463e-b7e0-442f568a31e5"],"summary":"Get opportunity pipeline stages","tags":["Opportunities"],"method":"get","type":"path","servers":["82a27cdd-63d1-4705-b921-df865a06f4fb"],"path":"/pipeline/opportunities/stages","baseUrlOptions":["https://api.gospott.com"],"title":"Get opportunity pipeline stages","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"responses":{"501c988c-39c6-4518-afd9-7ef48a928030":{"description":"Successfully retrieved the list of opportunity pipeline stages.","content":{"application/json":{"schema":{"type":"object","properties":{"stages":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"description":"Unique identifier of the pipeline stage","isRequired":true,"uniqueKey":"stages.items.[INDEX].id","typeLabel":"string"},"name":{"type":"string","description":"Display name of the pipeline stage","isRequired":true,"uniqueKey":"stages.items.[INDEX].name","typeLabel":"string"},"order":{"type":"number","description":"Sort order of the stage in the pipeline","isRequired":true,"uniqueKey":"stages.items.[INDEX].order","typeLabel":"number"},"forecastedCloseRate":{"oneOf":[{"description":"Forecasted close rate for opportunities in this stage (0-1). Null if not configured.","type":"number","isRequired":true,"uniqueKey":"stages.items.[INDEX].forecastedCloseRate.oneOf.0","typeLabel":"number"},{"description":"Forecasted close rate for opportunities in this stage (0-1). Null if not configured.","type":"null","isRequired":true,"uniqueKey":"stages.items.[INDEX].forecastedCloseRate.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"stages.items.[INDEX].forecastedCloseRate","typeLabel":"number | null"},"isOpen":{"type":"boolean","description":"Whether this stage represents an open (active) opportunity","isRequired":true,"uniqueKey":"stages.items.[INDEX].isOpen","typeLabel":"boolean"}},"required":["id","name","order","forecastedCloseRate","isOpen"],"uniqueKey":"stages.items.[INDEX]","typeLabel":"object"},"description":"List of opportunity pipeline stages ordered by position","isRequired":true,"uniqueKey":"stages","typeLabel":"object[]"}},"required":["stages"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"stages":[{"id":"\u003cstring>","name":"\u003cstring>","order":123,"forecastedCloseRate":123,"isOpen":true}]}}},"exampleType":"generated"}},"headers":{"RateLimit":{"description":"Quota state for this endpoint, as an RFC 8941 structured field (draft-ietf-httpapi-ratelimit-headers). The quoted value names the policy — the operationId of the endpoint the counters belong to. `r` is how many requests are left in the current window, `t` how many seconds remain before it resets.","schema":{"type":"string"},"example":"\"getCandidates\";r=417;t=23"},"RateLimit-Policy":{"description":"The policy the RateLimit header reports against, as an RFC 8941 structured field. `q` is the quota — the requests allowed per window — and `w` the window length in seconds. Limits are per endpoint, so the quota differs between operations. This is the quota in force for the calling workspace, which can be lower or higher than the default published on the operation; treat it as authoritative.","schema":{"type":"string"},"example":"\"getCandidates\";q=600;w=60"}},"exampleType":"generated"},"bed22681-1f0c-4d67-bbca-a583a5419ac3":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number","const":400,"isRequired":true,"uniqueKey":"status","typeLabel":"number"},"category":{"type":"string","enum":["SCHEMA_VALIDATION_FAILED"],"isRequired":true,"uniqueKey":"category","typeLabel":"enum\u003cstring>"},"message":{"type":"string","enum":["Validation failed"],"isRequired":true,"uniqueKey":"message","typeLabel":"enum\u003cstring>"},"requestId":{"type":"string","isRequired":true,"uniqueKey":"requestId","typeLabel":"string"},"errors":{"type":"array","items":{"oneOf":[{"type":"object","required":["code","path","message"],"properties":{"code":{"type":"string","enum":["REQUIRED"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.0.code","typeLabel":"enum\u003cstring>"},"path":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.0.path","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.0.message","typeLabel":"string"},"received":{"oneOf":[{}],"uniqueKey":"errors.items.[INDEX].oneOf.0.received","typeLabel":"any"}},"uniqueKey":"errors.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"object","required":["code","path","message"],"properties":{"code":{"type":"string","enum":["INVALID_EMPTY_STRING"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.1.code","typeLabel":"enum\u003cstring>"},"path":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.1.path","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.1.message","typeLabel":"string"},"received":{"oneOf":[{}],"uniqueKey":"errors.items.[INDEX].oneOf.1.received","typeLabel":"any"}},"uniqueKey":"errors.items.[INDEX].oneOf.1","typeLabel":"object"},{"type":"object","required":["code","path","message","keys"],"properties":{"code":{"type":"string","enum":["UNKNOWN_FIELD"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.2.code","typeLabel":"enum\u003cstring>"},"path":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.2.path","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.2.message","typeLabel":"string"},"keys":{"type":"array","items":{"type":"string","uniqueKey":"errors.items.[INDEX].oneOf.2.keys.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.2.keys","typeLabel":"string[]"},"received":{"oneOf":[{}],"uniqueKey":"errors.items.[INDEX].oneOf.2.received","typeLabel":"any"}},"uniqueKey":"errors.items.[INDEX].oneOf.2","typeLabel":"object"},{"type":"object","required":["code","path","message","minimum","inclusive","origin"],"properties":{"code":{"type":"string","enum":["TOO_SMALL"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.3.code","typeLabel":"enum\u003cstring>"},"path":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.3.path","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.3.message","typeLabel":"string"},"minimum":{"type":"number","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.3.minimum","typeLabel":"number"},"inclusive":{"type":"boolean","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.3.inclusive","typeLabel":"boolean"},"origin":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.3.origin","typeLabel":"string"},"received":{"oneOf":[{}],"uniqueKey":"errors.items.[INDEX].oneOf.3.received","typeLabel":"any"}},"uniqueKey":"errors.items.[INDEX].oneOf.3","typeLabel":"object"},{"type":"object","required":["code","path","message","maximum","inclusive","origin"],"properties":{"code":{"type":"string","enum":["TOO_BIG"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.4.code","typeLabel":"enum\u003cstring>"},"path":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.4.path","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.4.message","typeLabel":"string"},"maximum":{"type":"number","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.4.maximum","typeLabel":"number"},"inclusive":{"type":"boolean","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.4.inclusive","typeLabel":"boolean"},"origin":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.4.origin","typeLabel":"string"},"received":{"oneOf":[{}],"uniqueKey":"errors.items.[INDEX].oneOf.4.received","typeLabel":"any"}},"uniqueKey":"errors.items.[INDEX].oneOf.4","typeLabel":"object"},{"type":"object","required":["code","path","message","expected"],"properties":{"code":{"type":"string","enum":["INVALID_TYPE"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.5.code","typeLabel":"enum\u003cstring>"},"path":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.5.path","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.5.message","typeLabel":"string"},"expected":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.5.expected","typeLabel":"string"},"received":{"oneOf":[{}],"uniqueKey":"errors.items.[INDEX].oneOf.5.received","typeLabel":"any"}},"uniqueKey":"errors.items.[INDEX].oneOf.5","typeLabel":"object"},{"type":"object","required":["code","path","message"],"properties":{"code":{"type":"string","enum":["INVALID_VALUE"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.6.code","typeLabel":"enum\u003cstring>"},"path":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.6.path","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.6.message","typeLabel":"string"},"received":{"oneOf":[{}],"uniqueKey":"errors.items.[INDEX].oneOf.6.received","typeLabel":"any"},"expected":{"oneOf":[{}],"uniqueKey":"errors.items.[INDEX].oneOf.6.expected","typeLabel":"any"}},"uniqueKey":"errors.items.[INDEX].oneOf.6","typeLabel":"object"},{"type":"object","required":["code","path","message"],"properties":{"code":{"type":"string","enum":["INVALID_EMAIL"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.7.code","typeLabel":"enum\u003cstring>"},"path":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.7.path","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.7.message","typeLabel":"string"},"received":{"oneOf":[{}],"uniqueKey":"errors.items.[INDEX].oneOf.7.received","typeLabel":"any"}},"uniqueKey":"errors.items.[INDEX].oneOf.7","typeLabel":"object"},{"type":"object","required":["code","path","message"],"properties":{"code":{"type":"string","enum":["INVALID_UUID"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.8.code","typeLabel":"enum\u003cstring>"},"path":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.8.path","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.8.message","typeLabel":"string"},"received":{"oneOf":[{}],"uniqueKey":"errors.items.[INDEX].oneOf.8.received","typeLabel":"any"}},"uniqueKey":"errors.items.[INDEX].oneOf.8","typeLabel":"object"},{"type":"object","required":["code","path","message"],"properties":{"code":{"type":"string","enum":["INVALID_URL"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.code","typeLabel":"enum\u003cstring>"},"path":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.path","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.message","typeLabel":"string"},"received":{"oneOf":[{}],"uniqueKey":"errors.items.[INDEX].oneOf.9.received","typeLabel":"any"}},"uniqueKey":"errors.items.[INDEX].oneOf.9","typeLabel":"object"},{"type":"object","required":["code","path","message"],"properties":{"code":{"type":"string","enum":["INVALID_DATETIME"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.10.code","typeLabel":"enum\u003cstring>"},"path":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.10.path","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.10.message","typeLabel":"string"},"received":{"oneOf":[{}],"uniqueKey":"errors.items.[INDEX].oneOf.10.received","typeLabel":"any"}},"uniqueKey":"errors.items.[INDEX].oneOf.10","typeLabel":"object"},{"type":"object","required":["code","path","message"],"properties":{"code":{"type":"string","enum":["INVALID_DATE"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.11.code","typeLabel":"enum\u003cstring>"},"path":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.11.path","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.11.message","typeLabel":"string"},"received":{"oneOf":[{}],"uniqueKey":"errors.items.[INDEX].oneOf.11.received","typeLabel":"any"}},"uniqueKey":"errors.items.[INDEX].oneOf.11","typeLabel":"object"},{"type":"object","required":["code","path","message"],"properties":{"code":{"type":"string","enum":["INVALID_TIME"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.12.code","typeLabel":"enum\u003cstring>"},"path":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.12.path","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.12.message","typeLabel":"string"},"received":{"oneOf":[{}],"uniqueKey":"errors.items.[INDEX].oneOf.12.received","typeLabel":"any"}},"uniqueKey":"errors.items.[INDEX].oneOf.12","typeLabel":"object"},{"type":"object","required":["code","path","message"],"properties":{"code":{"type":"string","enum":["INVALID_DURATION"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.13.code","typeLabel":"enum\u003cstring>"},"path":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.13.path","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.13.message","typeLabel":"string"},"received":{"oneOf":[{}],"uniqueKey":"errors.items.[INDEX].oneOf.13.received","typeLabel":"any"}},"uniqueKey":"errors.items.[INDEX].oneOf.13","typeLabel":"object"},{"type":"object","required":["code","path","message"],"properties":{"code":{"type":"string","enum":["INVALID_IPV4"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.14.code","typeLabel":"enum\u003cstring>"},"path":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.14.path","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.14.message","typeLabel":"string"},"received":{"oneOf":[{}],"uniqueKey":"errors.items.[INDEX].oneOf.14.received","typeLabel":"any"}},"uniqueKey":"errors.items.[INDEX].oneOf.14","typeLabel":"object"},{"type":"object","required":["code","path","message"],"properties":{"code":{"type":"string","enum":["INVALID_IPV6"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.15.code","typeLabel":"enum\u003cstring>"},"path":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.15.path","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.15.message","typeLabel":"string"},"received":{"oneOf":[{}],"uniqueKey":"errors.items.[INDEX].oneOf.15.received","typeLabel":"any"}},"uniqueKey":"errors.items.[INDEX].oneOf.15","typeLabel":"object"},{"type":"object","required":["code","path","message"],"properties":{"code":{"type":"string","enum":["INVALID_JSON_STRING"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.16.code","typeLabel":"enum\u003cstring>"},"path":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.16.path","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.16.message","typeLabel":"string"},"received":{"oneOf":[{}],"uniqueKey":"errors.items.[INDEX].oneOf.16.received","typeLabel":"any"}},"uniqueKey":"errors.items.[INDEX].oneOf.16","typeLabel":"object"},{"type":"object","required":["code","path","message"],"properties":{"code":{"type":"string","enum":["INVALID_JWT"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.17.code","typeLabel":"enum\u003cstring>"},"path":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.17.path","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.17.message","typeLabel":"string"},"received":{"oneOf":[{}],"uniqueKey":"errors.items.[INDEX].oneOf.17.received","typeLabel":"any"}},"uniqueKey":"errors.items.[INDEX].oneOf.17","typeLabel":"object"},{"type":"object","required":["code","path","message"],"properties":{"code":{"type":"string","enum":["INVALID_REGEX"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.18.code","typeLabel":"enum\u003cstring>"},"path":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.18.path","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.18.message","typeLabel":"string"},"received":{"oneOf":[{}],"uniqueKey":"errors.items.[INDEX].oneOf.18.received","typeLabel":"any"}},"uniqueKey":"errors.items.[INDEX].oneOf.18","typeLabel":"object"},{"type":"object","required":["code","path","message"],"properties":{"code":{"type":"string","enum":["INVALID_PHONE_NUMBER"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.19.code","typeLabel":"enum\u003cstring>"},"path":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.19.path","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.19.message","typeLabel":"string"},"received":{"oneOf":[{}],"uniqueKey":"errors.items.[INDEX].oneOf.19.received","typeLabel":"any"}},"uniqueKey":"errors.items.[INDEX].oneOf.19","typeLabel":"object"},{"type":"object","required":["code","path","message"],"properties":{"code":{"type":"string","enum":["INVALID_DOMAIN"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.20.code","typeLabel":"enum\u003cstring>"},"path":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.20.path","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.20.message","typeLabel":"string"},"received":{"oneOf":[{}],"uniqueKey":"errors.items.[INDEX].oneOf.20.received","typeLabel":"any"}},"uniqueKey":"errors.items.[INDEX].oneOf.20","typeLabel":"object"},{"type":"object","required":["code","path","message"],"properties":{"code":{"type":"string","enum":["INVALID_HTTPS_URL"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.21.code","typeLabel":"enum\u003cstring>"},"path":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.21.path","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.21.message","typeLabel":"string"},"received":{"oneOf":[{}],"uniqueKey":"errors.items.[INDEX].oneOf.21.received","typeLabel":"any"}},"uniqueKey":"errors.items.[INDEX].oneOf.21","typeLabel":"object"},{"type":"object","required":["code","path","message"],"properties":{"code":{"type":"string","enum":["INVALID_TIMEZONE"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.22.code","typeLabel":"enum\u003cstring>"},"path":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.22.path","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.22.message","typeLabel":"string"},"received":{"oneOf":[{}],"uniqueKey":"errors.items.[INDEX].oneOf.22.received","typeLabel":"any"}},"uniqueKey":"errors.items.[INDEX].oneOf.22","typeLabel":"object"},{"type":"object","required":["code","path","message","maximum"],"properties":{"code":{"type":"string","enum":["PAGINATION_OFFSET_EXCEEDED"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.23.code","typeLabel":"enum\u003cstring>"},"path":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.23.path","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.23.message","typeLabel":"string"},"maximum":{"type":"number","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.23.maximum","typeLabel":"number"},"received":{"oneOf":[{}],"uniqueKey":"errors.items.[INDEX].oneOf.23.received","typeLabel":"any"}},"uniqueKey":"errors.items.[INDEX].oneOf.23","typeLabel":"object"}],"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"errors","typeLabel":"object[]"}},"required":["status","category","message","requestId","errors"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":400,"category":"SCHEMA_VALIDATION_FAILED","message":"Validation failed","requestId":"\u003cstring>","errors":[{"code":"REQUIRED","path":"\u003cstring>","message":"\u003cstring>","received":"\u003cunknown>"}]}}},"exampleType":"generated"}},"headers":{"RateLimit":{"description":"Quota state for this endpoint, as an RFC 8941 structured field (draft-ietf-httpapi-ratelimit-headers). The quoted value names the policy — the operationId of the endpoint the counters belong to. `r` is how many requests are left in the current window, `t` how many seconds remain before it resets.","schema":{"type":"string"},"example":"\"getCandidates\";r=417;t=23"},"RateLimit-Policy":{"description":"The policy the RateLimit header reports against, as an RFC 8941 structured field. `q` is the quota — the requests allowed per window — and `w` the window length in seconds. Limits are per endpoint, so the quota differs between operations. This is the quota in force for the calling workspace, which can be lower or higher than the default published on the operation; treat it as authoritative.","schema":{"type":"string"},"example":"\"getCandidates\";q=600;w=60"}},"exampleType":"generated"},"46c78a49-e4af-4172-901c-7b63e625f6cf":{"description":"Unauthorized - invalid or missing API key","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"requestId":{"type":"string","isRequired":true,"uniqueKey":"requestId","typeLabel":"string"},"category":{"type":"string","enum":["MALFORMED_REQUEST","SCHEMA_VALIDATION_FAILED","DOMAIN_VALIDATION_FAILED","OPERATION_LIMIT_EXCEEDED","AUTHENTICATION_REQUIRED","AUTHENTICATION_FAILED","SECURITY_CHALLENGE_REQUIRED","SECURITY_CHALLENGE_FAILED","PERMISSION_DENIED","ENTITLEMENT_REQUIRED","PROVIDER_AUTHENTICATION_REQUIRED","PROVIDER_AUTHENTICATION_FAILED","CONFIGURATION_REQUIRED","RESOURCE_NOT_FOUND","RESOURCE_ALREADY_EXISTS","RESOURCE_EXPIRED","RESOURCE_BUSY","RESOURCE_STATE_CONFLICT","QUOTA_EXCEEDED","RATE_LIMITED","UNSUPPORTED_OPERATION","UPSTREAM_REJECTED","TIMEOUT","TEMPORARILY_UNAVAILABLE","INTERNAL_ERROR"],"uniqueKey":"category","typeLabel":"enum\u003cstring>"}},"required":["status","message","requestId"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":0,"message":"\u003cstring>","requestId":"\u003cstring>","category":"MALFORMED_REQUEST"}}},"exampleType":"generated"}},"headers":{"RateLimit":{"description":"Quota state for this endpoint, as an RFC 8941 structured field (draft-ietf-httpapi-ratelimit-headers). The quoted value names the policy — the operationId of the endpoint the counters belong to. `r` is how many requests are left in the current window, `t` how many seconds remain before it resets.","schema":{"type":"string"},"example":"\"getCandidates\";r=417;t=23"},"RateLimit-Policy":{"description":"The policy the RateLimit header reports against, as an RFC 8941 structured field. `q` is the quota — the requests allowed per window — and `w` the window length in seconds. Limits are per endpoint, so the quota differs between operations. This is the quota in force for the calling workspace, which can be lower or higher than the default published on the operation; treat it as authoritative.","schema":{"type":"string"},"example":"\"getCandidates\";q=600;w=60"}},"exampleType":"generated"},"754d94cc-edc3-48b2-a72a-53d6cc4123fc":{"description":"Not Found","content":{"application/json":{"schema":{"oneOf":[{"type":"object","required":["status","category","message","requestId"],"properties":{"status":{"type":"number","const":404,"isRequired":true,"uniqueKey":"oneOf.0.status","typeLabel":"number"},"category":{"type":"string","enum":["RESOURCE_NOT_FOUND"],"isRequired":true,"uniqueKey":"oneOf.0.category","typeLabel":"enum\u003cstring>"},"message":{"type":"string","enum":["Resource not found"],"isRequired":true,"uniqueKey":"oneOf.0.message","typeLabel":"enum\u003cstring>"},"requestId":{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.requestId","typeLabel":"string"}},"uniqueKey":"oneOf.0","typeLabel":"object"},{"type":"object","required":["status","category","message","requestId"],"properties":{"status":{"type":"number","const":404,"isRequired":true,"uniqueKey":"oneOf.1.status","typeLabel":"number"},"category":{"type":"string","enum":["RESOURCE_NOT_FOUND"],"isRequired":true,"uniqueKey":"oneOf.1.category","typeLabel":"enum\u003cstring>"},"message":{"type":"string","enum":["Related resource not found"],"isRequired":true,"uniqueKey":"oneOf.1.message","typeLabel":"enum\u003cstring>"},"requestId":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.requestId","typeLabel":"string"}},"uniqueKey":"oneOf.1","typeLabel":"object"}],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":404,"category":"RESOURCE_NOT_FOUND","message":"Resource not found","requestId":"\u003cstring>"}}},"exampleType":"generated"}},"headers":{"RateLimit":{"description":"Quota state for this endpoint, as an RFC 8941 structured field (draft-ietf-httpapi-ratelimit-headers). The quoted value names the policy — the operationId of the endpoint the counters belong to. `r` is how many requests are left in the current window, `t` how many seconds remain before it resets.","schema":{"type":"string"},"example":"\"getCandidates\";r=417;t=23"},"RateLimit-Policy":{"description":"The policy the RateLimit header reports against, as an RFC 8941 structured field. `q` is the quota — the requests allowed per window — and `w` the window length in seconds. Limits are per endpoint, so the quota differs between operations. This is the quota in force for the calling workspace, which can be lower or higher than the default published on the operation; treat it as authoritative.","schema":{"type":"string"},"example":"\"getCandidates\";q=600;w=60"}},"exampleType":"generated"},"c2ceb979-8435-4dd9-8824-f04886b6f80d":{"description":"Conflict","content":{"application/json":{"schema":{"oneOf":[{"type":"object","required":["status","category","message","requestId"],"properties":{"status":{"type":"number","const":409,"isRequired":true,"uniqueKey":"oneOf.0.status","typeLabel":"number"},"category":{"type":"string","enum":["RESOURCE_ALREADY_EXISTS"],"isRequired":true,"uniqueKey":"oneOf.0.category","typeLabel":"enum\u003cstring>"},"message":{"type":"string","enum":["Resource already exists"],"isRequired":true,"uniqueKey":"oneOf.0.message","typeLabel":"enum\u003cstring>"},"requestId":{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.requestId","typeLabel":"string"}},"uniqueKey":"oneOf.0","typeLabel":"object"},{"type":"object","required":["status","category","message","requestId"],"properties":{"status":{"type":"number","const":409,"isRequired":true,"uniqueKey":"oneOf.1.status","typeLabel":"number"},"category":{"type":"string","enum":["RESOURCE_BUSY"],"isRequired":true,"uniqueKey":"oneOf.1.category","typeLabel":"enum\u003cstring>"},"message":{"type":"string","enum":["Lock could not be acquired for this resource, please try again later."],"isRequired":true,"uniqueKey":"oneOf.1.message","typeLabel":"enum\u003cstring>"},"requestId":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.requestId","typeLabel":"string"}},"uniqueKey":"oneOf.1","typeLabel":"object"}],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":409,"category":"RESOURCE_ALREADY_EXISTS","message":"Resource already exists","requestId":"\u003cstring>"}}},"exampleType":"generated"}},"headers":{"RateLimit":{"description":"Quota state for this endpoint, as an RFC 8941 structured field (draft-ietf-httpapi-ratelimit-headers). The quoted value names the policy — the operationId of the endpoint the counters belong to. `r` is how many requests are left in the current window, `t` how many seconds remain before it resets.","schema":{"type":"string"},"example":"\"getCandidates\";r=417;t=23"},"RateLimit-Policy":{"description":"The policy the RateLimit header reports against, as an RFC 8941 structured field. `q` is the quota — the requests allowed per window — and `w` the window length in seconds. Limits are per endpoint, so the quota differs between operations. This is the quota in force for the calling workspace, which can be lower or higher than the default published on the operation; treat it as authoritative.","schema":{"type":"string"},"example":"\"getCandidates\";q=600;w=60"}},"exampleType":"generated"},"983da903-9193-4409-98ba-be8da47c3573":{"description":"Too Many Requests. The published limit for this endpoint is 600 requests per minute per workspace. The limit in force for your workspace can differ from it in either direction — a workspace on a free trial can be capped lower, and a higher limit can be arranged through support — so the headers, not this number, are authoritative. Read the RateLimit-Policy response header for the quota actually in force and RateLimit for what is left of the current window; on a 429, Retry-After gives the seconds to wait.","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"requestId":{"type":"string","isRequired":true,"uniqueKey":"requestId","typeLabel":"string"},"category":{"type":"string","enum":["MALFORMED_REQUEST","SCHEMA_VALIDATION_FAILED","DOMAIN_VALIDATION_FAILED","OPERATION_LIMIT_EXCEEDED","AUTHENTICATION_REQUIRED","AUTHENTICATION_FAILED","SECURITY_CHALLENGE_REQUIRED","SECURITY_CHALLENGE_FAILED","PERMISSION_DENIED","ENTITLEMENT_REQUIRED","PROVIDER_AUTHENTICATION_REQUIRED","PROVIDER_AUTHENTICATION_FAILED","CONFIGURATION_REQUIRED","RESOURCE_NOT_FOUND","RESOURCE_ALREADY_EXISTS","RESOURCE_EXPIRED","RESOURCE_BUSY","RESOURCE_STATE_CONFLICT","QUOTA_EXCEEDED","RATE_LIMITED","UNSUPPORTED_OPERATION","UPSTREAM_REJECTED","TIMEOUT","TEMPORARILY_UNAVAILABLE","INTERNAL_ERROR"],"uniqueKey":"category","typeLabel":"enum\u003cstring>"}},"required":["status","message","requestId"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":0,"message":"\u003cstring>","requestId":"\u003cstring>","category":"MALFORMED_REQUEST"}}},"exampleType":"generated"}},"headers":{"RateLimit":{"description":"Quota state for this endpoint, as an RFC 8941 structured field (draft-ietf-httpapi-ratelimit-headers). The quoted value names the policy — the operationId of the endpoint the counters belong to. `r` is how many requests are left in the current window, `t` how many seconds remain before it resets.","schema":{"type":"string"},"example":"\"getCandidates\";r=417;t=23"},"RateLimit-Policy":{"description":"The policy the RateLimit header reports against, as an RFC 8941 structured field. `q` is the quota — the requests allowed per window — and `w` the window length in seconds. Limits are per endpoint, so the quota differs between operations. This is the quota in force for the calling workspace, which can be lower or higher than the default published on the operation; treat it as authoritative.","schema":{"type":"string"},"example":"\"getCandidates\";q=600;w=60"},"Retry-After":{"description":"Seconds to wait before retrying. Sent on 429 responses; it matches the `t` parameter of the RateLimit header.","schema":{"type":"integer"},"example":23}},"exampleType":"generated"},"2e741ef9-7ea5-46d8-ae21-b0d043b2cb34":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"number","const":500,"isRequired":true,"uniqueKey":"status","typeLabel":"number"},"category":{"type":"string","enum":["INTERNAL_ERROR"],"isRequired":true,"uniqueKey":"category","typeLabel":"enum\u003cstring>"},"message":{"type":"string","enum":["Internal server error"],"isRequired":true,"uniqueKey":"message","typeLabel":"enum\u003cstring>"},"requestId":{"type":"string","isRequired":true,"uniqueKey":"requestId","typeLabel":"string"}},"required":["status","category","message","requestId"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":500,"category":"INTERNAL_ERROR","message":"Internal server error","requestId":"\u003cstring>"}}},"exampleType":"generated"}},"headers":{"RateLimit":{"description":"Quota state for this endpoint, as an RFC 8941 structured field (draft-ietf-httpapi-ratelimit-headers). The quoted value names the policy — the operationId of the endpoint the counters belong to. `r` is how many requests are left in the current window, `t` how many seconds remain before it resets.","schema":{"type":"string"},"example":"\"getCandidates\";r=417;t=23"},"RateLimit-Policy":{"description":"The policy the RateLimit header reports against, as an RFC 8941 structured field. `q` is the quota — the requests allowed per window — and `w` the window length in seconds. Limits are per endpoint, so the quota differs between operations. This is the quota in force for the calling workspace, which can be lower or higher than the default published on the operation; treat it as authoritative.","schema":{"type":"string"},"example":"\"getCandidates\";q=600;w=60"}},"exampleType":"generated"}},"security":{"6e2a8149-fe3f-463e-b7e0-442f568a31e5":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key for authentication. Get your API key from Settings → API Keys in your Spott dashboard.","scopes":[],"schemeName":"x-api-key"}}},"servers":{"82a27cdd-63d1-4705-b921-df865a06f4fb":{"url":"https://api.gospott.com"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key for authentication. Get your API key from Settings → API Keys in your Spott dashboard.","scopes":[],"schemeName":"x-api-key"},"schema":{"title":"x-api-key","type":"string","description":"API key for authentication. Get your API key from Settings → API Keys in your Spott dashboard.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"x-api-key","name":"x-api-key"}],"title":"x-api-key"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"spott-docs","siteName":"Spott","title":"Get opportunity pipeline stages - Spott","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"en":{"href":"/api-reference/opportunities/get-opportunity-pipeline-stages","matchLevel":0},"fr":{"href":"/fr","matchLevel":4},"nl":{"href":"/nl","matchLevel":4},"de":{"href":"/de","matchLevel":4},"es":{"href":"/es","matchLevel":4}}},"lastModified":"2026-10-25T16:50:46.776Z","originalFileLocation":"api-reference/opportunities/get-opportunity-pipeline-stages.mdx","locale":"en"},"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=\"light\"}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=\"Retrieve a list of all pipeline stages configured for opportunities. Each stage represents a step in the sales workflow (e.g., Qualification, Proposal, Negotiation, Closed Won).\">\u003cmeta data-mint-head name=\"application-name\" content=\"Spott\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/spott-docs/TptR6ytKqBew31dM/_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/spott-docs/TptR6ytKqBew31dM/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/spott-docs/TptR6ytKqBew31dM/_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/spott-docs/TptR6ytKqBew31dM/_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/spott-docs/TptR6ytKqBew31dM/_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/spott-docs/TptR6ytKqBew31dM/_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/spott-docs/TptR6ytKqBew31dM/_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/spott-docs/TptR6ytKqBew31dM/_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/spott-docs/TptR6ytKqBew31dM/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get opportunity pipeline stages - Spott\">\u003cmeta data-mint-head property=\"og:description\" content=\"Retrieve a list of all pipeline stages configured for opportunities. Each stage represents a step in the sales workflow (e.g., Qualification, Proposal, Negotiation, Closed Won).\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Spott\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.spott.io/api-reference/opportunities/get-opportunity-pipeline-stages\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://spott-docs.mintlify.app/_mintlify/api/og/v2?division=Opportunities\u0026amp;title=Get+opportunity+pipeline+stages\u0026amp;description=Retrieve+a+list+of+all+pipeline+stages+configured+for+opportunities.+Each+stage+represents+a+step+in+the+sales+workflow+%28e.g.%2C+Qualification%2C+Proposal%2C+Negotiat\u0026amp;theme=0d0ef5e0ee35d235d111fccd\u0026amp;signature=06c1ada8617339e09ceb14fb19751859ee3b14a702d067c013fc644c7381000e\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Get opportunity pipeline stages - Spott\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Retrieve a list of all pipeline stages configured for opportunities. Each stage represents a step in the sales workflow (e.g., Qualification, Proposal, Negotiation, Closed Won).\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://spott-docs.mintlify.app/_mintlify/api/og/v2?division=Opportunities\u0026amp;title=Get+opportunity+pipeline+stages\u0026amp;description=Retrieve+a+list+of+all+pipeline+stages+configured+for+opportunities.+Each+stage+represents+a+step+in+the+sales+workflow+%28e.g.%2C+Qualification%2C+Proposal%2C+Negotiat\u0026amp;theme=0d0ef5e0ee35d235d111fccd\u0026amp;signature=06c1ada8617339e09ceb14fb19751859ee3b14a702d067c013fc644c7381000e\">\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/spott-docs/TptR6ytKqBew31dM/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Spott\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#f0610f\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.spott.io/api-reference/opportunities/get-opportunity-pipeline-stages\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/opportunities/get-opportunity-pipeline-stages.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.spott.io/#organization\",\"name\":\"Spott\",\"url\":\"https://docs.spott.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/spott-docs/Zvbuq2vKGY56oD57/logo/light.svg?fit=max\u0026auto=format\u0026n=Zvbuq2vKGY56oD57\u0026q=85\u0026s=914d6f30a1192b291746dbcd2fc7e0fa\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.spott.io#website\",\"name\":\"Spott\",\"url\":\"https://docs.spott.io\",\"publisher\":{\"@id\":\"https://docs.spott.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.spott.io/api-reference/opportunities/get-opportunity-pipeline-stages#webpage\",\"url\":\"https://docs.spott.io/api-reference/opportunities/get-opportunity-pipeline-stages\",\"name\":\"Get opportunity pipeline stages\",\"description\":\"Retrieve a list of all pipeline stages configured for opportunities. Each stage represents a step in the sales workflow (e.g., Qualification, Proposal, Negotiation, Closed Won).\",\"dateModified\":\"2026-10-25T16:50:46.776Z\",\"isPartOf\":{\"@id\":\"https://docs.spott.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.spott.io/api-reference/opportunities/get-opportunity-pipeline-stages#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.spott.io/api-reference/opportunities/get-opportunity-pipeline-stages#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Private API\",\"item\":\"https://docs.spott.io/api-reference/application-pipeline/list-application-pipeline-templates\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Opportunities\",\"item\":\"https://docs.spott.io/api-reference/opportunities/list-opportunities\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Get opportunity pipeline stages\",\"item\":\"https://docs.spott.io/api-reference/opportunities/get-opportunity-pipeline-stages\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.spott.io/api-reference/opportunities/get-opportunity-pipeline-stages#apireference\",\"headline\":\"Get opportunity pipeline stages\",\"name\":\"Get opportunity pipeline stages\",\"description\":\"Retrieve a list of all pipeline stages configured for opportunities. Each stage represents a step in the sales workflow (e.g., Qualification, Proposal, Negotiation, Closed Won).\",\"url\":\"https://docs.spott.io/api-reference/opportunities/get-opportunity-pipeline-stages\",\"mainEntityOfPage\":{\"@id\":\"https://docs.spott.io/api-reference/opportunities/get-opportunity-pipeline-stages#webpage\"},\"dateModified\":\"2026-10-25T16:50:46.776Z\",\"publisher\":{\"@id\":\"https://docs.spott.io/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.spott.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Spott\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Spott","nav":{"global":{"anchors":[{"anchor":"Go to app","icon":"arrow-up-right-from-square","href":"https://app.spott.io"},{"anchor":"Support","icon":"life-ring","href":"/docs/get-started/faq"}]},"languages":[{"language":"en","default":true,"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":""}]},{"tab":"Get Onboarded","pages":[{"title":"Get Onboarded","href":"/docs/onboarding/welcome"}]},{"tab":"Integrations","pages":[{"title":"Integrations","href":"/docs/integrations/overview"}]},{"tab":"Mobile","pages":[{"title":"Mobile","href":"/docs/mobile/overview"}]},{"tab":"API","groups":[{"group":"Overview","icon":"book-open","pages":[{"title":"The Spott API","icon":"code","href":"/docs/developers/api-overview"}]},{"group":"Public API","icon":"globe","pages":[{"group":"Job Portal","pages":[{"title":"Get job portal branding","deprecated":null,"version":null,"openapi":"/api-reference/openapi-public.json get /{publicTenantSlug}/vacancy-portal/branding","href":"/public-api/job-portal/get-job-portal-branding"},{"title":"Get posted jobs","deprecated":null,"version":null,"openapi":"/api-reference/openapi-public.json get /{publicTenantSlug}/vacancy-portal/jobs","href":"/public-api/job-portal/get-posted-jobs"},{"title":"Get posted job details","deprecated":null,"version":null,"openapi":"/api-reference/openapi-public.json get /{publicTenantSlug}/vacancy-portal/jobs/{jobBoardPostingId}","href":"/public-api/job-portal/get-posted-job-details"}]}]},{"group":"Private API","pages":[{"group":"Application Pipeline","pages":[{"title":"List application pipeline templates","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /pipeline/applications/templates","href":"/api-reference/application-pipeline/list-application-pipeline-templates"},{"title":"Create an application pipeline template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /pipeline/applications/templates","href":"/api-reference/application-pipeline/create-an-application-pipeline-template"},{"title":"Delete an application pipeline template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /pipeline/applications/templates/{id}","href":"/api-reference/application-pipeline/delete-an-application-pipeline-template"},{"title":"Get application pipeline stages","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /pipeline/applications/stages","href":"/api-reference/application-pipeline/get-application-pipeline-stages"}]},{"group":"Applications","pages":[{"title":"List applications","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /applications","href":"/api-reference/applications/list-applications"},{"title":"Create an application","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /applications","href":"/api-reference/applications/create-an-application"},{"title":"Retrieve an application","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /applications/{id}","href":"/api-reference/applications/retrieve-an-application"},{"title":"Delete an application","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /applications/{id}","href":"/api-reference/applications/delete-an-application"},{"title":"Update application","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /applications/{id}","href":"/api-reference/applications/update-application"},{"title":"List application activities","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /applications/{id}/activities","href":"/api-reference/applications/list-application-activities"},{"title":"Get application presentations","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /applications/{id}/presentations","href":"/api-reference/applications/get-application-presentations"},{"title":"Retrieve an application scorecard","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /applications/{id}/scorecard","href":"/api-reference/applications/retrieve-an-application-scorecard"},{"title":"Get applications by candidate ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /applications/candidate/{candidateId}","href":"/api-reference/applications/get-applications-by-candidate-id"},{"title":"Bulk update applications","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /applications/_bulk","href":"/api-reference/applications/bulk-update-applications"},{"title":"Bulk create applications","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /applications/_bulk","href":"/api-reference/applications/bulk-create-applications"},{"title":"Move application to stage","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /applications/{id}/move","href":"/api-reference/applications/move-application-to-stage"},{"title":"Create a rejection for an application","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /applications/{id}/rejections","href":"/api-reference/applications/create-a-rejection-for-an-application"}]},{"group":"Attachments","pages":[{"title":"List attachments","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /attachments","href":"/api-reference/attachments/list-attachments"},{"title":"Search attachments","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /attachments/_search","href":"/api-reference/attachments/search-attachments"},{"title":"Get attachment download URL","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /attachments/{id}/_download","href":"/api-reference/attachments/get-attachment-download-url"},{"title":"Upload temporary attachments","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /attachments/temporary","href":"/api-reference/attachments/upload-temporary-attachments"},{"title":"Assign temporary attachments to records","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /attachments/temporary/assign","href":"/api-reference/attachments/assign-temporary-attachments-to-records"},{"title":"List attachment types","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /attachments/types","href":"/api-reference/attachments/list-attachment-types"},{"title":"Get an attachment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /attachments/{id}","href":"/api-reference/attachments/get-an-attachment"},{"title":"Delete an attachment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /attachments/{id}","href":"/api-reference/attachments/delete-an-attachment"},{"title":"Update an attachment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /attachments/{id}","href":"/api-reference/attachments/update-an-attachment"},{"title":"List signing requests","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /attachments/signing-requests","href":"/api-reference/attachments/list-signing-requests"},{"title":"Retrieve a signing request","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /attachments/signing-requests/{id}","href":"/api-reference/attachments/retrieve-a-signing-request"}]},{"group":"Brands","pages":[{"title":"List brands","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /brands","href":"/api-reference/brands/list-brands"},{"title":"Retrieve a brand","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /brands/{id}","href":"/api-reference/brands/retrieve-a-brand"},{"title":"Delete a brand","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /brands/{id}","href":"/api-reference/brands/delete-a-brand"},{"title":"Assign a team to a brand","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /brands/{id}/teams/{teamId}/_assign","href":"/api-reference/brands/assign-a-team-to-a-brand"},{"title":"Unassign a team from a brand","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /brands/{id}/teams/{teamId}/_unassign","href":"/api-reference/brands/unassign-a-team-from-a-brand"}]},{"group":"Calls","pages":[{"title":"List calls","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /calls","href":"/api-reference/calls/list-calls"},{"title":"Retrieve a call","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /calls/{id}","href":"/api-reference/calls/retrieve-a-call"}]},{"group":"Candidate Civil Identity","pages":[{"title":"Get candidate civil identity","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /candidates/{id}/civil-identity","href":"/api-reference/candidate-civil-identity/get-candidate-civil-identity"},{"title":"Upsert candidate civil identity","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /candidates/{id}/civil-identity","href":"/api-reference/candidate-civil-identity/upsert-candidate-civil-identity"}]},{"group":"Candidate Lists","pages":[{"title":"Link candidates to a list","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /lists/{id}/candidates/_link","href":"/api-reference/candidate-lists/link-candidates-to-a-list"},{"title":"Unlink candidates from a list","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /lists/{id}/candidates/_unlink","href":"/api-reference/candidate-lists/unlink-candidates-from-a-list"}]},{"group":"Candidate Portal","pages":[{"title":"List appointments of a candidate","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /appointments","href":"/api-reference/candidate-portal/list-appointments-of-a-candidate"},{"title":"Plan an appointment for a candidate","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /appointments","href":"/api-reference/candidate-portal/plan-an-appointment-for-a-candidate"},{"title":"Retrieve an appointment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /appointments/{id}","href":"/api-reference/candidate-portal/retrieve-an-appointment"},{"title":"Delete an appointment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /appointments/{id}","href":"/api-reference/candidate-portal/delete-an-appointment"},{"title":"Update an appointment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /appointments/{id}","href":"/api-reference/candidate-portal/update-an-appointment"},{"title":"List candidate to-do's","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /candidates/{id}/todos","href":"/api-reference/candidate-portal/list-candidate-to-dos"},{"title":"Create a candidate to-do","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /candidates/{id}/todos","href":"/api-reference/candidate-portal/create-a-candidate-to-do"},{"title":"Retrieve a candidate to-do","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /candidates/{id}/todos/{todoId}","href":"/api-reference/candidate-portal/retrieve-a-candidate-to-do"},{"title":"Delete a candidate to-do","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /candidates/{id}/todos/{todoId}","href":"/api-reference/candidate-portal/delete-a-candidate-to-do"},{"title":"Complete or reopen a candidate to-do","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /candidates/{id}/todos/{todoId}/completion","href":"/api-reference/candidate-portal/complete-or-reopen-a-candidate-to-do"},{"title":"Submit spontaneous application","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /candidate-portal/open-application","href":"/api-reference/candidate-portal/submit-spontaneous-application"},{"title":"Get existing candidate","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /candidate-portal/{candidateId}","href":"/api-reference/candidate-portal/get-existing-candidate"},{"title":"Update candidate","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /candidate-portal/{candidateId}","href":"/api-reference/candidate-portal/update-candidate"}]},{"group":"Candidate Statutory Documents","pages":[{"title":"List candidate statutory documents","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /candidates/{id}/statutory-documents","href":"/api-reference/candidate-statutory-documents/list-candidate-statutory-documents"},{"title":"Create a candidate statutory document","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /candidates/{id}/statutory-documents","href":"/api-reference/candidate-statutory-documents/create-a-candidate-statutory-document"},{"title":"Update a candidate statutory document","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /candidates/{id}/statutory-documents/{documentId}","href":"/api-reference/candidate-statutory-documents/update-a-candidate-statutory-document"},{"title":"Delete a candidate statutory document","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /candidates/{id}/statutory-documents/{documentId}","href":"/api-reference/candidate-statutory-documents/delete-a-candidate-statutory-document"}]},{"group":"Candidates","pages":[{"title":"List candidates","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /candidates","href":"/api-reference/candidates/list-candidates"},{"title":"Create a candidate","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /candidates","href":"/api-reference/candidates/create-a-candidate"},{"title":"Search candidates","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /candidates/_search","href":"/api-reference/candidates/search-candidates"},{"title":"Retrieve a candidate","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /candidates/{id}","href":"/api-reference/candidates/retrieve-a-candidate"},{"title":"Delete a candidate","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /candidates/{id}","href":"/api-reference/candidates/delete-a-candidate"},{"title":"Update a candidate","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /candidates/{id}","href":"/api-reference/candidates/update-a-candidate"},{"title":"Get work experiences","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /candidates/{id}/work-experiences","href":"/api-reference/candidates/get-work-experiences"},{"title":"Replace work experiences","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /candidates/{id}/work-experiences","href":"/api-reference/candidates/replace-work-experiences"},{"title":"Create work experience","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /candidates/{id}/work-experiences","href":"/api-reference/candidates/create-work-experience"},{"title":"Update work experience","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /candidates/work-experiences/{workExperienceId}","href":"/api-reference/candidates/update-work-experience"},{"title":"Delete work experience","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /candidates/work-experiences/{workExperienceId}","href":"/api-reference/candidates/delete-work-experience"},{"title":"Get education","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /candidates/{id}/education","href":"/api-reference/candidates/get-education"},{"title":"Replace education","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /candidates/{id}/education","href":"/api-reference/candidates/replace-education"},{"title":"Create education","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /candidates/{id}/education","href":"/api-reference/candidates/create-education"},{"title":"Update education","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /candidates/education/{educationId}","href":"/api-reference/candidates/update-education"},{"title":"Delete education","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /candidates/education/{educationId}","href":"/api-reference/candidates/delete-education"},{"title":"Get certifications","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /candidates/{id}/certifications","href":"/api-reference/candidates/get-certifications"},{"title":"Replace certifications","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /candidates/{id}/certifications","href":"/api-reference/candidates/replace-certifications"},{"title":"Create certification","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /candidates/{id}/certifications","href":"/api-reference/candidates/create-certification"},{"title":"Update certification","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /candidates/certifications/{id}","href":"/api-reference/candidates/update-certification"},{"title":"Delete certification","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /candidates/certifications/{id}","href":"/api-reference/candidates/delete-certification"},{"title":"Get contact identifiers","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /candidates/{id}/contact-identifiers","href":"/api-reference/candidates/get-contact-identifiers"},{"title":"Create contact identifier","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /candidates/{id}/contact-identifiers","href":"/api-reference/candidates/create-contact-identifier"},{"title":"Bulk create candidates","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /candidates/_bulk","href":"/api-reference/candidates/bulk-create-candidates"},{"title":"Create candidate from CV","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /candidates/_from-unsupervised-cv","href":"/api-reference/candidates/create-candidate-from-cv"},{"title":"Bulk create candidates from CV","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /candidates/_from-unsupervised-cv/_bulk","href":"/api-reference/candidates/bulk-create-candidates-from-cv"},{"title":"Update candidate avatar","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /candidates/{id}/avatar","href":"/api-reference/candidates/update-candidate-avatar"}]},{"group":"Client Contact Lists","pages":[{"title":"Link client contacts to a list","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /lists/{id}/client-contacts/_link","href":"/api-reference/client-contact-lists/link-client-contacts-to-a-list"},{"title":"Unlink client contacts from a list","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /lists/{id}/client-contacts/_unlink","href":"/api-reference/client-contact-lists/unlink-client-contacts-from-a-list"}]},{"group":"Client Contacts","pages":[{"title":"Create client contact from candidate","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /candidates/{candidateId}/contacts","href":"/api-reference/client-contacts/create-client-contact-from-candidate"},{"title":"Get client contacts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /clients/contacts","href":"/api-reference/client-contacts/get-client-contacts"},{"title":"Get client contact by candidate ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /clients/contacts/{candidateId}","href":"/api-reference/client-contacts/get-client-contact-by-candidate-id"},{"title":"Bulk create client contacts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /clients/contacts/_bulk","href":"/api-reference/client-contacts/bulk-create-client-contacts"},{"title":"Create client contact","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /clients/contacts/{clientId}","href":"/api-reference/client-contacts/create-client-contact"},{"title":"Delete client contact","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /clients/contacts/{id}","href":"/api-reference/client-contacts/delete-client-contact"},{"title":"Update client contact","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /clients/contacts/{id}","href":"/api-reference/client-contacts/update-client-contact"}]},{"group":"Client Hierarchies","pages":[{"title":"Retrieve a client hierarchy","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /clients/hierarchies/{hierarchyId}","href":"/api-reference/client-hierarchies/retrieve-a-client-hierarchy"}]},{"group":"Client Lists","pages":[{"title":"Link clients to a list","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /lists/{id}/clients/_link","href":"/api-reference/client-lists/link-clients-to-a-list"},{"title":"Unlink clients from a list","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /lists/{id}/clients/_unlink","href":"/api-reference/client-lists/unlink-clients-from-a-list"}]},{"group":"Clients","pages":[{"title":"List clients","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /clients","href":"/api-reference/clients/list-clients"},{"title":"Create a client","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /clients","href":"/api-reference/clients/create-a-client"},{"title":"Retrieve a client","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /clients/{id}","href":"/api-reference/clients/retrieve-a-client"},{"title":"Delete a client","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /clients/{id}","href":"/api-reference/clients/delete-a-client"},{"title":"Update a client","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /clients/{id}","href":"/api-reference/clients/update-a-client"},{"title":"Search clients","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /clients/_search","href":"/api-reference/clients/search-clients"},{"title":"Bulk create clients","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /clients/_bulk","href":"/api-reference/clients/bulk-create-clients"},{"title":"Retrieve a credit report","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /clients/credit-reports/{reportId}","href":"/api-reference/clients/retrieve-a-credit-report"},{"title":"List credit reports","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /clients/{clientId}/credit-reports","href":"/api-reference/clients/list-credit-reports"},{"title":"Get client pipeline stages","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /pipeline/clients/stages","href":"/api-reference/clients/get-client-pipeline-stages"}]},{"group":"Companies","pages":[{"title":"Search companies","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /companies/_search","href":"/api-reference/companies/search-companies"},{"title":"Delete a company","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /companies/{id}","href":"/api-reference/companies/delete-a-company"},{"title":"Update a company","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /companies/{id}","href":"/api-reference/companies/update-a-company"},{"title":"Update company logo","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /companies/{id}/logo","href":"/api-reference/companies/update-company-logo"}]},{"group":"Consents","pages":[{"title":"Get consents","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /consents","href":"/api-reference/consents/get-consents"},{"title":"Create consent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /consents","href":"/api-reference/consents/create-consent"},{"title":"Delete consent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /consents/{consentId}","href":"/api-reference/consents/delete-consent"},{"title":"Update consent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /consents/{consentId}","href":"/api-reference/consents/update-consent"}]},{"group":"Custom Attributes","pages":[{"title":"List candidate custom attribute definitions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /custom-attributes/candidate/definitions","href":"/api-reference/custom-attributes/list-candidate-custom-attribute-definitions"},{"title":"Retrieve a candidate custom attribute definition","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /custom-attributes/candidate/definitions/{id}","href":"/api-reference/custom-attributes/retrieve-a-candidate-custom-attribute-definition"},{"title":"List client custom attribute definitions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /custom-attributes/client/definitions","href":"/api-reference/custom-attributes/list-client-custom-attribute-definitions"},{"title":"Retrieve a client custom attribute definition","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /custom-attributes/client/definitions/{id}","href":"/api-reference/custom-attributes/retrieve-a-client-custom-attribute-definition"},{"title":"List job custom attribute definitions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /custom-attributes/vacancy/definitions","href":"/api-reference/custom-attributes/list-job-custom-attribute-definitions"},{"title":"Retrieve a job custom attribute definition","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /custom-attributes/vacancy/definitions/{id}","href":"/api-reference/custom-attributes/retrieve-a-job-custom-attribute-definition"},{"title":"List contact custom attribute definitions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /custom-attributes/client-contact/definitions","href":"/api-reference/custom-attributes/list-contact-custom-attribute-definitions"},{"title":"Retrieve a contact custom attribute definition","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /custom-attributes/client-contact/definitions/{id}","href":"/api-reference/custom-attributes/retrieve-a-contact-custom-attribute-definition"},{"title":"List application custom attribute definitions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /custom-attributes/application/definitions","href":"/api-reference/custom-attributes/list-application-custom-attribute-definitions"},{"title":"Retrieve an application custom attribute definition","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /custom-attributes/application/definitions/{id}","href":"/api-reference/custom-attributes/retrieve-an-application-custom-attribute-definition"},{"title":"List placement custom attribute definitions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /custom-attributes/placement/definitions","href":"/api-reference/custom-attributes/list-placement-custom-attribute-definitions"},{"title":"Retrieve a placement custom attribute definition","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /custom-attributes/placement/definitions/{id}","href":"/api-reference/custom-attributes/retrieve-a-placement-custom-attribute-definition"},{"title":"List attachment custom attribute definitions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /custom-attributes/attachment/definitions","href":"/api-reference/custom-attributes/list-attachment-custom-attribute-definitions"},{"title":"Update custom attribute values for an attachment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /custom-attributes/attachments/{id}/values/_bulk","href":"/api-reference/custom-attributes/update-custom-attribute-values-for-an-attachment"},{"title":"Update custom attribute values for a candidate","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /custom-attributes/candidates/{id}/values/_bulk","href":"/api-reference/custom-attributes/update-custom-attribute-values-for-a-candidate"},{"title":"Update custom attribute values for a job","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /custom-attributes/vacancies/{id}/values/_bulk","href":"/api-reference/custom-attributes/update-custom-attribute-values-for-a-job"},{"title":"Update custom attribute values for a client","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /custom-attributes/clients/{id}/values/_bulk","href":"/api-reference/custom-attributes/update-custom-attribute-values-for-a-client"},{"title":"Update custom attribute values for a contact","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /custom-attributes/client-contacts/{id}/values/_bulk","href":"/api-reference/custom-attributes/update-custom-attribute-values-for-a-contact"},{"title":"Bulk update vacancy custom attribute values","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /custom-attributes/vacancies/values/_bulk","href":"/api-reference/custom-attributes/bulk-update-vacancy-custom-attribute-values"},{"title":"Bulk update client custom attribute values","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /custom-attributes/clients/values/_bulk","href":"/api-reference/custom-attributes/bulk-update-client-custom-attribute-values"},{"title":"Bulk update application custom attribute values","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /custom-attributes/applications/values/_bulk","href":"/api-reference/custom-attributes/bulk-update-application-custom-attribute-values"},{"title":"Update custom attribute values for an application","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /custom-attributes/applications/{id}/values/_bulk","href":"/api-reference/custom-attributes/update-custom-attribute-values-for-an-application"}]},{"group":"Enrichments","pages":[{"title":"Create enrichments","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /enrichments/_bulk","href":"/api-reference/enrichments/create-enrichments"}]},{"group":"Job Boards","pages":[{"title":"Create job board posting","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /job-boards","href":"/api-reference/job-boards/create-job-board-posting"},{"title":"Update job board posting","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /job-boards/postings/{jobBoardPostingId}","href":"/api-reference/job-boards/update-job-board-posting"},{"title":"Get job board postings for vacancy","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /job-boards/{vacancyId}","href":"/api-reference/job-boards/get-job-board-postings-for-vacancy"}]},{"group":"Job Descriptions","pages":[{"title":"List job descriptions for a job","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /job-descriptions","href":"/api-reference/job-descriptions/list-job-descriptions-for-a-job"},{"title":"Create a job description","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /job-descriptions","href":"/api-reference/job-descriptions/create-a-job-description"},{"title":"Get a job description","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /job-descriptions/{id}","href":"/api-reference/job-descriptions/get-a-job-description"},{"title":"Update job description","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /job-descriptions/{id}","href":"/api-reference/job-descriptions/update-job-description"},{"title":"Delete job description","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /job-descriptions/{id}","href":"/api-reference/job-descriptions/delete-job-description"},{"title":"Patch job description","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /job-descriptions/{id}","href":"/api-reference/job-descriptions/patch-job-description"},{"title":"Get job description for job","deprecated":true,"version":null,"openapi":"/api-reference/openapi.json get /job-descriptions/vacancy/{id}","href":"/api-reference/job-descriptions/get-job-description-for-job"}]},{"group":"Job Portal","pages":[{"title":"Submit job posting application","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /vacancy-portal/jobs/{jobBoardPostingId}","href":"/api-reference/job-portal/submit-job-posting-application"}]},{"group":"Jobs","pages":[{"title":"Get job pipeline stages","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /pipeline/vacancies/stages","href":"/api-reference/jobs/get-job-pipeline-stages"},{"title":"List jobs","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /vacancies","href":"/api-reference/jobs/list-jobs"},{"title":"Create a job","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /vacancies","href":"/api-reference/jobs/create-a-job"},{"title":"Retrieve a job","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /vacancies/{id}","href":"/api-reference/jobs/retrieve-a-job"},{"title":"Update a job","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /vacancies/{id}","href":"/api-reference/jobs/update-a-job"},{"title":"Retrieve a job scorecard","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /vacancies/{id}/scorecard","href":"/api-reference/jobs/retrieve-a-job-scorecard"},{"title":"Search jobs","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /vacancies/_search","href":"/api-reference/jobs/search-jobs"}]},{"group":"Lists","pages":[{"title":"Create a list","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /lists/{entityType}","href":"/api-reference/lists/create-a-list"},{"title":"List lists","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /lists","href":"/api-reference/lists/list-lists"},{"title":"Delete a list","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /lists/{entityType}/{id}","href":"/api-reference/lists/delete-a-list"},{"title":"Update a list","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /lists/{entityType}/{id}","href":"/api-reference/lists/update-a-list"}]},{"group":"Meetings","pages":[{"title":"List meetings","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /meetings","href":"/api-reference/meetings/list-meetings"},{"title":"Retrieve a meeting","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /meetings/{id}","href":"/api-reference/meetings/retrieve-a-meeting"}]},{"group":"Note Labels","pages":[{"title":"Get note labels","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /labels/note","href":"/api-reference/note-labels/get-note-labels"},{"title":"Create note label","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /labels/note","href":"/api-reference/note-labels/create-note-label"},{"title":"Update note label","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /labels/note/{id}","href":"/api-reference/note-labels/update-note-label"},{"title":"Delete note label","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /labels/note/{id}","href":"/api-reference/note-labels/delete-note-label"}]},{"group":"Notes","pages":[{"title":"List notes","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /notes","href":"/api-reference/notes/list-notes"},{"title":"Create a note","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /notes","href":"/api-reference/notes/create-a-note"},{"title":"Retrieve a note","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /notes/{id}","href":"/api-reference/notes/retrieve-a-note"},{"title":"Update a note","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /notes/{id}","href":"/api-reference/notes/update-a-note"},{"title":"Delete a note","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /notes/{id}","href":"/api-reference/notes/delete-a-note"},{"title":"Create a note link","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /notes/{id}/links","href":"/api-reference/notes/create-a-note-link"},{"title":"Delete a note link","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /notes/{id}/links/{linkId}","href":"/api-reference/notes/delete-a-note-link"}]},{"group":"Offices","pages":[{"title":"List offices","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /offices","href":"/api-reference/offices/list-offices"},{"title":"Create an office","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /offices","href":"/api-reference/offices/create-an-office"},{"title":"List office teams","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /offices/{id}/teams","href":"/api-reference/offices/list-office-teams"},{"title":"Retrieve an office","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /offices/{id}","href":"/api-reference/offices/retrieve-an-office"},{"title":"Delete an office","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /offices/{id}","href":"/api-reference/offices/delete-an-office"},{"title":"Update an office","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /offices/{id}","href":"/api-reference/offices/update-an-office"}]},{"group":"Opportunities","pages":[{"title":"List opportunities","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /opportunities","href":"/api-reference/opportunities/list-opportunities"},{"title":"Create an opportunity","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /opportunities","href":"/api-reference/opportunities/create-an-opportunity"},{"title":"Retrieve an opportunity","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /opportunities/{id}","href":"/api-reference/opportunities/retrieve-an-opportunity"},{"title":"Update an opportunity","description":"Updates the opportunity with the specified ID. You can update stage, close date, and other opportunity properties.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /opportunities/{id}","href":"/api-reference/opportunities/update-an-opportunity"},{"title":"Get opportunity pipeline stages","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /pipeline/opportunities/stages","href":"/api-reference/opportunities/get-opportunity-pipeline-stages"}]},{"group":"Outreach Sequences","pages":[{"title":"List outreach sequences","description":"Returns a list of outreach sequences. Uses cursor pagination.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /outreach-sequences","href":"/api-reference/outreach-sequences/list-outreach-sequences"},{"title":"Enroll a recipient in an outreach sequence","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /outreach-sequences/{id}/runs","href":"/api-reference/outreach-sequences/enroll-a-recipient-in-an-outreach-sequence"}]},{"group":"Placements","pages":[{"title":"List placements","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /placements","href":"/api-reference/placements/list-placements"},{"title":"Search placements","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /placements/_search","href":"/api-reference/placements/search-placements"},{"title":"Retrieve a placement","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /placements/{id}","href":"/api-reference/placements/retrieve-a-placement"},{"title":"Update a placement","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /placements/{id}","href":"/api-reference/placements/update-a-placement"}]},{"group":"Retained Searches","pages":[{"title":"List retained searches","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /vacancies/searches/retained","href":"/api-reference/retained-searches/list-retained-searches"},{"title":"Get retained search","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /vacancies/searches/retained/{id}","href":"/api-reference/retained-searches/get-retained-search"}]},{"group":"Roles","pages":[{"title":"List roles","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /roles","href":"/api-reference/roles/list-roles"}]},{"group":"Search People","pages":[{"title":"Search people","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /search/people","href":"/api-reference/search-people/search-people"}]},{"group":"Skills","pages":[{"title":"List skills","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /skills","href":"/api-reference/skills/list-skills"},{"title":"Create a skill","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /skills","href":"/api-reference/skills/create-a-skill"},{"title":"Create multiple skills","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /skills/_bulk","href":"/api-reference/skills/create-multiple-skills"},{"title":"Delete a skill","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /skills/{id}","href":"/api-reference/skills/delete-a-skill"},{"title":"Update a skill","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /skills/{id}","href":"/api-reference/skills/update-a-skill"},{"title":"Link candidates to a skill","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /skills/{id}/candidates/_link","href":"/api-reference/skills/link-candidates-to-a-skill"},{"title":"Unlink candidates from a skill","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /skills/{id}/candidates/_unlink","href":"/api-reference/skills/unlink-candidates-from-a-skill"}]},{"group":"Tasks","pages":[{"title":"List tasks","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /tasks","href":"/api-reference/tasks/list-tasks"},{"title":"Create task","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /tasks/_raw","href":"/api-reference/tasks/create-task"},{"title":"Delete a task","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /tasks/{id}","href":"/api-reference/tasks/delete-a-task"}]},{"group":"Teams","pages":[{"title":"List teams","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /teams","href":"/api-reference/teams/list-teams"},{"title":"Create a team","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /teams","href":"/api-reference/teams/create-a-team"},{"title":"List team members","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /teams/{id}/members","href":"/api-reference/teams/list-team-members"},{"title":"Retrieve a team","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /teams/{id}","href":"/api-reference/teams/retrieve-a-team"},{"title":"Delete a team","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /teams/{id}","href":"/api-reference/teams/delete-a-team"},{"title":"Update a team","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /teams/{id}","href":"/api-reference/teams/update-a-team"}]},{"group":"Transcripts","pages":[{"title":"Get transcript","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /transcripts/{id}","href":"/api-reference/transcripts/get-transcript"}]},{"group":"Users","pages":[{"title":"List users","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /users","href":"/api-reference/users/list-users"},{"title":"List users alias","deprecated":true,"version":null,"openapi":"/api-reference/openapi.json get /users/_list","href":"/api-reference/users/list-users-alias"}]}]}]},{"tab":"MCP","pages":[{"title":"MCP","href":"/docs/developers/mcp"}]},{"tab":"Webhooks","pages":[{"title":"Webhooks","href":"/docs/developers/webhooks"}]},{"tab":"What's New","pages":[{"title":"What's New","href":"/whats-new"}]}]},{"language":"fr","pages":[{"title":"fr","href":"/fr"}]},{"language":"nl","pages":[{"title":"nl","href":"/nl"}]},{"language":"de","pages":[{"title":"de","href":"/de"}]},{"language":"es","pages":[{"title":"es","href":"/es"}]}]},"title":"Get opportunity pipeline stages - Spott","buildId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","deploymentId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-rfhihCWU.js","utils-BmH1XFxk.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BcNsxPKB.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BAES3tkd.js","snippetPresets-DCMQBKLP.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-D6l_bzE9.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BOktbnNh.js","shallow-BCs8SgM7.js","getApiPlaygroundDisplay-DEmW5bJB.js","CodeSnippet-CpZOpB9C.js","CodeSnippets-BOBDqibl.js","Page-D5fEM6aW.js","getPastedJson-DH2JBvmr.js","icon-BBJH-kKh.js","MethodPill-D2Sd5NLC.js","DuplicateIcon-CGgfL2qN.js","createIcon-BKudBBzi.js","DynamicMarkdown-85clUA0i.js","SectionHeading-D0JiMgDx.js","axios-vUo_bRtp.js","Markdown-Cfiy0xZO.js","clsx-rL8ZCCw4.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-aeztFa9U.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BywkCr5C.js"]}