Basic authentication using an API key, e.g. {Authorization: Bearer aff_0bb4fbdf97b7e4111ff6c0015471094155f91}.
You can find your API key within the Settings page of the Affinda web app. You can obtain an API key by signing up for a free trial.
Visibility "organization" means everyone in the organization can access the workspace. Visibility "private" means only people explicitly added can access the workspace.
If true, the uploaded document will be rejected if it's of the wrong document type, or if its document type cannot be determined. No credits will be consumed.
If "true", parsing will fail when the uploaded document is duplicate of an existing document, no credits will be consumed. If "false", will parse the document normally whether its a duplicate or not. If not provided, will fallback to the workspace settings.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Affinda Extract Documentation","description":"Affinda Extract is a document AI platform that turns unstructured documents into structured, validated data through extraction, classification, splitting, and human review. Guides, API reference, and configuration playbooks for building and integrating Affinda models.","colors":{"primary":"#1F3339","light":"#A6FFFB","dark":"#A6FFFB"},"logo":{"light":"https://mintcdn.com/affinda-44/nvZZjc-QOoHXzSQ7/images/affindaextract-inkwell.png?fit=max\u0026auto=format\u0026n=nvZZjc-QOoHXzSQ7\u0026q=85\u0026s=a3e52ff1e274ac5509589a6350b41496","dark":"https://mintcdn.com/affinda-44/lcBcXTOY4DEPcniI/images/affindaextract-greenmist.png?fit=max\u0026auto=format\u0026n=lcBcXTOY4DEPcniI\u0026q=85\u0026s=318f55893ae70c89849919adbbc1a545","href":"https://www.affinda.com/"},"favicon":"https://mintcdn.com/affinda-44/zzz2NA-YwjYcDdgi/Affinda_GreenMist_inkwell_Favicon.png?fit=max\u0026auto=format\u0026n=zzz2NA-YwjYcDdgi\u0026q=85\u0026s=c83f557178ec0b196bef5bafec9b9faf","api":{"playground":{"display":"interactive"},"examples":{"languages":["curl","python","javascript"],"prefill":false}},"appearance":{"default":"system","strict":false},"background":{"decoration":"gradient","color":{"light":"#E8EEED","dark":"#102A2F"}},"navbar":{"links":[{"href":"https://www.affinda.com/pricing-plans","label":"Pricing"},{"href":"https://trust.affinda.com/","label":"Security"},{"href":"https://www.affinda.com/contact","label":"Contact"},{"href":"/support","label":"Support"}],"primary":{"type":"button","label":"Log in","href":"https://app.affinda.com"}},"footer":{"socials":{"linkedin":"https://linkedin.com/company/affinda","youtube":"https://www.youtube.com/@affinda","github":"https://github.com/affinda"}},"seo":{"metatags":{"og:image":"https://cdn.prod.website-files.com/6854ccfd1a7ab92f392b474d/68ae96fe8f3fdbbe0ae04c73_Affinda%20Open%20Graph%20image%20for%20website%20previews.png","og:site_name":"Affinda","twitter:site":"@affinda"}},"fonts":{"heading":{"family":"NeuSans","weight":500,"source":"https://cdn.prod.website-files.com/6854ccfd1a7ab92f392b474d/685b584938c8018fa3d2e9da_NeuSans-Bold.woff2","format":"woff2"},"body":{"family":"NeuSans","weight":400,"source":"https://cdn.prod.website-files.com/6854ccfd1a7ab92f392b474d/685b5849e08b8110997b8e4f_NeuSans-Regular.woff2","format":"woff2"}},"integrations":{"gtm":{"tagId":"GTM-NCW6M2B"}},"banner":{"content":"New to resume parsing? Start with the [Resume Parser console](https://resume-parser.affinda.com/). (Existing resume parsing integrations continue to be supported by Affinda Extract.)","color":{"light":"#B09670","dark":"#102A2F"}},"contextual":{"options":["copy","view","chatgpt","claude"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"affinda-44","hasAudioNarration":false,"actualSubdomain":"affinda-44","customDomains":["docs.affinda.com"],"gitSource":{"type":"github","owner":"affinda","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ac56a0f3afc16a603ad513a","collectionId":"7b08d586-aac3-44c0-9991-f40a6da86c49","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ac56a0f3afc16a603ad513a"},"feedback":{"thumbs":true,"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ac56a0f3afc16a603ad513a","clientVersion":"0.0.4006","searchFilterCounts":[{"language":"default","tag":"API Reference","count":163},{"language":"default","tag":"Endpoints","count":108},{"language":"default","tag":"Deprecated Versions","count":45},{"language":"default","tag":"v2 Endpoints (Legacy)","count":45},{"language":"default","tag":"Configuration Guide","count":27},{"language":"default","tag":"Deprecated End Points","count":25},{"language":"default","tag":"Search \u0026 Match","count":24},{"language":"default","tag":"Extract Handbook","count":13},{"language":"default","tag":"Additional Resources","count":10},{"language":"default","tag":"Data Sources","count":10}]},"assistantConfig":{"enableAskAiButton":true,"enableAskAiSearchBar":true,"deflection":{"enabled":true,"email":"support@affinda.com","showHelpButton":true}},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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":"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":"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}],"privacy":{"consentBanner":{"enabled":true}},"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"html.dark{--tw-prose-body:#FFF9F0;--tw-prose-headings:#FFFFFF;--tw-prose-bullets:#FFFFFF}html.dark .mdx-content{color:#fff9f0}#navbar a[href*=\"app.affinda.com\"],#navbar a[href*=\"app.affinda.com\"] *,#navbar-primary-cta,#navbar-primary-cta *,a[href=\"https://app.affinda.com\"],a[href=\"https://app.affinda.com\"] *,span.text-white.z-10{color:#000!important}"}],"page":{"pagePath":"api-reference/workspaces/get-list-of-all-workspaces","slug":"/api-reference/workspaces/get-list-of-all-workspaces","pageMetadata":{"title":"Get list of all workspaces","description":"Returns your workspaces.","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml get /v3/workspaces","href":"/api-reference/workspaces/get-list-of-all-workspaces","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: \"Returns your workspaces.\"\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 list of all workspaces","description":"Returns your workspaces.","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml get /v3/workspaces","href":"/api-reference/workspaces/get-list-of-all-workspaces","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Workspaces"],"summary":"Get list of all workspaces","operationId":"getAllWorkspaces","description":"Returns your workspaces.","parameters":["a58c6c7a-74a8-495d-ac1f-8d9a703bb4cc","b0f18a85-5dd2-44ea-a600-8a73441fb27f"],"responses":{"200":"977bbf10-addb-420a-8527-cdc0ffc1d5f5","400":"f0027a4e-53c7-4fb1-a2b0-3decf21a6e80","401":"669e712a-fc4c-408b-8c58-c7abc400f73b","default":"6a4d8079-81e2-49ca-aeee-7ddf3148726e"},"method":"get","type":"path","servers":["bb6d2c32-dd7a-49e6-890d-c07838ca7ce4"],"security":["d9dd6b44-a7ae-459f-b82c-e1a00027d890"],"path":"/v3/workspaces","baseUrlOptions":["https://{region}.affinda.com"],"title":"Get list of all workspaces","codeSamples":[],"requestExampleLanguages":["bash","python","javascript"],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"a58c6c7a-74a8-495d-ac1f-8d9a703bb4cc":{"in":"query","name":"organization","required":true,"schema":{"type":"string","description":"Filter by organization.\nUniquely identify an organization.","example":"mEFayXdO","isRequired":true,"uniqueKey":"","typeLabel":"string"},"description":"Filter by organization."},"b0f18a85-5dd2-44ea-a600-8a73441fb27f":{"in":"query","name":"name","schema":{"type":"string","description":"Filter by name.","uniqueKey":"","typeLabel":"string"},"description":"Filter by name."}},"responses":{"977bbf10-addb-420a-8527-cdc0ffc1d5f5":{"description":"All matching workspaces.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","required":["identifier"],"properties":{"identifier":{"type":"string","description":"Uniquely identify a workspace.","example":"mEFayXdO","isRequired":true,"uniqueKey":"items.[INDEX].identifier","typeLabel":"string"},"organization":{"type":"object","required":["identifier","name","userRole","avatar","resthookSignatureKey","isTrial","validationToolConfig","showCustomFieldCreation","allowDataSourceRecordCreation"],"properties":{"identifier":{"type":"string","description":"Uniquely identify an organization.","example":"mEFayXdO","isRequired":true,"uniqueKey":"items.[INDEX].organization.identifier","typeLabel":"string"},"name":{"type":"string","example":"Grove Street King","isRequired":true,"uniqueKey":"items.[INDEX].organization.name","typeLabel":"string"},"userRole":{"oneOf":[{"type":"string","description":"The role of the logged in user within the organization.","enum":["admin","member"],"example":"admin","isRequired":true,"uniqueKey":"items.[INDEX].organization.userRole.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","isRequired":true,"uniqueKey":"items.[INDEX].organization.userRole.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"items.[INDEX].organization.userRole","typeLabel":"enum\u003cstring> | null"},"avatar":{"oneOf":[{"type":"string","description":"URL of the organization's avatar.","example":"https://affinda-api.s3.amazonaws.com/media/org-avatar.png?AWSAccessKeyId=KEY\u0026Signature=SIG","isRequired":true,"uniqueKey":"items.[INDEX].organization.avatar.oneOf.0","typeLabel":"string"},{"type":"null","description":"URL of the organization's avatar.","example":"https://affinda-api.s3.amazonaws.com/media/org-avatar.png?AWSAccessKeyId=KEY\u0026Signature=SIG","isRequired":true,"uniqueKey":"items.[INDEX].organization.avatar.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"items.[INDEX].organization.avatar","typeLabel":"string | null"},"resthookSignatureKey":{"oneOf":[{"type":"string","description":"Used to sign webhook payloads so you can verify their integrity.","example":"465c6598bd34c0558f0ce256c43209d49fa85b0ff3e4c18b24e408b7563143ad","isRequired":true,"uniqueKey":"items.[INDEX].organization.resthookSignatureKey.oneOf.0","typeLabel":"string"},{"type":"null","description":"Used to sign webhook payloads so you can verify their integrity.","example":"465c6598bd34c0558f0ce256c43209d49fa85b0ff3e4c18b24e408b7563143ad","isRequired":true,"uniqueKey":"items.[INDEX].organization.resthookSignatureKey.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"items.[INDEX].organization.resthookSignatureKey","typeLabel":"string | null"},"isTrial":{"type":"boolean","isRequired":true,"uniqueKey":"items.[INDEX].organization.isTrial","typeLabel":"boolean"},"validationToolConfig":{"oneOf":[{"type":"object","description":"Configuration of the embeddable validation tool.","properties":{"theme":{"type":"object","properties":{"palette":{"type":"object","properties":{"mode":{"type":"string","enum":["light","dark"],"uniqueKey":"items.[INDEX].organization.validationToolConfig.oneOf.0.theme.palette.mode","typeLabel":"enum\u003cstring>"},"background":{"oneOf":[{"type":"string","uniqueKey":"items.[INDEX].organization.validationToolConfig.oneOf.0.theme.palette.background.oneOf.0","typeLabel":"string"},{"type":"object","properties":{"default":{"type":"string","uniqueKey":"items.[INDEX].organization.validationToolConfig.oneOf.0.theme.palette.background.oneOf.1.default","typeLabel":"string"},"paper":{"type":"string","uniqueKey":"items.[INDEX].organization.validationToolConfig.oneOf.0.theme.palette.background.oneOf.1.paper","typeLabel":"string"}},"uniqueKey":"items.[INDEX].organization.validationToolConfig.oneOf.0.theme.palette.background.oneOf.1","typeLabel":"object"}],"uniqueKey":"items.[INDEX].organization.validationToolConfig.oneOf.0.theme.palette.background","typeLabel":"string | object"},"text":{"type":"object","properties":{"primary":{"type":"string","uniqueKey":"items.[INDEX].organization.validationToolConfig.oneOf.0.theme.palette.text.primary","typeLabel":"string"},"secondary":{"type":"string","uniqueKey":"items.[INDEX].organization.validationToolConfig.oneOf.0.theme.palette.text.secondary","typeLabel":"string"},"disabled":{"type":"string","uniqueKey":"items.[INDEX].organization.validationToolConfig.oneOf.0.theme.palette.text.disabled","typeLabel":"string"}},"uniqueKey":"items.[INDEX].organization.validationToolConfig.oneOf.0.theme.palette.text","typeLabel":"object"},"divider":{"type":"string","uniqueKey":"items.[INDEX].organization.validationToolConfig.oneOf.0.theme.palette.divider","typeLabel":"string"},"primary":{"type":"object","required":["main"],"properties":{"main":{"type":"string","isRequired":true,"uniqueKey":"items.[INDEX].organization.validationToolConfig.oneOf.0.theme.palette.primary.main","typeLabel":"string"},"light":{"type":"string","uniqueKey":"items.[INDEX].organization.validationToolConfig.oneOf.0.theme.palette.primary.light","typeLabel":"string"},"dark":{"type":"string","uniqueKey":"items.[INDEX].organization.validationToolConfig.oneOf.0.theme.palette.primary.dark","typeLabel":"string"},"contrastText":{"type":"string","uniqueKey":"items.[INDEX].organization.validationToolConfig.oneOf.0.theme.palette.primary.contrastText","typeLabel":"string"}},"uniqueKey":"items.[INDEX].organization.validationToolConfig.oneOf.0.theme.palette.primary","typeLabel":"object"},"secondary":{"type":"object","required":["main"],"properties":{"main":{"type":"string","isRequired":true,"uniqueKey":"items.[INDEX].organization.validationToolConfig.oneOf.0.theme.palette.secondary.main","typeLabel":"string"},"light":{"type":"string","uniqueKey":"items.[INDEX].organization.validationToolConfig.oneOf.0.theme.palette.secondary.light","typeLabel":"string"},"dark":{"type":"string","uniqueKey":"items.[INDEX].organization.validationToolConfig.oneOf.0.theme.palette.secondary.dark","typeLabel":"string"},"contrastText":{"type":"string","uniqueKey":"items.[INDEX].organization.validationToolConfig.oneOf.0.theme.palette.secondary.contrastText","typeLabel":"string"}},"uniqueKey":"items.[INDEX].organization.validationToolConfig.oneOf.0.theme.palette.secondary","typeLabel":"object"},"success":{"type":"object","required":["main"],"properties":{"main":{"type":"string","isRequired":true,"uniqueKey":"items.[INDEX].organization.validationToolConfig.oneOf.0.theme.palette.success.main","typeLabel":"string"},"light":{"type":"string","uniqueKey":"items.[INDEX].organization.validationToolConfig.oneOf.0.theme.palette.success.light","typeLabel":"string"},"dark":{"type":"string","uniqueKey":"items.[INDEX].organization.validationToolConfig.oneOf.0.theme.palette.success.dark","typeLabel":"string"},"contrastText":{"type":"string","uniqueKey":"items.[INDEX].organization.validationToolConfig.oneOf.0.theme.palette.success.contrastText","typeLabel":"string"}},"uniqueKey":"items.[INDEX].organization.validationToolConfig.oneOf.0.theme.palette.success","typeLabel":"object"},"annotation":{"type":"object","required":["main"],"properties":{"main":{"type":"string","isRequired":true,"uniqueKey":"items.[INDEX].organization.validationToolConfig.oneOf.0.theme.palette.annotation.main","typeLabel":"string"},"light":{"type":"string","uniqueKey":"items.[INDEX].organization.validationToolConfig.oneOf.0.theme.palette.annotation.light","typeLabel":"string"},"dark":{"type":"string","uniqueKey":"items.[INDEX].organization.validationToolConfig.oneOf.0.theme.palette.annotation.dark","typeLabel":"string"},"contrastText":{"type":"string","uniqueKey":"items.[INDEX].organization.validationToolConfig.oneOf.0.theme.palette.annotation.contrastText","typeLabel":"string"}},"uniqueKey":"items.[INDEX].organization.validationToolConfig.oneOf.0.theme.palette.annotation","typeLabel":"object"},"error":{"type":"object","required":["main"],"properties":{"main":{"type":"string","isRequired":true,"uniqueKey":"items.[INDEX].organization.validationToolConfig.oneOf.0.theme.palette.error.main","typeLabel":"string"},"light":{"type":"string","uniqueKey":"items.[INDEX].organization.validationToolConfig.oneOf.0.theme.palette.error.light","typeLabel":"string"},"dark":{"type":"string","uniqueKey":"items.[INDEX].organization.validationToolConfig.oneOf.0.theme.palette.error.dark","typeLabel":"string"},"contrastText":{"type":"string","uniqueKey":"items.[INDEX].organization.validationToolConfig.oneOf.0.theme.palette.error.contrastText","typeLabel":"string"}},"uniqueKey":"items.[INDEX].organization.validationToolConfig.oneOf.0.theme.palette.error","typeLabel":"object"},"info":{"type":"object","required":["main"],"properties":{"main":{"type":"string","isRequired":true,"uniqueKey":"items.[INDEX].organization.validationToolConfig.oneOf.0.theme.palette.info.main","typeLabel":"string"},"light":{"type":"string","uniqueKey":"items.[INDEX].organization.validationToolConfig.oneOf.0.theme.palette.info.light","typeLabel":"string"},"dark":{"type":"string","uniqueKey":"items.[INDEX].organization.validationToolConfig.oneOf.0.theme.palette.info.dark","typeLabel":"string"},"contrastText":{"type":"string","uniqueKey":"items.[INDEX].organization.validationToolConfig.oneOf.0.theme.palette.info.contrastText","typeLabel":"string"}},"uniqueKey":"items.[INDEX].organization.validationToolConfig.oneOf.0.theme.palette.info","typeLabel":"object"},"warning":{"type":"object","required":["main"],"properties":{"main":{"type":"string","isRequired":true,"uniqueKey":"items.[INDEX].organization.validationToolConfig.oneOf.0.theme.palette.warning.main","typeLabel":"string"},"light":{"type":"string","uniqueKey":"items.[INDEX].organization.validationToolConfig.oneOf.0.theme.palette.warning.light","typeLabel":"string"},"dark":{"type":"string","uniqueKey":"items.[INDEX].organization.validationToolConfig.oneOf.0.theme.palette.warning.dark","typeLabel":"string"},"contrastText":{"type":"string","uniqueKey":"items.[INDEX].organization.validationToolConfig.oneOf.0.theme.palette.warning.contrastText","typeLabel":"string"}},"uniqueKey":"items.[INDEX].organization.validationToolConfig.oneOf.0.theme.palette.warning","typeLabel":"object"}},"uniqueKey":"items.[INDEX].organization.validationToolConfig.oneOf.0.theme.palette","typeLabel":"object"},"typography":{"type":"object","properties":{"fontFamily":{"type":"string","uniqueKey":"items.[INDEX].organization.validationToolConfig.oneOf.0.theme.typography.fontFamily","typeLabel":"string"},"fontSize":{"oneOf":[{"type":"string","uniqueKey":"items.[INDEX].organization.validationToolConfig.oneOf.0.theme.typography.fontSize.oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"items.[INDEX].organization.validationToolConfig.oneOf.0.theme.typography.fontSize.oneOf.1","typeLabel":"number"}],"uniqueKey":"items.[INDEX].organization.validationToolConfig.oneOf.0.theme.typography.fontSize","typeLabel":"string | number"},"fontWeightRegular":{"type":"string","uniqueKey":"items.[INDEX].organization.validationToolConfig.oneOf.0.theme.typography.fontWeightRegular","typeLabel":"string"},"fontWeightMedium":{"type":"string","uniqueKey":"items.[INDEX].organization.validationToolConfig.oneOf.0.theme.typography.fontWeightMedium","typeLabel":"string"},"fontWeightBold":{"type":"string","uniqueKey":"items.[INDEX].organization.validationToolConfig.oneOf.0.theme.typography.fontWeightBold","typeLabel":"string"}},"uniqueKey":"items.[INDEX].organization.validationToolConfig.oneOf.0.theme.typography","typeLabel":"object"},"borderRadius":{"type":"number","uniqueKey":"items.[INDEX].organization.validationToolConfig.oneOf.0.theme.borderRadius","typeLabel":"number"},"fontUrl":{"type":"string","uniqueKey":"items.[INDEX].organization.validationToolConfig.oneOf.0.theme.fontUrl","typeLabel":"string"}},"uniqueKey":"items.[INDEX].organization.validationToolConfig.oneOf.0.theme","typeLabel":"object"},"hideActions":{"type":"boolean","description":"Hide the confirm document button and other actions.","uniqueKey":"items.[INDEX].organization.validationToolConfig.oneOf.0.hideActions","typeLabel":"boolean"},"hideCollection":{"type":"boolean","description":"Hide the collection selector.","uniqueKey":"items.[INDEX].organization.validationToolConfig.oneOf.0.hideCollection","typeLabel":"boolean"},"hideEditPages":{"type":"boolean","description":"Hide the edit pages button.","uniqueKey":"items.[INDEX].organization.validationToolConfig.oneOf.0.hideEditPages","typeLabel":"boolean"},"hideExport":{"type":"boolean","description":"Hide the export menu.","uniqueKey":"items.[INDEX].organization.validationToolConfig.oneOf.0.hideExport","typeLabel":"boolean"},"hideFilename":{"type":"boolean","description":"Hide the filename input.","uniqueKey":"items.[INDEX].organization.validationToolConfig.oneOf.0.hideFilename","typeLabel":"boolean"},"hideShowRawValues":{"type":"boolean","description":"Hide the toggle for showing raw annotation values.","uniqueKey":"items.[INDEX].organization.validationToolConfig.oneOf.0.hideShowRawValues","typeLabel":"boolean"},"hideReject":{"type":"boolean","description":"Hide the reject document button.","uniqueKey":"items.[INDEX].organization.validationToolConfig.oneOf.0.hideReject","typeLabel":"boolean"},"hideReparse":{"type":"boolean","description":"Hide the reparse button.","uniqueKey":"items.[INDEX].organization.validationToolConfig.oneOf.0.hideReparse","typeLabel":"boolean"},"hideRunOcr":{"type":"boolean","description":"Hide the run OCR button.","uniqueKey":"items.[INDEX].organization.validationToolConfig.oneOf.0.hideRunOcr","typeLabel":"boolean"},"hideTags":{"type":"boolean","description":"Hide the tags editor.","uniqueKey":"items.[INDEX].organization.validationToolConfig.oneOf.0.hideTags","typeLabel":"boolean"},"hideWarnings":{"type":"boolean","description":"Hide the warnings panel.","uniqueKey":"items.[INDEX].organization.validationToolConfig.oneOf.0.hideWarnings","typeLabel":"boolean"},"restrictDocumentSplitting":{"type":"boolean","description":"Disable the page editor after a document has been split once.","uniqueKey":"items.[INDEX].organization.validationToolConfig.oneOf.0.restrictDocumentSplitting","typeLabel":"boolean"},"disableCurrencyFormatting":{"type":"boolean","description":"Disable currency formatting of decimals values.","uniqueKey":"items.[INDEX].organization.validationToolConfig.oneOf.0.disableCurrencyFormatting","typeLabel":"boolean"},"disableEditDocumentMetadata":{"type":"boolean","description":"Disable editing document metadata. Makes the collection selector, filename input and tags editor read only.","uniqueKey":"items.[INDEX].organization.validationToolConfig.oneOf.0.disableEditDocumentMetadata","typeLabel":"boolean"},"disableManualAnnotationEditing":{"type":"boolean","description":"Disable manual editing of annotation values via the validation popover.","uniqueKey":"items.[INDEX].organization.validationToolConfig.oneOf.0.disableManualAnnotationEditing","typeLabel":"boolean"},"hideDocumentStatus":{"type":"boolean","description":"Hide the document status indicator in the toolbar.","uniqueKey":"items.[INDEX].organization.validationToolConfig.oneOf.0.hideDocumentStatus","typeLabel":"boolean"}},"isRequired":true,"uniqueKey":"items.[INDEX].organization.validationToolConfig.oneOf.0","typeLabel":"object"},{"type":"null","description":"Configuration of the embeddable validation tool.","properties":{"theme":{"type":"object","properties":{"palette":{"type":"object","properties":{"mode":{"type":"string","enum":["light","dark"]},"background":{"oneOf":[{"type":"string"},{"type":"object","properties":{"default":{"type":"string"},"paper":{"type":"string"}}}]},"text":{"type":"object","properties":{"primary":{"type":"string"},"secondary":{"type":"string"},"disabled":{"type":"string"}}},"divider":{"type":"string"},"primary":{"type":"object","required":["main"],"properties":{"main":{"type":"string"},"light":{"type":"string"},"dark":{"type":"string"},"contrastText":{"type":"string"}}},"secondary":{"type":"object","required":["main"],"properties":{"main":{"type":"string"},"light":{"type":"string"},"dark":{"type":"string"},"contrastText":{"type":"string"}}},"success":{"type":"object","required":["main"],"properties":{"main":{"type":"string"},"light":{"type":"string"},"dark":{"type":"string"},"contrastText":{"type":"string"}}},"annotation":{"type":"object","required":["main"],"properties":{"main":{"type":"string"},"light":{"type":"string"},"dark":{"type":"string"},"contrastText":{"type":"string"}}},"error":{"type":"object","required":["main"],"properties":{"main":{"type":"string"},"light":{"type":"string"},"dark":{"type":"string"},"contrastText":{"type":"string"}}},"info":{"type":"object","required":["main"],"properties":{"main":{"type":"string"},"light":{"type":"string"},"dark":{"type":"string"},"contrastText":{"type":"string"}}},"warning":{"type":"object","required":["main"],"properties":{"main":{"type":"string"},"light":{"type":"string"},"dark":{"type":"string"},"contrastText":{"type":"string"}}}}},"typography":{"type":"object","properties":{"fontFamily":{"type":"string"},"fontSize":{"oneOf":[{"type":"string"},{"type":"number"}]},"fontWeightRegular":{"type":"string"},"fontWeightMedium":{"type":"string"},"fontWeightBold":{"type":"string"}}},"borderRadius":{"type":"number"},"fontUrl":{"type":"string"}}},"hideActions":{"type":"boolean","description":"Hide the confirm document button and other actions."},"hideCollection":{"type":"boolean","description":"Hide the collection selector."},"hideEditPages":{"type":"boolean","description":"Hide the edit pages button."},"hideExport":{"type":"boolean","description":"Hide the export menu."},"hideFilename":{"type":"boolean","description":"Hide the filename input."},"hideShowRawValues":{"type":"boolean","description":"Hide the toggle for showing raw annotation values."},"hideReject":{"type":"boolean","description":"Hide the reject document button."},"hideReparse":{"type":"boolean","description":"Hide the reparse button."},"hideRunOcr":{"type":"boolean","description":"Hide the run OCR button."},"hideTags":{"type":"boolean","description":"Hide the tags editor."},"hideWarnings":{"type":"boolean","description":"Hide the warnings panel."},"restrictDocumentSplitting":{"type":"boolean","description":"Disable the page editor after a document has been split once."},"disableCurrencyFormatting":{"type":"boolean","description":"Disable currency formatting of decimals values."},"disableEditDocumentMetadata":{"type":"boolean","description":"Disable editing document metadata. Makes the collection selector, filename input and tags editor read only."},"disableManualAnnotationEditing":{"type":"boolean","description":"Disable manual editing of annotation values via the validation popover."},"hideDocumentStatus":{"type":"boolean","description":"Hide the document status indicator in the toolbar."}},"isRequired":true,"uniqueKey":"items.[INDEX].organization.validationToolConfig.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"items.[INDEX].organization.validationToolConfig","typeLabel":"object | null"},"showCustomFieldCreation":{"type":"boolean","description":"Whether to show the custom field creation in the UI.","isRequired":true,"uniqueKey":"items.[INDEX].organization.showCustomFieldCreation","typeLabel":"boolean"},"allowDataSourceRecordCreation":{"type":"boolean","description":"Allow reviewers to create missing records from the data source selector. Keep disabled when data sources are managed by external system syncs.","isRequired":true,"uniqueKey":"items.[INDEX].organization.allowDataSourceRecordCreation","typeLabel":"boolean"}},"uniqueKey":"items.[INDEX].organization","typeLabel":"object"},"name":{"type":"string","uniqueKey":"items.[INDEX].name","typeLabel":"string"},"visibility":{"type":"string","enum":["organization","private"],"description":"Visibility \"organization\" means everyone in the organization can access the workspace. Visibility \"private\" means only people explicitly added can access the workspace.","example":"organization","uniqueKey":"items.[INDEX].visibility","typeLabel":"enum\u003cstring>"},"collections":{"type":"array","items":{"type":"object","required":["identifier","name","extractor"],"properties":{"identifier":{"type":"string","description":"Uniquely identify a collection.","example":"mEFayXdO","isRequired":true,"uniqueKey":"items.[INDEX].collections.items.[INDEX].identifier","typeLabel":"string"},"name":{"type":"string","isRequired":true,"uniqueKey":"items.[INDEX].collections.items.[INDEX].name","typeLabel":"string"},"extractor":{"type":"object","required":["identifier","name","namePlural","validatable"],"properties":{"identifier":{"type":"string","description":"Uniquely identify an extractor.","example":"resume","isRequired":true,"uniqueKey":"items.[INDEX].collections.items.[INDEX].extractor.identifier","typeLabel":"string"},"name":{"type":"string","isRequired":true,"uniqueKey":"items.[INDEX].collections.items.[INDEX].extractor.name","typeLabel":"string"},"namePlural":{"type":"string","isRequired":true,"uniqueKey":"items.[INDEX].collections.items.[INDEX].extractor.namePlural","typeLabel":"string"},"validatable":{"type":"boolean","isRequired":true,"uniqueKey":"items.[INDEX].collections.items.[INDEX].extractor.validatable","typeLabel":"boolean"},"baseExtractor":{"oneOf":[{"type":"object","required":["identifier","name","namePlural","validatable"],"properties":{"identifier":{"type":"string","description":"Uniquely identify an extractor.","example":"resume","isRequired":true,"uniqueKey":"items.[INDEX].collections.items.[INDEX].extractor.baseExtractor.oneOf.0.identifier","typeLabel":"string"},"name":{"type":"string","isRequired":true,"uniqueKey":"items.[INDEX].collections.items.[INDEX].extractor.baseExtractor.oneOf.0.name","typeLabel":"string"},"namePlural":{"type":"string","isRequired":true,"uniqueKey":"items.[INDEX].collections.items.[INDEX].extractor.baseExtractor.oneOf.0.namePlural","typeLabel":"string"},"validatable":{"type":"boolean","isRequired":true,"uniqueKey":"items.[INDEX].collections.items.[INDEX].extractor.baseExtractor.oneOf.0.validatable","typeLabel":"boolean"},"isCustom":{"type":"boolean","uniqueKey":"items.[INDEX].collections.items.[INDEX].extractor.baseExtractor.oneOf.0.isCustom","typeLabel":"boolean"},"createdDt":{"type":"string","format":"date-time","uniqueKey":"items.[INDEX].collections.items.[INDEX].extractor.baseExtractor.oneOf.0.createdDt","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"items.[INDEX].collections.items.[INDEX].extractor.baseExtractor.oneOf.0","typeLabel":"object"},{"type":"null","required":["identifier","name","namePlural","validatable"],"properties":{"identifier":{"type":"string","description":"Uniquely identify an extractor.","example":"resume"},"name":{"type":"string"},"namePlural":{"type":"string"},"validatable":{"type":"boolean"},"isCustom":{"type":"boolean"},"createdDt":{"type":"string","format":"date-time"}},"uniqueKey":"items.[INDEX].collections.items.[INDEX].extractor.baseExtractor.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].collections.items.[INDEX].extractor.baseExtractor","typeLabel":"object | null"},"category":{"oneOf":[{"type":"string","example":"Recruitment","uniqueKey":"items.[INDEX].collections.items.[INDEX].extractor.category.oneOf.0","typeLabel":"string"},{"type":"null","example":"Recruitment","uniqueKey":"items.[INDEX].collections.items.[INDEX].extractor.category.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].collections.items.[INDEX].extractor.category","typeLabel":"string | null"},"createdDt":{"type":"string","format":"date-time","uniqueKey":"items.[INDEX].collections.items.[INDEX].extractor.createdDt","typeLabel":"string\u003cdate-time>"}},"isRequired":true,"uniqueKey":"items.[INDEX].collections.items.[INDEX].extractor","typeLabel":"object"},"unvalidatedDocsCount":{"oneOf":[{"type":"integer","minimum":0,"description":"Number of unvalidated documents in the collection.","uniqueKey":"items.[INDEX].collections.items.[INDEX].unvalidatedDocsCount.oneOf.0","typeLabel":"integer"},{"type":"null","minimum":0,"description":"Number of unvalidated documents in the collection.","uniqueKey":"items.[INDEX].collections.items.[INDEX].unvalidatedDocsCount.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].collections.items.[INDEX].unvalidatedDocsCount","typeLabel":"integer | null"},"confirmedDocsCount":{"oneOf":[{"type":"integer","minimum":0,"description":"Number of validated documents in the collection.","uniqueKey":"items.[INDEX].collections.items.[INDEX].confirmedDocsCount.oneOf.0","typeLabel":"integer"},{"type":"null","minimum":0,"description":"Number of validated documents in the collection.","uniqueKey":"items.[INDEX].collections.items.[INDEX].confirmedDocsCount.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].collections.items.[INDEX].confirmedDocsCount","typeLabel":"integer | null"}},"uniqueKey":"items.[INDEX].collections.items.[INDEX]","typeLabel":"object"},"uniqueKey":"items.[INDEX].collections","typeLabel":"object[]"},"documentTypes":{"type":"array","description":"Document types associated with this workspace","items":{"type":"string","description":"Uniquely identify a collection.","example":"mEFayXdO","uniqueKey":"items.[INDEX].documentTypes.items.[INDEX]","typeLabel":"string"},"uniqueKey":"items.[INDEX].documentTypes","typeLabel":"string[]"},"rejectInvalidDocuments":{"type":"boolean","description":"If true, the uploaded document will be rejected if it's of the wrong document type, or if its document type cannot be determined. No credits will be consumed.","uniqueKey":"items.[INDEX].rejectInvalidDocuments","typeLabel":"boolean"},"rejectDuplicates":{"oneOf":[{"type":"boolean","description":"If \"true\", parsing will fail when the uploaded document is duplicate of an existing document, no credits will be consumed. If \"false\", will parse the document normally whether its a duplicate or not. If not provided, will fallback to the workspace settings.","example":true,"uniqueKey":"items.[INDEX].rejectDuplicates.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"If \"true\", parsing will fail when the uploaded document is duplicate of an existing document, no credits will be consumed. If \"false\", will parse the document normally whether its a duplicate or not. If not provided, will fallback to the workspace settings.","example":true,"uniqueKey":"items.[INDEX].rejectDuplicates.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].rejectDuplicates","typeLabel":"boolean | null"},"members":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","description":"Uniquely identify a user.","example":1,"minimum":1,"uniqueKey":"items.[INDEX].members.items.[INDEX].id","typeLabel":"integer"},"name":{"type":"string","example":"Carl Johnson","uniqueKey":"items.[INDEX].members.items.[INDEX].name","typeLabel":"string"},"username":{"type":"string","example":"carljohnson","uniqueKey":"items.[INDEX].members.items.[INDEX].username","typeLabel":"string"},"email":{"type":"string","example":"carljohnson@grove.street","uniqueKey":"items.[INDEX].members.items.[INDEX].email","typeLabel":"string"},"avatar":{"oneOf":[{"type":"string","description":"URL of the user's avatar.","example":"https://affinda-api.s3.amazonaws.com/media/user-avatar.png?AWSAccessKeyId=KEY\u0026Signature=SIG","uniqueKey":"items.[INDEX].members.items.[INDEX].avatar.oneOf.0","typeLabel":"string"},{"type":"null","description":"URL of the user's avatar.","example":"https://affinda-api.s3.amazonaws.com/media/user-avatar.png?AWSAccessKeyId=KEY\u0026Signature=SIG","uniqueKey":"items.[INDEX].members.items.[INDEX].avatar.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].members.items.[INDEX].avatar","typeLabel":"string | null"}},"uniqueKey":"items.[INDEX].members.items.[INDEX]","typeLabel":"object"},"uniqueKey":"items.[INDEX].members","typeLabel":"object[]"},"unvalidatedDocsCount":{"type":"integer","minimum":0,"description":"Number of unvalidated documents in the workspace.","uniqueKey":"items.[INDEX].unvalidatedDocsCount","typeLabel":"integer"},"confirmedDocsCount":{"type":"integer","minimum":0,"description":"Number of validated documents in the workspace.","uniqueKey":"items.[INDEX].confirmedDocsCount","typeLabel":"integer"},"ingestEmail":{"type":"string","description":"When you send email to this address, any document attached in the body will be uploaded to this workspace.","uniqueKey":"items.[INDEX].ingestEmail","typeLabel":"string"},"whitelistIngestAddresses":{"oneOf":[{"type":"array","description":"If specified, only emails from these addresses will be ingested for parsing. Wild cards are allowed, e.g. \"*@eyefind.info\".","items":{"type":"string","example":"*@eyefind.info","uniqueKey":"items.[INDEX].whitelistIngestAddresses.oneOf.0.items.[INDEX]","typeLabel":"string"},"uniqueKey":"items.[INDEX].whitelistIngestAddresses.oneOf.0","typeLabel":"string[]"},{"type":"null","description":"If specified, only emails from these addresses will be ingested for parsing. Wild cards are allowed, e.g. \"*@eyefind.info\".","items":{"type":"string","example":"*@eyefind.info"},"uniqueKey":"items.[INDEX].whitelistIngestAddresses.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].whitelistIngestAddresses","typeLabel":"string[] | null"},"documentSplitter":{"oneOf":[{"type":"object","required":["identifier","name"],"properties":{"identifier":{"type":"string","description":"Uniquely identify a document splitter.","example":"NqIvMvZl","isRequired":true,"uniqueKey":"items.[INDEX].documentSplitter.oneOf.0.identifier","typeLabel":"string"},"name":{"type":"string","isRequired":true,"uniqueKey":"items.[INDEX].documentSplitter.oneOf.0.name","typeLabel":"string"}},"uniqueKey":"items.[INDEX].documentSplitter.oneOf.0","typeLabel":"object"},{"type":"null","required":["identifier","name"],"properties":{"identifier":{"type":"string","description":"Uniquely identify a document splitter.","example":"NqIvMvZl"},"name":{"type":"string"}},"uniqueKey":"items.[INDEX].documentSplitter.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].documentSplitter","typeLabel":"object | null"}},"uniqueKey":"items.[INDEX]","typeLabel":"object"},"uniqueKey":"","typeLabel":"object[]"},"examples":{"Example":{"title":"Example","value":[{"identifier":"mEFayXdO","organization":{"identifier":"mEFayXdO","name":"Grove Street King","userRole":"admin","avatar":"https://affinda-api.s3.amazonaws.com/media/org-avatar.png?AWSAccessKeyId=KEY\u0026Signature=SIG","resthookSignatureKey":"465c6598bd34c0558f0ce256c43209d49fa85b0ff3e4c18b24e408b7563143ad","isTrial":true,"validationToolConfig":{"theme":{"palette":{"mode":"light","background":"\u003cstring>","text":{"primary":"\u003cstring>","secondary":"\u003cstring>","disabled":"\u003cstring>"},"divider":"\u003cstring>","primary":{"main":"\u003cstring>","light":"\u003cstring>","dark":"\u003cstring>","contrastText":"\u003cstring>"},"secondary":{"main":"\u003cstring>","light":"\u003cstring>","dark":"\u003cstring>","contrastText":"\u003cstring>"},"success":{"main":"\u003cstring>","light":"\u003cstring>","dark":"\u003cstring>","contrastText":"\u003cstring>"},"annotation":{"main":"\u003cstring>","light":"\u003cstring>","dark":"\u003cstring>","contrastText":"\u003cstring>"},"error":{"main":"\u003cstring>","light":"\u003cstring>","dark":"\u003cstring>","contrastText":"\u003cstring>"},"info":{"main":"\u003cstring>","light":"\u003cstring>","dark":"\u003cstring>","contrastText":"\u003cstring>"},"warning":{"main":"\u003cstring>","light":"\u003cstring>","dark":"\u003cstring>","contrastText":"\u003cstring>"}},"typography":{"fontFamily":"\u003cstring>","fontSize":"\u003cstring>","fontWeightRegular":"\u003cstring>","fontWeightMedium":"\u003cstring>","fontWeightBold":"\u003cstring>"},"borderRadius":123,"fontUrl":"\u003cstring>"},"hideActions":true,"hideCollection":true,"hideEditPages":true,"hideExport":true,"hideFilename":true,"hideShowRawValues":true,"hideReject":true,"hideReparse":true,"hideRunOcr":true,"hideTags":true,"hideWarnings":true,"restrictDocumentSplitting":true,"disableCurrencyFormatting":true,"disableEditDocumentMetadata":true,"disableManualAnnotationEditing":true,"hideDocumentStatus":true},"showCustomFieldCreation":true,"allowDataSourceRecordCreation":true},"name":"\u003cstring>","visibility":"organization","collections":[{"identifier":"mEFayXdO","name":"\u003cstring>","extractor":{"identifier":"resume","name":"\u003cstring>","namePlural":"\u003cstring>","validatable":true,"baseExtractor":{"identifier":"resume","name":"\u003cstring>","namePlural":"\u003cstring>","validatable":true,"isCustom":true,"createdDt":"2023-11-07T05:31:56Z"},"category":"Recruitment","createdDt":"2023-11-07T05:31:56Z"},"unvalidatedDocsCount":1,"confirmedDocsCount":1}],"documentTypes":["mEFayXdO"],"rejectInvalidDocuments":true,"rejectDuplicates":true,"members":[{"id":1,"name":"Carl Johnson","username":"carljohnson","email":"carljohnson@grove.street","avatar":"https://affinda-api.s3.amazonaws.com/media/user-avatar.png?AWSAccessKeyId=KEY\u0026Signature=SIG"}],"unvalidatedDocsCount":1,"confirmedDocsCount":1,"ingestEmail":"\u003cstring>","whitelistIngestAddresses":["*@eyefind.info"],"documentSplitter":{"identifier":"NqIvMvZl","name":"\u003cstring>"}}]}},"exampleType":"generated"}},"exampleType":"generated"},"f0027a4e-53c7-4fb1-a2b0-3decf21a6e80":{"description":"Bad request. If it is a validation error will contain a list of each invalid field","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["type","errors"],"properties":{"type":{"type":"string","example":"validation_error","isRequired":true,"uniqueKey":"type","typeLabel":"string"},"errors":{"type":"array","items":{"type":"object","required":["attr","code","detail"],"properties":{"attr":{"oneOf":[{"type":"string","example":"non_field_errors","isRequired":true,"uniqueKey":"errors.items.[INDEX].attr.oneOf.0","typeLabel":"string"},{"type":"null","example":"non_field_errors","isRequired":true,"uniqueKey":"errors.items.[INDEX].attr.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"errors.items.[INDEX].attr","typeLabel":"string | null"},"code":{"type":"string","example":"unique","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"detail":{"type":"string","example":"This index name has already been used","isRequired":true,"uniqueKey":"errors.items.[INDEX].detail","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"errors","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"type":"validation_error","errors":[{"attr":"non_field_errors","code":"unique","detail":"This index name has already been used"}]}}},"exampleType":"generated"}},"x-ms-error-response":true,"exampleType":"generated"},"669e712a-fc4c-408b-8c58-c7abc400f73b":{"description":"Authorisation error","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["type","errors"],"properties":{"type":{"type":"string","example":"validation_error","isRequired":true,"uniqueKey":"type","typeLabel":"string"},"errors":{"type":"array","items":{"type":"object","required":["attr","code","detail"],"properties":{"attr":{"oneOf":[{"type":"string","example":"non_field_errors","isRequired":true,"uniqueKey":"errors.items.[INDEX].attr.oneOf.0","typeLabel":"string"},{"type":"null","example":"non_field_errors","isRequired":true,"uniqueKey":"errors.items.[INDEX].attr.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"errors.items.[INDEX].attr","typeLabel":"string | null"},"code":{"type":"string","example":"unique","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"detail":{"type":"string","example":"This index name has already been used","isRequired":true,"uniqueKey":"errors.items.[INDEX].detail","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"errors","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"type":"validation_error","errors":[{"attr":"non_field_errors","code":"unique","detail":"This index name has already been used"}]}}},"exampleType":"generated"}},"x-ms-error-response":true,"exampleType":"generated"},"6a4d8079-81e2-49ca-aeee-7ddf3148726e":{"description":"UnexpectedError","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["type","errors"],"properties":{"type":{"type":"string","example":"validation_error","isRequired":true,"uniqueKey":"type","typeLabel":"string"},"errors":{"type":"array","items":{"type":"object","required":["attr","code","detail"],"properties":{"attr":{"oneOf":[{"type":"string","example":"non_field_errors","isRequired":true,"uniqueKey":"errors.items.[INDEX].attr.oneOf.0","typeLabel":"string"},{"type":"null","example":"non_field_errors","isRequired":true,"uniqueKey":"errors.items.[INDEX].attr.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"errors.items.[INDEX].attr","typeLabel":"string | null"},"code":{"type":"string","example":"unique","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"detail":{"type":"string","example":"This index name has already been used","isRequired":true,"uniqueKey":"errors.items.[INDEX].detail","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"errors","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"type":"validation_error","errors":[{"attr":"non_field_errors","code":"unique","detail":"This index name has already been used"}]}}},"exampleType":"generated"}},"x-ms-error-response":true,"exampleType":"generated"}},"security":{"d9dd6b44-a7ae-459f-b82c-e1a00027d890":{"ApiKeyAuth":{"type":"http","scheme":"bearer","description":"Basic authentication using an API key, e.g. `{Authorization: Bearer aff_0bb4fbdf97b7e4111ff6c0015471094155f91}`.\nYou can find your API key within the Settings page of the [Affinda web app](https://app.affinda.com/). You can obtain an API key by [signing up for a free trial](https://app.affinda.com/auth/register).","scopes":[]}}},"servers":{"bb6d2c32-dd7a-49e6-890d-c07838ca7ce4":{"url":"https://{region}.affinda.com","description":"Select the correct server for your instance: api (AUS/Global), api.us1 (US), or api.eu1 (EU).","variables":{"region":{"default":"api","description":"The instance region. Use 'api' for AUS/Global, 'api.us1' for US, or 'api.eu1' for EU. You can find your region in the Affinda web app URL.","enum":["api","api.eu1","api.us1"],"x-ms-parameter-location":"client"}}}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Basic authentication using an API key, e.g. `{Authorization: Bearer aff_0bb4fbdf97b7e4111ff6c0015471094155f91}`.\nYou can find your API key within the Settings page of the [Affinda web app](https://app.affinda.com/). You can obtain an API key by [signing up for a free trial](https://app.affinda.com/auth/register).","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Basic authentication using an API key, e.g. `{Authorization: Bearer aff_0bb4fbdf97b7e4111ff6c0015471094155f91}`.\nYou can find your API key within the Settings page of the [Affinda web app](https://app.affinda.com/). You can obtain an API key by [signing up for a free trial](https://app.affinda.com/auth/register).","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"ApiKeyAuth","name":"Authorization"}],"title":"ApiKeyAuth"}]},"originalFileLocation":"https://api.affinda.com/static/v3/api_spec.yaml"},"subdomain":"affinda-44","siteName":"Affinda Extract Documentation","title":"Get list of all workspaces - Affinda Extract Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-08-04T11:18:53.141Z","originalFileLocation":"api-reference/workspaces/get-list-of-all-workspaces.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Returns your workspaces.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Affinda Extract Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/affinda-44/tl-77mmsQTlzqSAp/_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/affinda-44/tl-77mmsQTlzqSAp/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/affinda-44/tl-77mmsQTlzqSAp/_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/affinda-44/tl-77mmsQTlzqSAp/_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/affinda-44/tl-77mmsQTlzqSAp/_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/affinda-44/tl-77mmsQTlzqSAp/_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/affinda-44/tl-77mmsQTlzqSAp/_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/affinda-44/tl-77mmsQTlzqSAp/_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/affinda-44/tl-77mmsQTlzqSAp/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get list of all workspaces - Affinda Extract Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Returns your workspaces.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Affinda\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.affinda.com/api-reference/workspaces/get-list-of-all-workspaces\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://cdn.prod.website-files.com/6854ccfd1a7ab92f392b474d/68ae96fe8f3fdbbe0ae04c73_Affinda%20Open%20Graph%20image%20for%20website%20previews.png\">\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 list of all workspaces - Affinda Extract Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Returns your workspaces.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://cdn.prod.website-files.com/6854ccfd1a7ab92f392b474d/68ae96fe8f3fdbbe0ae04c73_Affinda%20Open%20Graph%20image%20for%20website%20previews.png\">\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/affinda-44/tl-77mmsQTlzqSAp/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Affinda Extract Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#1F3339\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.affinda.com/api-reference/workspaces/get-list-of-all-workspaces\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/workspaces/get-list-of-all-workspaces.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.affinda.com/#organization\",\"name\":\"Affinda Extract Documentation\",\"url\":\"https://docs.affinda.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/affinda-44/nvZZjc-QOoHXzSQ7/images/affindaextract-inkwell.png?fit=max\u0026auto=format\u0026n=nvZZjc-QOoHXzSQ7\u0026q=85\u0026s=a3e52ff1e274ac5509589a6350b41496\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.affinda.com#website\",\"name\":\"Affinda Extract Documentation\",\"url\":\"https://docs.affinda.com\",\"publisher\":{\"@id\":\"https://docs.affinda.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.affinda.com/api-reference/workspaces/get-list-of-all-workspaces#webpage\",\"url\":\"https://docs.affinda.com/api-reference/workspaces/get-list-of-all-workspaces\",\"name\":\"Get list of all workspaces\",\"description\":\"Returns your workspaces.\",\"dateModified\":\"2026-08-04T11:18:53.141Z\",\"isPartOf\":{\"@id\":\"https://docs.affinda.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.affinda.com/api-reference/workspaces/get-list-of-all-workspaces#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.affinda.com/api-reference/workspaces/get-list-of-all-workspaces#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Endpoints\",\"item\":\"https://docs.affinda.com/api-reference/documents/get-list-of-all-documents\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get list of all workspaces\",\"item\":\"https://docs.affinda.com/api-reference/workspaces/get-list-of-all-workspaces\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.affinda.com/api-reference/workspaces/get-list-of-all-workspaces#apireference\",\"headline\":\"Get list of all workspaces\",\"name\":\"Get list of all workspaces\",\"description\":\"Returns your workspaces.\",\"url\":\"https://docs.affinda.com/api-reference/workspaces/get-list-of-all-workspaces\",\"mainEntityOfPage\":{\"@id\":\"https://docs.affinda.com/api-reference/workspaces/get-list-of-all-workspaces#webpage\"},\"image\":\"https://cdn.prod.website-files.com/6854ccfd1a7ab92f392b474d/68ae96fe8f3fdbbe0ae04c73_Affinda%20Open%20Graph%20image%20for%20website%20previews.png\",\"dateModified\":\"2026-08-04T11:18:53.141Z\",\"publisher\":{\"@id\":\"https://docs.affinda.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.affinda.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Affinda Extract Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Affinda Extract Documentation","nav":{"global":null,"tabs":[{"tab":"Extract Handbook","pages":[{"title":"Extract Handbook","href":"/home"}]},{"tab":"Configuration Guide","pages":[{"title":"Configuration Guide","href":"/configuration/workflow"}]},{"tab":"API Reference","groups":[{"group":"Developer Guide","pages":[{"title":"API quick start guide","href":"/reference/getting-started"},{"title":"API authentication with rotatable keys","href":"/reference/authentication"},{"group":"Uploading Documents","pages":[{"title":"Document upload options for the API","href":"/reference/upload-options"},{"title":"Field and document metadata in API responses","href":"/reference/metadata"},{"title":"API volume, file size, and rate limits","href":"/reference/limits"}]},{"title":"Webhooks for document and parsing events","href":"/reference/webhooks"},{"title":"Embed the Affinda validation interface","href":"/reference/embedded"}]},{"group":"Developer Tools","pages":[{"title":"Official client libraries for the Affinda API","href":"/reference/client-libraries"},{"title":"Structured outputs with Pydantic models","href":"/reference/pydantic-models"},{"title":"Generate TypeScript interfaces","href":"/reference/typescript-interfaces"}]},{"group":"Endpoints","pages":[{"group":"Documents","pages":[{"title":"Get list of all documents","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml get /v3/documents","href":"/api-reference/documents/get-list-of-all-documents"},{"title":"Upload a document for parsing","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml post /v3/documents","href":"/api-reference/documents/upload-a-document-for-parsing"},{"title":"Get specific document","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml get /v3/documents/{identifier}","href":"/api-reference/documents/get-specific-document"},{"title":"Delete a document","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml delete /v3/documents/{identifier}","href":"/api-reference/documents/delete-a-document"},{"title":"Update a document","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml patch /v3/documents/{identifier}","href":"/api-reference/documents/update-a-document"},{"title":"Get redacted document","description":"Get the redacted version of a document. The original document is not modified.","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml get /v3/documents/{identifier}/redacted","href":"/api-reference/documents/get-redacted-document"}]},{"group":"Workspaces","pages":[{"title":"Get list of all workspaces","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml get /v3/workspaces","href":"/api-reference/workspaces/get-list-of-all-workspaces"},{"title":"Create a workspace","description":"Create a workspace","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml post /v3/workspaces","href":"/api-reference/workspaces/create-a-workspace"},{"title":"Get specific workspace","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml get /v3/workspaces/{identifier}","href":"/api-reference/workspaces/get-specific-workspace"},{"title":"Delete a workspace","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml delete /v3/workspaces/{identifier}","href":"/api-reference/workspaces/delete-a-workspace"},{"title":"Update a workspace","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml patch /v3/workspaces/{identifier}","href":"/api-reference/workspaces/update-a-workspace"}]},{"group":"Document Types","pages":[{"title":"List document types","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml get /v3/document_types","href":"/api-reference/document-types/list-document-types"},{"title":"Create a document type","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml post /v3/document_types","href":"/api-reference/document-types/create-a-document-type"},{"title":"Get a document type","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml get /v3/document_types/{identifier}","href":"/api-reference/document-types/get-a-document-type"},{"title":"Delete a document type","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml delete /v3/document_types/{identifier}","href":"/api-reference/document-types/delete-a-document-type"},{"title":"Update a document type","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml patch /v3/document_types/{identifier}","href":"/api-reference/document-types/update-a-document-type"},{"title":"Generate JSON schema from a document type","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml get /v3/document_types/{identifier}/json_schema","href":"/api-reference/document-types/generate-json-schema-from-a-document-type"},{"title":"Generate Pydantic models from a document type","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml get /v3/document_types/{identifier}/pydantic_models","href":"/api-reference/document-types/generate-pydantic-models-from-a-document-type"}]},{"group":"Data Sources","pages":[{"title":"List data sources","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml get /v3/mapping_data_sources","href":"/api-reference/data-sources/list-data-sources"},{"title":"Create a data source","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml post /v3/mapping_data_sources","href":"/api-reference/data-sources/create-a-data-source"},{"title":"Get specific data source","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml get /v3/mapping_data_sources/{identifier}","href":"/api-reference/data-sources/get-specific-data-source"},{"title":"Delete specific data source","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml delete /v3/mapping_data_sources/{identifier}","href":"/api-reference/data-sources/delete-specific-data-source"},{"title":"List values for a data source","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml get /v3/mapping_data_sources/{identifier}/values","href":"/api-reference/data-sources/list-values-for-a-data-source"},{"title":"Replace values for a data source","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml put /v3/mapping_data_sources/{identifier}/values","href":"/api-reference/data-sources/replace-values-for-a-data-source"},{"title":"Add value for a data source","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml post /v3/mapping_data_sources/{identifier}/values","href":"/api-reference/data-sources/add-value-for-a-data-source"},{"title":"Get specific data source value","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml get /v3/mapping_data_sources/{identifier}/values/{value}","href":"/api-reference/data-sources/get-specific-data-source-value"},{"title":"Update specific data source value","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml put /v3/mapping_data_sources/{identifier}/values/{value}","href":"/api-reference/data-sources/update-specific-data-source-value"},{"title":"Delete specific data source value","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml delete /v3/mapping_data_sources/{identifier}/values/{value}","href":"/api-reference/data-sources/delete-specific-data-source-value"}]},{"group":"Validation Results","pages":[{"title":"Get list of all validation results","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml get /v3/validation_results","href":"/api-reference/validation-results/get-list-of-all-validation-results"},{"title":"Create a validation result","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml post /v3/validation_results","href":"/api-reference/validation-results/create-a-validation-result"},{"title":"Get specific validation result","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml get /v3/validation_results/{id}","href":"/api-reference/validation-results/get-specific-validation-result"},{"title":"Delete a validation result","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml delete /v3/validation_results/{id}","href":"/api-reference/validation-results/delete-a-validation-result"},{"title":"Update a validation result","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml patch /v3/validation_results/{id}","href":"/api-reference/validation-results/update-a-validation-result"},{"title":"Batch create validation results","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml post /v3/validation_results/batch_create","href":"/api-reference/validation-results/batch-create-validation-results"},{"title":"Batch delete validation results","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml post /v3/validation_results/batch_delete","href":"/api-reference/validation-results/batch-delete-validation-results"}]},{"group":"Organizations","pages":[{"title":"Get list of all organizations","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml get /v3/organizations","href":"/api-reference/organizations/get-list-of-all-organizations"},{"title":"Get detail of an organization","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml get /v3/organizations/{identifier}","href":"/api-reference/organizations/get-detail-of-an-organization"}]},{"group":"Add x-hidden to endpoints","pages":[]},{"group":"Usage","pages":[{"title":"Get usage","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml get /v3/usage","href":"/api-reference/usage/get-usage"}]},{"group":"Tags","pages":[{"title":"Get list of all tags","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml get /v3/tags","href":"/api-reference/tags/get-list-of-all-tags"},{"title":"Create a tag","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml post /v3/tags","href":"/api-reference/tags/create-a-tag"},{"title":"Get specific tag","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml get /v3/tags/{id}","href":"/api-reference/tags/get-specific-tag"},{"title":"Delete an tag","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml delete /v3/tags/{id}","href":"/api-reference/tags/delete-an-tag"},{"title":"Update a tag","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml patch /v3/tags/{id}","href":"/api-reference/tags/update-a-tag"},{"title":"Add a tag to documents","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml post /v3/documents/batch_add_tag","href":"/api-reference/tags/add-a-tag-to-documents"},{"title":"Remove a tag from documents","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml post /v3/documents/batch_remove_tag","href":"/api-reference/tags/remove-a-tag-from-documents"}]},{"group":"Annotations","pages":[{"title":"Get list of all annotations","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml get /v3/annotations","href":"/api-reference/annotations/get-list-of-all-annotations"},{"title":"Create a annotation","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml post /v3/annotations","href":"/api-reference/annotations/create-a-annotation"},{"title":"Get specific annotation","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml get /v3/annotations/{id}","href":"/api-reference/annotations/get-specific-annotation"},{"title":"Delete an annotation","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml delete /v3/annotations/{id}","href":"/api-reference/annotations/delete-an-annotation"},{"title":"Update an annotation","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml patch /v3/annotations/{id}","href":"/api-reference/annotations/update-an-annotation"},{"title":"Batch create annotations","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml post /v3/annotations/batch_create","href":"/api-reference/annotations/batch-create-annotations"},{"title":"Batch update annotations","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml post /v3/annotations/batch_update","href":"/api-reference/annotations/batch-update-annotations"},{"title":"Batch delete annotations","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml post /v3/annotations/batch_delete","href":"/api-reference/annotations/batch-delete-annotations"}]},{"group":"Webhooks","pages":[{"title":"Get list of all resthook subscriptions","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml get /v3/resthook_subscriptions","href":"/api-reference/webhooks/get-list-of-all-resthook-subscriptions"},{"title":"Create a resthook subscription","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml post /v3/resthook_subscriptions","href":"/api-reference/webhooks/create-a-resthook-subscription"},{"title":"Get specific resthook subscription","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml get /v3/resthook_subscriptions/{id}","href":"/api-reference/webhooks/get-specific-resthook-subscription"},{"title":"Delete a resthook subscription","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml delete /v3/resthook_subscriptions/{id}","href":"/api-reference/webhooks/delete-a-resthook-subscription"},{"title":"Update a resthook subscription","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml patch /v3/resthook_subscriptions/{id}","href":"/api-reference/webhooks/update-a-resthook-subscription"},{"title":"Activate a resthook subscription","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml post /v3/resthook_subscriptions/activate","href":"/api-reference/webhooks/activate-a-resthook-subscription"}]},{"group":"Search \u0026 Match","pages":[{"title":"Create a document from raw data","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml post /v3/documents/create_from_data","href":"/api-reference/search-\u0026-match/create-a-document-from-raw-data"},{"title":"Update a document's data","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml post /v3/documents/{identifier}/update_data","href":"/api-reference/search-\u0026-match/update-a-documents-data"},{"title":"List occupation groups","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml get /v3/occupation_groups","href":"/api-reference/search-\u0026-match/list-occupation-groups"},{"title":"Search through parsed resumes","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml post /v3/resume_search","href":"/api-reference/search-\u0026-match/search-through-parsed-resumes"},{"title":"Get search result of specific resume","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml post /v3/resume_search/details/{identifier}","href":"/api-reference/search-\u0026-match/get-search-result-of-specific-resume"},{"title":"Get the config for the logged in user's embeddable resume search tool","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml get /v3/resume_search/config","href":"/api-reference/search-\u0026-match/get-the-config-for-the-logged-in-users-embeddable-resume-search-tool"},{"title":"Update the config for the logged in user's embeddable resume search tool","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml patch /v3/resume_search/config","href":"/api-reference/search-\u0026-match/update-the-config-for-the-logged-in-users-embeddable-resume-search-tool"},{"title":"Create a signed URL for the embeddable resume search tool","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml post /v3/resume_search/embed","href":"/api-reference/search-\u0026-match/create-a-signed-url-for-the-embeddable-resume-search-tool"},{"title":"Match a single resume and job description","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml get /v3/resume_search/match","href":"/api-reference/search-\u0026-match/match-a-single-resume-and-job-description"},{"title":"Get job title suggestions based on provided job title(s)","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml get /v3/resume_search/suggestion_job_title","href":"/api-reference/search-\u0026-match/get-job-title-suggestions-based-on-provided-job-titles"},{"title":"Get skill suggestions based on provided skill(s)","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml get /v3/resume_search/suggestion_skill","href":"/api-reference/search-\u0026-match/get-skill-suggestions-based-on-provided-skills"},{"title":"Search through parsed job descriptions","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml post /v3/job_description_search","href":"/api-reference/search-\u0026-match/search-through-parsed-job-descriptions"},{"title":"Get search result of specific job description","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml post /v3/job_description_search/details/{identifier}","href":"/api-reference/search-\u0026-match/get-search-result-of-specific-job-description"},{"title":"Get the config for the logged in user's embeddable job description search tool","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml get /v3/job_description_search/config","href":"/api-reference/search-\u0026-match/get-the-config-for-the-logged-in-users-embeddable-job-description-search-tool"},{"title":"Update the config for the logged in user's embeddable job description search tool","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml patch /v3/job_description_search/config","href":"/api-reference/search-\u0026-match/update-the-config-for-the-logged-in-users-embeddable-job-description-search-tool"},{"title":"Create a signed URL for the embeddable job description search tool","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml post /v3/job_description_search/embed","href":"/api-reference/search-\u0026-match/create-a-signed-url-for-the-embeddable-job-description-search-tool"},{"title":"Get list of all indexes","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml get /v3/index","href":"/api-reference/search-\u0026-match/get-list-of-all-indexes"},{"title":"Create a new index","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml post /v3/index","href":"/api-reference/search-\u0026-match/create-a-new-index"},{"title":"Delete an index","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml delete /v3/index/{name}","href":"/api-reference/search-\u0026-match/delete-an-index"},{"title":"Update an index","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml patch /v3/index/{name}","href":"/api-reference/search-\u0026-match/update-an-index"},{"title":"Get indexed documents for a specific index","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml get /v3/index/{name}/documents","href":"/api-reference/search-\u0026-match/get-indexed-documents-for-a-specific-index"},{"title":"Index a new document","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml post /v3/index/{name}/documents","href":"/api-reference/search-\u0026-match/index-a-new-document"},{"title":"Delete an indexed document","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml delete /v3/index/{name}/documents/{identifier}","href":"/api-reference/search-\u0026-match/delete-an-indexed-document"},{"title":"Re-index a document","deprecated":null,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml post /v3/index/{name}/documents/{identifier}/re_index","href":"/api-reference/search-\u0026-match/re-index-a-document"}]},{"group":"Deprecated End Points","pages":[{"title":"Get list of all collections","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml get /v3/collections","href":"/api-reference/deprecated-end-points/get-list-of-all-collections"},{"title":"Create a collection","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml post /v3/collections","href":"/api-reference/deprecated-end-points/create-a-collection"},{"title":"Get specific collection","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml get /v3/collections/{identifier}","href":"/api-reference/deprecated-end-points/get-specific-collection"},{"title":"Delete a collection","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml delete /v3/collections/{identifier}","href":"/api-reference/deprecated-end-points/delete-a-collection"},{"title":"Update a collection","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml patch /v3/collections/{identifier}","href":"/api-reference/deprecated-end-points/update-a-collection"},{"title":"Create data field for a collection along with a new data point.","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml post /v3/collections/{identifier}/create_data_field","href":"/api-reference/deprecated-end-points/create-data-field-for-a-collection-along-with-a-new-data-point"},{"title":"Get data field for a collection assosciated with a data point.","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml get /v3/collections/{identifier}/fields/{datapoint_identifier}","href":"/api-reference/deprecated-end-points/get-data-field-for-a-collection-assosciated-with-a-data-point"},{"title":"Update data field for a collection assosciated with a data point.","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml patch /v3/collections/{identifier}/fields/{datapoint_identifier}","href":"/api-reference/deprecated-end-points/update-data-field-for-a-collection-assosciated-with-a-data-point"},{"title":"Get usage by collection","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml get /v3/collections/{identifier}/usage","href":"/api-reference/deprecated-end-points/get-usage-by-collection"},{"title":"Get list of all data points","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml get /v3/data_points","href":"/api-reference/deprecated-end-points/get-list-of-all-data-points"},{"title":"Create a data point","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml post /v3/data_points","href":"/api-reference/deprecated-end-points/create-a-data-point"},{"title":"Get specific data point","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml get /v3/data_points/{identifier}","href":"/api-reference/deprecated-end-points/get-specific-data-point"},{"title":"Delete a data point","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml delete /v3/data_points/{identifier}","href":"/api-reference/deprecated-end-points/delete-a-data-point"},{"title":"Update a data point","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml patch /v3/data_points/{identifier}","href":"/api-reference/deprecated-end-points/update-a-data-point"},{"title":"Get list of data point choices","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml get /v3/data_point_choices","href":"/api-reference/deprecated-end-points/get-list-of-data-point-choices"},{"title":"Create a data point choice","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml post /v3/data_point_choices","href":"/api-reference/deprecated-end-points/create-a-data-point-choice"},{"title":"Get specific data point choice","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml get /v3/data_point_choices/{id}","href":"/api-reference/deprecated-end-points/get-specific-data-point-choice"},{"title":"Delete a data point choice","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml delete /v3/data_point_choices/{id}","href":"/api-reference/deprecated-end-points/delete-a-data-point-choice"},{"title":"Update a data point choice","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml patch /v3/data_point_choices/{id}","href":"/api-reference/deprecated-end-points/update-a-data-point-choice"},{"title":"Replace choices of a data point","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml post /v3/data_point_choices/replace","href":"/api-reference/deprecated-end-points/replace-choices-of-a-data-point"},{"title":"List mappings","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml get /v3/mappings","href":"/api-reference/deprecated-end-points/list-mappings"},{"title":"Create a mapping","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml post /v3/mappings","href":"/api-reference/deprecated-end-points/create-a-mapping"},{"title":"Get specific mapping","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml get /v3/mappings/{identifier}","href":"/api-reference/deprecated-end-points/get-specific-mapping"},{"title":"Delete specific mapping","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml delete /v3/mappings/{identifier}","href":"/api-reference/deprecated-end-points/delete-specific-mapping"},{"title":"Update specific mapping","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v3/api_spec.yaml patch /v3/mappings/{identifier}","href":"/api-reference/deprecated-end-points/update-specific-mapping"}]},{"group":"Document API - Splitting","pages":[]},{"group":"Document API - Extractor","pages":[]},{"group":"Organization API - Invitation","pages":[]}]},{"group":"Deprecated Versions","pages":[{"group":"v2 Endpoints (Legacy)","tag":"DEPRECATED","pages":[{"group":"Resume Parser","pages":[{"title":"Get list of all resumes","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v2/api_spec.yaml get /v2/resumes","href":"/api-reference/resume-parser/get-list-of-all-resumes"},{"title":"Upload a resume for parsing","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v2/api_spec.yaml post /v2/resumes","href":"/api-reference/resume-parser/upload-a-resume-for-parsing"},{"title":"Get parse results for a specific resume","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v2/api_spec.yaml get /v2/resumes/{identifier}","href":"/api-reference/resume-parser/get-parse-results-for-a-specific-resume"},{"title":"Delete a resume","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v2/api_spec.yaml delete /v2/resumes/{identifier}","href":"/api-reference/resume-parser/delete-a-resume"},{"title":"Update a resume's data","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v2/api_spec.yaml patch /v2/resumes/{identifier}","href":"/api-reference/resume-parser/update-a-resumes-data"}]},{"group":"Resume Redactor","pages":[{"title":"Get list of all redacted resumes","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v2/api_spec.yaml get /v2/redacted_resumes","href":"/api-reference/resume-redactor/get-list-of-all-redacted-resumes"},{"title":"Upload a resume for redacting","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v2/api_spec.yaml post /v2/redacted_resumes","href":"/api-reference/resume-redactor/upload-a-resume-for-redacting"},{"title":"Get redaction results for a specific resume","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v2/api_spec.yaml get /v2/redacted_resumes/{identifier}","href":"/api-reference/resume-redactor/get-redaction-results-for-a-specific-resume"},{"title":"Delete a redacted resume","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v2/api_spec.yaml delete /v2/redacted_resumes/{identifier}","href":"/api-reference/resume-redactor/delete-a-redacted-resume"}]},{"group":"Invoice Extractor","pages":[{"title":"Get list of all invoices","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v2/api_spec.yaml get /v2/invoices","href":"/api-reference/invoice-extractor/get-list-of-all-invoices"},{"title":"Upload an invoice for parsing","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v2/api_spec.yaml post /v2/invoices","href":"/api-reference/invoice-extractor/upload-an-invoice-for-parsing"},{"title":"Get parse results for a specific invoice","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v2/api_spec.yaml get /v2/invoices/{identifier}","href":"/api-reference/invoice-extractor/get-parse-results-for-a-specific-invoice"},{"title":"Delete an invoice","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v2/api_spec.yaml delete /v2/invoices/{identifier}","href":"/api-reference/invoice-extractor/delete-an-invoice"}]},{"group":"Job Description Parser","pages":[{"title":"Get list of all job descriptions","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v2/api_spec.yaml get /v2/job_descriptions","href":"/api-reference/job-description-parser/get-list-of-all-job-descriptions"},{"title":"Upload a job description for parsing","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v2/api_spec.yaml post /v2/job_descriptions","href":"/api-reference/job-description-parser/upload-a-job-description-for-parsing"},{"title":"Get job description results for a specific job description file","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v2/api_spec.yaml get /v2/job_descriptions/{identifier}","href":"/api-reference/job-description-parser/get-job-description-results-for-a-specific-job-description-file"},{"title":"Delete a job description","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v2/api_spec.yaml delete /v2/job_descriptions/{identifier}","href":"/api-reference/job-description-parser/delete-a-job-description"},{"title":"Update a job description's data","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v2/api_spec.yaml patch /v2/job_descriptions/{identifier}","href":"/api-reference/job-description-parser/update-a-job-descriptions-data"}]},{"group":"Search \u0026 Match - Searching","pages":[{"title":"Search through parsed job descriptions","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v2/api_spec.yaml post /v2/job_description_search","href":"/api-reference/search-\u0026-match--searching/search-through-parsed-job-descriptions"},{"title":"Get search result of specific job description","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v2/api_spec.yaml post /v2/job_description_search/details/{identifier}","href":"/api-reference/search-\u0026-match--searching/get-search-result-of-specific-job-description"},{"title":"Search through parsed resumes","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v2/api_spec.yaml post /v2/resume_search","href":"/api-reference/search-\u0026-match--searching/search-through-parsed-resumes"},{"title":"Get search result of specific resume","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v2/api_spec.yaml post /v2/resume_search/details/{identifier}","href":"/api-reference/search-\u0026-match--searching/get-search-result-of-specific-resume"},{"title":"Match a single resume and job description","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v2/api_spec.yaml get /v2/resume_search/match","href":"/api-reference/search-\u0026-match--searching/match-a-single-resume-and-job-description"},{"title":"Get job title suggestions based on provided job title(s)","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v2/api_spec.yaml get /v2/resume_search/suggestion_job_title","href":"/api-reference/search-\u0026-match--searching/get-job-title-suggestions-based-on-provided-job-titles"},{"title":"Get skill suggestions based on provided skill(s)","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v2/api_spec.yaml get /v2/resume_search/suggestion_skill","href":"/api-reference/search-\u0026-match--searching/get-skill-suggestions-based-on-provided-skills"},{"title":"List occupation groups","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v2/api_spec.yaml get /v2/occupation_groups","href":"/api-reference/search-\u0026-match--searching/list-occupation-groups"}]},{"group":"Search \u0026 Match - Embedding","pages":[{"title":"Get the config for the logged in user's embeddable job description search tool","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v2/api_spec.yaml get /v2/job_description_search/config","href":"/api-reference/search-\u0026-match--embedding/get-the-config-for-the-logged-in-users-embeddable-job-description-search-tool"},{"title":"Update the config for the logged in user's embeddable job description search tool","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v2/api_spec.yaml patch /v2/job_description_search/config","href":"/api-reference/search-\u0026-match--embedding/update-the-config-for-the-logged-in-users-embeddable-job-description-search-tool"},{"title":"Create a signed URL for the embeddable job description search tool","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v2/api_spec.yaml post /v2/job_description_search/embed","href":"/api-reference/search-\u0026-match--embedding/create-a-signed-url-for-the-embeddable-job-description-search-tool"},{"title":"Get the config for the logged in user's embeddable resume search tool","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v2/api_spec.yaml get /v2/resume_search/config","href":"/api-reference/search-\u0026-match--embedding/get-the-config-for-the-logged-in-users-embeddable-resume-search-tool"},{"title":"Update the config for the logged in user's embeddable resume search tool","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v2/api_spec.yaml patch /v2/resume_search/config","href":"/api-reference/search-\u0026-match--embedding/update-the-config-for-the-logged-in-users-embeddable-resume-search-tool"},{"title":"Create a signed URL for the embeddable resume search tool","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v2/api_spec.yaml post /v2/resume_search/embed","href":"/api-reference/search-\u0026-match--embedding/create-a-signed-url-for-the-embeddable-resume-search-tool"}]},{"group":"Search \u0026 Match - Indexing","pages":[{"title":"Get list of all indexes","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v2/api_spec.yaml get /v2/index","href":"/api-reference/search-\u0026-match--indexing/get-list-of-all-indexes"},{"title":"Create a new index","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v2/api_spec.yaml post /v2/index","href":"/api-reference/search-\u0026-match--indexing/create-a-new-index"},{"title":"Delete an index","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v2/api_spec.yaml delete /v2/index/{name}","href":"/api-reference/search-\u0026-match--indexing/delete-an-index"},{"title":"Update an index","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v2/api_spec.yaml patch /v2/index/{name}","href":"/api-reference/search-\u0026-match--indexing/update-an-index"},{"title":"Get indexed documents for a specific index","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v2/api_spec.yaml get /v2/index/{name}/documents","href":"/api-reference/search-\u0026-match--indexing/get-indexed-documents-for-a-specific-index"},{"title":"Index a new document","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v2/api_spec.yaml post /v2/index/{name}/documents","href":"/api-reference/search-\u0026-match--indexing/index-a-new-document"},{"title":"Delete an indexed document","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v2/api_spec.yaml delete /v2/index/{name}/documents/{identifier}","href":"/api-reference/search-\u0026-match--indexing/delete-an-indexed-document"}]},{"group":"Webhook API","pages":[{"title":"Get list of all resthook subscriptions","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v2/api_spec.yaml get /v2/resthook_subscriptions","href":"/api-reference/webhook-api/get-list-of-all-resthook-subscriptions"},{"title":"Create a resthook subscription","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v2/api_spec.yaml post /v2/resthook_subscriptions","href":"/api-reference/webhook-api/create-a-resthook-subscription"},{"title":"Get specific resthook subscription","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v2/api_spec.yaml get /v2/resthook_subscriptions/{id}","href":"/api-reference/webhook-api/get-specific-resthook-subscription"},{"title":"Delete a resthook subscription","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v2/api_spec.yaml delete /v2/resthook_subscriptions/{id}","href":"/api-reference/webhook-api/delete-a-resthook-subscription"},{"title":"Update a resthook subscription","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v2/api_spec.yaml patch /v2/resthook_subscriptions/{id}","href":"/api-reference/webhook-api/update-a-resthook-subscription"},{"title":"Activate a resthook subscription","deprecated":true,"version":null,"openapi":"https://api.affinda.com/static/v2/api_spec.yaml post /v2/resthook_subscriptions/activate","href":"/api-reference/webhook-api/activate-a-resthook-subscription"}]}]}]}]},{"tab":"AI Integrations","pages":[{"title":"AI Integrations","href":"/integrations/mcp-connector"}]},{"tab":"Additional Resources","pages":[{"title":"Additional Resources","href":"/resources"}]}]},"title":"Get list of all workspaces - Affinda Extract Documentation","buildId":"dpl_2xiSHD9XEvLsPGPcfoMtkLTB3dy9","deploymentId":"dpl_2xiSHD9XEvLsPGPcfoMtkLTB3dy9","dynamics":["10e4515597","c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["BannerMarkdown-B-Glu166.js","dist-zbf22OZA.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","clsx-Cs6nMGht.js","html-void-elements-mCSPHezU.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","OpenApiReferenceProvider-DmVyH30O.js","utils-BHQqGGOd.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-CD-E4BIt.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Bp5Lq9Ds.js","snippetPresets-C4xAVCFP.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CgXVLxUC.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BF8I5oUf.js","shallow-Byd0lWnC.js","getApiPlaygroundDisplay-BGOZG1OK.js","CodeSnippet-CpvQL0CY.js","CodeSnippets-B8wkBKXa.js","Page-CBCH2P7b.js","getPastedJson-Ry3scI3Y.js","icon-D7a9HcdD.js","MethodPill-CJ8pmHhz.js","DuplicateIcon-rh1HJF0t.js","createIcon-DvGznqYs.js","DynamicMarkdown-Cc6AuSHS.js","SectionHeading-B4A0S-ep.js","axios-vUo_bRtp.js","Markdown-Cc16CX65.js","AssistantPageLink-C_fs-y5n.js"]}