Endpoints are grouped by persona. A token only reaches its own persona’s endpoints, and each endpoint page lists the scopes it requires. Call GET /identity to check which persona and scopes your token has.
Persona
Token
APIs
Agency
Agency API key, created by an agency owner on the API Keys tab of the agency settings
Agency roles, Talent Network
Recruiter
Personal API key, created on the API keys tab of your account settings
{"docsConfig":{"theme":"luma","$schema":"https://mintlify.com/docs.json","name":"Paraform","description":"Paraform MCP docs: connect Paraform to your AI assistant, then ask about your Paraform data.","colors":{"primary":"#2b7fff","light":"#51a2ff","dark":"#155dfc"},"logo":{"light":"https://mintcdn.com/paraform/HyizjsxPYnbS7fcG/logo/light.svg?fit=max\u0026auto=format\u0026n=HyizjsxPYnbS7fcG\u0026q=85\u0026s=0cb262b4538b596a01e90571f8a0ae9d","dark":"https://mintcdn.com/paraform/HyizjsxPYnbS7fcG/logo/dark.svg?fit=max\u0026auto=format\u0026n=HyizjsxPYnbS7fcG\u0026q=85\u0026s=8b1fe0de9fd53ab1c3da9a5c3a5c045b"},"favicon":"https://mintcdn.com/paraform/IPPrdZSu_oLwBy28/favicon.svg?fit=max\u0026auto=format\u0026n=IPPrdZSu_oLwBy28\u0026q=85\u0026s=12c81c1308d477e7336f3037c006dd20","navbar":{"links":[{"href":"/support","label":"Support"}],"primary":{"type":"button","label":"Get Started","href":"https://www.paraform.com/signup"}},"contextual":{"options":["copy","view","assistant","claude","chatgpt"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"paraform","hasAudioNarration":false,"actualSubdomain":"paraform","customDomains":["docs.paraform.com"],"gitSource":{"type":"github","owner":"paraform-xyz","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6af66879a01a2e955274aed6","clientVersion":"0.0.4143","searchFilterCounts":[{"language":"default","tag":"API","count":30},{"language":"default","tag":"Talent Network","count":13},{"language":"default","tag":"MCP","count":12},{"language":"default","tag":"Recruiter","count":11},{"language":"default","tag":"Get started","count":5},{"language":"default","tag":"Hiring manager MCP","count":4},{"language":"default","tag":"Recruiter MCP","count":4},{"language":"default","tag":"Agency","count":3},{"language":"default","tag":"Help","count":2}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"html:has(#api-beta-banner){--banner-height: 2.25rem !important}#api-beta-banner{position:relative;z-index:20;height:2.25rem;padding:0 1rem;overflow:hidden;background:rgb(254 249 195);color:rgb(113 63 18);font-size:0.875rem;font-weight:500;line-height:2.25rem;text-align:center;text-overflow:ellipsis;white-space:nowrap}.dark #api-beta-banner{background:rgb(66 50 10);color:rgb(253 224 71)}"}],"page":{"pagePath":"api/overview","slug":"/api/overview","pageMetadata":{"title":"Paraform API","sidebarTitle":"Overview","description":"Call Paraform from your own systems. Endpoints are grouped by the persona that can call them.","href":"/api/overview"},"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: \"Call Paraform from your own systems. Endpoints are grouped by the persona that can call them.\"\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,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,..._provideComponents(),...props.components},{CodeBlock,Table}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Table)_missingMdxReference(`Table`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`Send every request to `,_jsx(_components.code,{children:`https://external-api.paraform.com/api/external/v1`}),` with a bearer token:`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`2`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`2`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"https://external-api.paraform.com/api/external/v1/identity\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Authorization: Bearer pf_live_…\"`})]}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[`Endpoints are grouped by persona. A token only reaches its own persona’s endpoints, and each endpoint page lists the scopes it requires. Call `,_jsx(_components.code,{children:`GET /identity`}),` to check which persona and scopes your token has.`]}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Persona`}),_jsx(_components.th,{children:`Token`}),_jsx(_components.th,{children:`APIs`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Agency`}),_jsxs(_components.td,{children:[`Agency API key, created by an agency owner on the `,_jsx(_components.a,{href:`https://www.paraform.com/agency/api-keys`,children:_jsx(_components.strong,{children:`API Keys`})}),` tab of the agency settings`]}),_jsx(_components.td,{children:`Agency roles, Talent Network`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Recruiter`}),_jsxs(_components.td,{children:[`Personal API key, created on the `,_jsx(_components.a,{href:`https://www.paraform.com/manage/api-keys`,children:_jsx(_components.strong,{children:`API keys`})}),` tab of your account settings`]}),_jsx(_components.td,{children:`Roles, candidates, recommendations, Parascribe calls`})]})]})]}),`\n`,_jsxs(_components.p,{children:[`For access, email `,_jsx(_components.a,{href:`mailto:team@paraform.com`,children:`team@paraform.com`}),`.`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Paraform API","sidebarTitle":"Overview","description":"Call Paraform from your own systems. Endpoints are grouped by the persona that can call them.","href":"/api/overview"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/paraform/f4b24d4a139c440b/beta-banner.js"],"subdomain":"paraform","siteName":"Paraform","title":"Paraform API - Paraform","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-29T22:00:23.319Z","originalFileLocation":"api/overview.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=\"Call Paraform from your own systems. Endpoints are grouped by the persona that can call them.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Paraform\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/paraform/MBBn6gzfcEUwE0bv/_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/paraform/MBBn6gzfcEUwE0bv/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/paraform/MBBn6gzfcEUwE0bv/_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/paraform/MBBn6gzfcEUwE0bv/_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/paraform/MBBn6gzfcEUwE0bv/_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/paraform/MBBn6gzfcEUwE0bv/_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/paraform/MBBn6gzfcEUwE0bv/_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/paraform/MBBn6gzfcEUwE0bv/_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/paraform/MBBn6gzfcEUwE0bv/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Paraform API - Paraform\">\u003cmeta data-mint-head property=\"og:description\" content=\"Call Paraform from your own systems. Endpoints are grouped by the persona that can call them.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Paraform\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.paraform.com/api/overview\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://paraform.mintlify.site/_mintlify/api/og/v2?division=Get+started\u0026amp;title=Paraform+API\u0026amp;description=Call+Paraform+from+your+own+systems.+Endpoints+are+grouped+by+the+persona+that+can+call+them.\u0026amp;theme=61e64f04b32059e638657ae7\u0026amp;signature=7bdf51b553f033378244c3c986559cc95e63fb88f2d4ec2e27cec41e52a23aab\">\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=\"Paraform API - Paraform\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Call Paraform from your own systems. Endpoints are grouped by the persona that can call them.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://paraform.mintlify.site/_mintlify/api/og/v2?division=Get+started\u0026amp;title=Paraform+API\u0026amp;description=Call+Paraform+from+your+own+systems.+Endpoints+are+grouped+by+the+persona+that+can+call+them.\u0026amp;theme=61e64f04b32059e638657ae7\u0026amp;signature=7bdf51b553f033378244c3c986559cc95e63fb88f2d4ec2e27cec41e52a23aab\">\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/paraform/MBBn6gzfcEUwE0bv/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Paraform\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#2b7fff\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.paraform.com/api/overview\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api/overview.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.paraform.com/#organization\",\"name\":\"Paraform\",\"url\":\"https://docs.paraform.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/paraform/HyizjsxPYnbS7fcG/logo/light.svg?fit=max\u0026auto=format\u0026n=HyizjsxPYnbS7fcG\u0026q=85\u0026s=0cb262b4538b596a01e90571f8a0ae9d\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.paraform.com#website\",\"name\":\"Paraform\",\"url\":\"https://docs.paraform.com\",\"publisher\":{\"@id\":\"https://docs.paraform.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.paraform.com/api/overview#webpage\",\"url\":\"https://docs.paraform.com/api/overview\",\"name\":\"Paraform API\",\"description\":\"Call Paraform from your own systems. Endpoints are grouped by the persona that can call them.\",\"dateModified\":\"2026-10-29T22:00:23.319Z\",\"isPartOf\":{\"@id\":\"https://docs.paraform.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.paraform.com/api/overview#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.paraform.com/api/overview#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Paraform\",\"item\":\"https://docs.paraform.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Paraform API\",\"item\":\"https://docs.paraform.com/api/overview\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.paraform.com/api/overview#article\",\"headline\":\"Paraform API\",\"name\":\"Paraform API\",\"description\":\"Call Paraform from your own systems. Endpoints are grouped by the persona that can call them.\",\"url\":\"https://docs.paraform.com/api/overview\",\"mainEntityOfPage\":{\"@id\":\"https://docs.paraform.com/api/overview#webpage\"},\"dateModified\":\"2026-10-29T22:00:23.319Z\",\"publisher\":{\"@id\":\"https://docs.paraform.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.paraform.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Paraform\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Paraform\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api/overview.md","siteName":"Paraform","nav":{"global":null,"tabs":[{"tab":"MCP","pages":[{"title":"MCP","href":"/introduction"}]},{"tab":"API","groups":[{"group":"Get started","tag":"Beta","pages":[{"title":"Paraform API","sidebarTitle":"Overview","href":"/api/overview"},{"title":"Liveness check","description":"Needs no API key.","deprecated":null,"version":null,"openapi":"/api/openapi.json get /health","href":"/api-reference/liveness-check"},{"title":"Caller identity","deprecated":null,"version":null,"openapi":"/api/openapi.json get /identity","href":"/api-reference/caller-identity"}]},{"group":"Agency","tag":"Beta","pages":[{"title":"List an agency member's approved roles","deprecated":null,"version":null,"openapi":"/api/openapi.json get /agency/roles","href":"/api-reference/list-an-agency-members-approved-roles"},{"title":"Search roles for an agency member","deprecated":null,"version":null,"openapi":"/api/openapi.json get /agency/roles/search","href":"/api-reference/search-roles-for-an-agency-member"},{"title":"Read a role's recruiting brief","deprecated":null,"version":null,"openapi":"/api/openapi.json get /agency/roles/{roleId}","href":"/api-reference/read-a-roles-recruiting-brief"}]},{"group":"Talent Network","tag":"Beta","pages":[{"title":"Submit a candidate to the talent network","deprecated":null,"version":null,"openapi":"/api/openapi.json post /talent-network/candidates/submit","href":"/api-reference/submit-a-candidate-to-the-talent-network"},{"title":"Bulk submit candidates to the talent network","deprecated":null,"version":null,"openapi":"/api/openapi.json post /talent-network/candidates/submit-bulk","href":"/api-reference/bulk-submit-candidates-to-the-talent-network"},{"title":"Upload a resume","deprecated":null,"version":null,"openapi":"/api/openapi.json post /resumes","href":"/api-reference/upload-a-resume"},{"title":"Per-item status of a talent-network submission batch","deprecated":null,"version":null,"openapi":"/api/openapi.json get /talent-network/batches/{batchId}","href":"/api-reference/per-item-status-of-a-talent-network-submission-batch"},{"title":"List your agency's talent-network candidates","deprecated":null,"version":null,"openapi":"/api/openapi.json get /talent-network/candidates","href":"/api-reference/list-your-agencys-talent-network-candidates"},{"title":"Check which candidates are already in your talent network","deprecated":null,"version":null,"openapi":"/api/openapi.json post /talent-network/candidates/lookup","href":"/api-reference/check-which-candidates-are-already-in-your-talent-network"},{"title":"A candidate's recruiter-entered work preferences","deprecated":null,"version":null,"openapi":"/api/openapi.json get /talent-network/candidates/{candidateUserId}/preferences","href":"/api-reference/a-candidates-recruiter-entered-work-preferences"},{"title":"Read recruiter-entered preferences for many candidates at once","deprecated":null,"version":null,"openapi":"/api/openapi.json post /talent-network/candidates/preferences/lookup","href":"/api-reference/read-recruiter-entered-preferences-for-many-candidates-at-once"},{"title":"Replace a candidate's work preferences","deprecated":null,"version":null,"openapi":"/api/openapi.json put /talent-network/candidates/{candidateUserId}/preferences","href":"/api-reference/replace-a-candidates-work-preferences"},{"title":"A candidate's ParaAI fast-track opt-in","deprecated":null,"version":null,"openapi":"/api/openapi.json get /talent-network/candidates/{candidateUserId}/fast-track","href":"/api-reference/a-candidates-paraai-fast-track-opt-in"},{"title":"Set a candidate's ParaAI fast-track opt-in","deprecated":null,"version":null,"openapi":"/api/openapi.json put /talent-network/candidates/{candidateUserId}/fast-track","href":"/api-reference/set-a-candidates-paraai-fast-track-opt-in"},{"title":"Take candidates off ParaAI market","deprecated":null,"version":null,"openapi":"/api/openapi.json post /talent-network/candidates/off-market","href":"/api-reference/take-candidates-off-paraai-market"},{"title":"Re-enable off-market candidates for ParaAI matching","deprecated":null,"version":null,"openapi":"/api/openapi.json post /talent-network/candidates/re-enable","href":"/api-reference/re-enable-off-market-candidates-for-paraai-matching"}]},{"group":"Recruiter","tag":"Beta","pages":[{"title":"Browse roles you can work on","deprecated":null,"version":null,"openapi":"/api/openapi.json get /recruiter/roles","href":"/api-reference/browse-roles-you-can-work-on"},{"title":"List the roles you are working on","deprecated":null,"version":null,"openapi":"/api/openapi.json get /recruiter/active-roles","href":"/api-reference/list-the-roles-you-are-working-on"},{"title":"Everything you can see about one role","deprecated":null,"version":null,"openapi":"/api/openapi.json get /recruiter/roles/{roleId}","href":"/api-reference/everything-you-can-see-about-one-role"},{"title":"Your saved role preferences","deprecated":null,"version":null,"openapi":"/api/openapi.json get /recruiter/preferences","href":"/api-reference/your-saved-role-preferences"},{"title":"List candidates in your CRM","deprecated":null,"version":null,"openapi":"/api/openapi.json get /recruiter/candidates","href":"/api-reference/list-candidates-in-your-crm"},{"title":"One candidate from your CRM, in full","deprecated":null,"version":null,"openapi":"/api/openapi.json get /recruiter/candidates/{candidateId}","href":"/api-reference/one-candidate-from-your-crm-in-full"},{"title":"Roles recommended for one of your candidates","deprecated":null,"version":null,"openapi":"/api/openapi.json get /recruiter/candidates/{candidateId}/recommended-roles","href":"/api-reference/roles-recommended-for-one-of-your-candidates"},{"title":"Your recommended submissions, across every candidate in your CRM","deprecated":null,"version":null,"openapi":"/api/openapi.json get /recruiter/recommendations","href":"/api-reference/your-recommended-submissions-across-every-candidate-in-your-crm"},{"title":"ParaAI matches sent to you by hiring managers","deprecated":null,"version":null,"openapi":"/api/openapi.json get /recruiter/paraai-recommendations","href":"/api-reference/paraai-matches-sent-to-you-by-hiring-managers"},{"title":"List your recorded Parascribe calls","deprecated":null,"version":null,"openapi":"/api/openapi.json get /recruiter/parascribe-calls","href":"/api-reference/list-your-recorded-parascribe-calls"},{"title":"One of your Parascribe calls with its full transcript","deprecated":null,"version":null,"openapi":"/api/openapi.json get /recruiter/parascribe-calls/{callId}","href":"/api-reference/one-of-your-parascribe-calls-with-its-full-transcript"}]}]}]},"basePath":"","title":"Paraform API - Paraform","buildId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","deploymentId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","dynamics":[],"chunks":[]}