A population search is a search whose results are everyone in one population: every current employee of a company, or everyone who attended a school. The search adds people to its results as it finds them.Price the search first with Price a population. Starting it reserves the quoted credits.
Idempotency key. The same request_id returns the same search; a different population under the same id returns 409.
population.kind
company or school
—
What the population is.
population.id
string
—
The numeric id of the company or school.
population.name
string
—
The company or school name, 1–200 characters.
size
integer
null
How many people the population has, when you know it.
profile_depth
quick, partial, or full
partial
The depth every person in the population is built to. quick builds each person to a level 1 profile. See Profile depth.
Response
The response is a search snapshot. Poll GET /v3/search/{search_id} while status is running; results are append-only, so every poll returns everyone found so far. Population searches use include_profile: false; read a profile with Read a profile.The snapshot carries a population block:
Field
Description
kind, id, name
The population’s subject.
size
The population’s size as given, or null.
profile_depth
The depth every person is built to.
credits_quoted
The credits reserved when the search started.
status
running, completed, completed_with_errors, failed or cancelled. The search’s own status is completed_with_errors when the population ends failed or cancelled.
The search completes when the whole population is in. A person who could not be built ends failed and the search ends completed_with_errors.
Billing
Orbit reserves the quoted credits when the search starts, settles them as the work completes, and releases what it did not use when the search ends. See Credits.
Rate Limits
A population start spends the same rate-limit bucket as POST /v3/search. The quote spends the status bucket.
Authorizations
Authorization
string
header
required
Use an Orbit API key from the Developer Dashboard.
Headers
Idempotency-Key
string
A client-generated key for a safe retry. If the body omits request_id, Orbit can use this value as the request ID.
Maximum string length: 200
Body
application/json
population
object
required
Show child attributes
request_id
string
Idempotency key. The same request_id returns the same search; a different population under the same id returns 409.
Maximum string length: 200
size
integer | null
How many people the population has, when you know it.
Required range: x >= 0
profile_depth
enum<string>
default:partial
The depth every person in the population is built to.
Available options:
quick,
partial,
full
Response
The search completed at once.
search_id
string
required
Server-generated identifier for this search. Use it to poll the status endpoint.
request_id
string
required
The idempotency key from the original request, or a generated value when the request omitted it.
status
enum<string>
required
Overall search lifecycle. running means work is still in progress; poll until the status is terminal. completed means every result reached the requested profile depth; a search can complete with an empty results list when nothing matched. completed_with_errors means ready results are available but some work failed. failed means work failed and no ready results are available.
Available options:
running,
completed,
completed_with_errors,
failed
candidate_discovery
boolean
required
Whether this search runs candidate discovery, as resolved from the request.
profile_depth
enum<string>
required
The minimum profile depth requested for each ready result.
Available options:
quick,
partial,
full
include_profile
boolean
required
Whether readable results embed their Search profile.
profile_upgrades_completed
boolean
required
Whether every result in results has reached the requested profile_depth or failed. While candidate_discovery_completed is false, discovery can still add results with new profile work.
results
object[]
required
The people this search has found so far. Results are append-only: a reported result is never removed, and a ready result never regresses.
Show child attributes
created_at
string<date-time>
required
When the search was created.
updated_at
string<date-time>
required
When the snapshot last changed.
links
object
required
Show child attributes
candidate_discovery_completed
boolean
Whether the result list is final. Once true, discovery adds no more results to this search; the results themselves can still be generating or enriching toward the requested depth. For discovery searches this becomes true when clustering completes and every discovered person appears in results. If discovery failed, candidate_discovery_failure explains why. Present only when candidate_discovery is true.
provider_results_final
boolean
Whether the people-data provider lookup for a supplied phone, email, or address returned its complete owner set. Once true, every owner of that contact is in results with the contacts the provider reported, usually within the first response and before biography work. Discovery by name can still add results until candidate_discovery_completed is true. Present only when candidate_discovery is true and the request carried a phone, email, or address signal.
confidence_kind
enum<string>
identity when the search looks for one person, such as by name, contact, or face, and criteria when it looks for everyone who fits a description.
Available options:
identity,
criteria
none_of_above_confidence
number
One minus the best result's confidence. It is high when no result matches well. Present on identity searches.
Required range: 0 <= x <= 1
discovered_sources
object[]
Every page the search has found, in the order the search first found each one. The list starts filling within seconds and holds up to 200 pages. A page stays listed through later polls and after the search ends, including a page Candidate Discovery assigned to a result. Present when candidate_discovery is true.
Show child attributes
candidate_discovery_failure
object
Why candidate discovery failed. Present only when discovery failed.
Show child attributes
population
object
Present on population searches: the subject, the depth, the reserved credits and where the search is.
Show child attributes
query_intent
object
Present when the search parsed a plain-English query.
Show child attributes
billing
object
Credits held and spent for this search. The final consumedCredits is the full charge once status is settled.
{"docsConfig":{"theme":"luma","$schema":"https://mintlify.com/docs.json","name":"Orbit Developer API","description":"Find people with search, look deeper with enrich, and stay up to date with watchers.","colors":{"primary":"#0875B9","light":"#3AB3FF","dark":"#0875B9"},"logo":{"light":"https://mintcdn.com/orbit-5c173338/k-iXLNt-i1YvMS-Z/assets/orbit-logo-mark.png?fit=max\u0026auto=format\u0026n=k-iXLNt-i1YvMS-Z\u0026q=85\u0026s=8b0d9a458f0dbb073a9c9e109b9057bb","dark":"https://mintcdn.com/orbit-5c173338/k-iXLNt-i1YvMS-Z/assets/orbit-logo-mark.png?fit=max\u0026auto=format\u0026n=k-iXLNt-i1YvMS-Z\u0026q=85\u0026s=8b0d9a458f0dbb073a9c9e109b9057bb","href":"https://developer.orbitsearch.com"},"favicon":"https://mintcdn.com/orbit-5c173338/OymEY6nP8OtkVM8Z/assets/icon.png?fit=max\u0026auto=format\u0026n=OymEY6nP8OtkVM8Z\u0026q=85\u0026s=505a66363f63b13b3eb495e4da1c65ff","api":{"playground":{"display":"interactive"},"examples":{"languages":["curl","javascript","python"]},"mdx":{"auth":{"method":"bearer"},"server":"https://api.orbitsearch.com"}},"appearance":{"default":"dark","strict":false},"background":{"color":{"light":"#FAFAFA","dark":"#00050E"}},"navbar":{"links":[{"href":"https://orbitsearch.com","label":"Website"},{"href":"https://developer.orbitsearch.com/dashboard","label":"Developer Dashboard"},{"href":"https://github.com/orbit-search","type":"github"}],"primary":{"type":"button","label":"Get API Key","href":"https://developer.orbitsearch.com/auth/signup?next=%2Fdashboard%2Fkeys"}},"icons":{"library":"lucide"},"styling":{"eyebrows":"breadcrumbs","codeblocks":"dark","latex":false},"contextual":{"options":["copy","view","chatgpt","claude","cursor","vscode","download-spec"],"display":"header"},"metadata":{"timestamp":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"orbit-5c173338","hasAudioNarration":false,"actualSubdomain":"orbit-5c173338","customDomains":["docs.orbitsearch.com"],"gitSource":{"type":"github","owner":"orbit-search","repo":"docs","deployBranch":"main","isPrivate":true,"contentDirectory":"","mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6af2664fa30fe9d37b3354dc","clientVersion":"0.0.4177","searchFilterCounts":[{"language":"default","tag":"Reference","count":29},{"language":"default","tag":"Documentation","count":18},{"language":"default","tag":"Search","count":8},{"language":"default","tag":"Guides","count":7},{"language":"default","tag":"Watchers","count":6},{"language":"default","tag":"Start Here","count":5},{"language":"default","tag":"Webhooks","count":5},{"language":"default","tag":"Concepts","count":5},{"language":"default","tag":"Keys","count":4},{"language":"default","tag":"Enrich","count":4}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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":"starter-pricing","enabled":true,"variant":{"name":"control","enabled":true,"payload":{"type":"string","value":"control"},"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":"@font-face{font-family:\"MuseoSans\";src:url(\"/assets/fonts/Museo%20Sans%20Cyrl%20300.woff2\") format(\"woff2\");font-weight:300;font-style:normal;font-display:swap}@font-face{font-family:\"MuseoSans\";src:url(\"/assets/fonts/Museo%20Sans%20Cyrl%20500.woff2\") format(\"woff2\");font-weight:500;font-style:normal;font-display:swap}@font-face{font-family:\"MuseoSans\";src:url(\"/assets/fonts/Museo%20Sans%20Cyrl%20700.woff2\") format(\"woff2\");font-weight:700;font-style:normal;font-display:swap}@font-face{font-family:\"MuseoSans\";src:url(\"/assets/fonts/Museo%20Sans%20Cyrl%20900.woff2\") format(\"woff2\");font-weight:900;font-style:normal;font-display:swap}:root{--orbit-ink-50: #fafafa;--orbit-ink-100: #f4f4f5;--orbit-ink-300: #c9c9ce;--orbit-ink-400: #9a9aa2;--orbit-ink-600: #2a3a58;--orbit-ink-700: #18273f;--orbit-ink-800: #0c1623;--orbit-ink-900: #060d1d;--orbit-ink-950: #040914;--orbit-cyan: #70ebff;--orbit-lavender: #d9bdf2;--orbit-orchid: #9b5bff;--orbit-indigo: #4869ff;--orbit-violet: #8901fe;--orbit-pink: #ff0055;--orbit-top-gradient: linear-gradient(\n 90deg,\n #ff0055 0%,\n #e00181 25%,\n #8901fe 48%,\n #6d2eff 74%,\n #4869ff 100%\n );--orbit-background: #fafafa;--orbit-foreground: #101828;--orbit-text: #344054;--orbit-muted: #475467;--orbit-surface: rgba(16, 24, 40, 0.035);--orbit-surface-strong: rgba(16, 24, 40, 0.065);--orbit-border: rgba(16, 24, 40, 0.12);--orbit-border-strong: rgba(16, 24, 40, 0.2);--orbit-navbar: rgba(250, 250, 250, 0.9);--orbit-sidebar: rgba(250, 250, 250, 0.95);--orbit-footer: rgba(244, 244, 245, 0.8);--orbit-link: #0875b9;--orbit-link-hover: #065b91;--orbit-link-underline: rgba(8, 117, 185, 0.45);--orbit-accent-border: rgba(109, 46, 255, 0.22);--orbit-accent-border-hover: rgba(109, 46, 255, 0.4);--orbit-accent-surface: rgba(109, 46, 255, 0.06);--orbit-shadow: rgba(16, 24, 40, 0.18);--orbit-cta-background: #101828;--orbit-cta-text: #fafafa}html.dark{--orbit-background: #00050e;--orbit-foreground: #fafafa;--orbit-text: rgba(244, 244, 245, 0.78);--orbit-muted: rgba(250, 250, 250, 0.65);--orbit-surface: rgba(255, 255, 255, 0.055);--orbit-surface-strong: rgba(255, 255, 255, 0.09);--orbit-border: rgba(255, 255, 255, 0.12);--orbit-border-strong: rgba(255, 255, 255, 0.18);--orbit-navbar: rgba(0, 5, 14, 0.68);--orbit-sidebar: rgba(0, 5, 14, 0.5);--orbit-footer: rgba(4, 9, 20, 0.42);--orbit-link: #3ab3ff;--orbit-link-hover: #70ebff;--orbit-link-underline: rgba(58, 179, 255, 0.45);--orbit-accent-border: rgba(217, 189, 242, 0.16);--orbit-accent-border-hover: rgba(217, 189, 242, 0.34);--orbit-accent-surface: rgba(155, 91, 255, 0.1);--orbit-shadow: rgba(0, 0, 0, 0.75);--orbit-cta-background: #fafafa;--orbit-cta-text: #040914}html,body,button,input,textarea,select{font-family:\"MuseoSans\", ui-sans-serif, system-ui, -apple-system, BlinkMacSystemFont, \"Segoe UI\", sans-serif}html{background:var(--orbit-background)}body{color:var(--orbit-foreground);background:var(--orbit-background);font-feature-settings:\"ss01\", \"cv11\";-webkit-font-smoothing:antialiased;text-rendering:optimizeLegibility}::selection{background:var(--orbit-foreground);color:var(--orbit-background)}#background-color{background:transparent}#navbar{border-bottom:none;background:var(--orbit-navbar);box-shadow:none;backdrop-filter:blur(18px)}#navbar>.z-10.absolute,#navbar>.z-0.absolute{display:none!important}#navbar .px-0{padding-left:0!important;padding-right:0!important}#navbar .h-12{height:64px!important;padding-left:24px!important;padding-right:24px!important;gap:32px!important}#navbar .h-12>.flex-1:first-child{flex:0 0 auto!important;gap:0!important;padding-right:0!important}#navbar .h-12>.flex-1:first-child>div{display:none!important}#navbar .h-12>.flex-1:first-child~nav{padding:0!important}#navbar .topbar-right-container{flex:1 1 auto!important;justify-content:flex-end!important;gap:12px!important}#search-bar-entry-mobile{display:none!important}#navbar button[aria-label=\"More actions\"]{display:none!important}#navbar .topbar-right-container ul{display:flex!important}#navbar .topbar-right-container .navbar-link{display:flex!important}#navbar::before{content:\"\";position:fixed;top:0;left:0;right:0;z-index:9999;height:3px;background:var(--orbit-top-gradient);pointer-events:none}.nav-logo,.nav-logo *{max-height:36px!important;height:36px!important}.nav-logo img,.nav-logo svg{height:36px!important;width:36px!important;max-height:36px!important;object-fit:contain}#navbar img[alt],#navbar a[href]>img{height:36px!important;width:36px!important;max-height:36px!important;object-fit:contain}#navbar .pb-px{padding-bottom:0!important}navbar-link,nav-tabs-item,nav-anchor,.navbar-link>a,#navbar .link{border-radius:8px;color:var(--orbit-text);font-size:15px;font-weight:500;gap:32px;transition:color 180ms ease,\n background-color 180ms ease,\n transform 180ms ease}#navbar .h-12>nav .link{height:36px!important;padding-left:14px!important;padding-right:14px!important;border-radius:8px!important}navbar-link:hover,nav-tabs-item:hover,nav-anchor:hover,.navbar-link>a:hover,#navbar .link:hover,nav-tabs-item[data-active],.nav-tabs-item[data-active]{color:var(--orbit-foreground);background:var(--orbit-surface-strong);transform:translateY(-1px)}#topbar-cta-button>a{border:none;background:var(--orbit-cta-background);color:var(--orbit-cta-text);border-radius:999px;font-weight:700;box-shadow:none;transition:transform 180ms ease,\n opacity 180ms ease}#topbar-cta-button>a span{color:var(--orbit-cta-text)}#topbar-cta-button>a:hover{opacity:0.85;transform:translateY(-1px)}#search-bar-entry,#search-bar-entry-mobile{border:1px solid var(--orbit-border);background:var(--orbit-surface-strong);color:var(--orbit-text)}#search-bar-entry:hover,#search-bar-entry-mobile:hover{border-color:var(--orbit-accent-border-hover);background:var(--orbit-accent-surface);color:var(--orbit-foreground)}#sidebar,#table-of-contents{border-color:var(--orbit-border);background:var(--orbit-sidebar);backdrop-filter:blur(16px)}#navigation-items,#table-of-contents-content{padding-top:40px!important}#navigation-items .mt-6,#navigation-items .lg\\:mt-8{margin-top:16px!important}#sidebar-content li[data-active]{border-radius:8px;background:rgba(58, 179, 255, 0.16)}#sidebar-content li[data-active] a,toc-item[data-active],toc-item[data-active-deepest]{color:var(--orbit-link)}#page-title{color:var(--orbit-foreground);letter-spacing:0}eyebrow,breadcrumb-list,#table-of-contents-content{color:var(--orbit-muted)}mdx-content{color:var(--orbit-text)}mdx-content h2,mdx-content h3,mdx-content h4{color:var(--orbit-foreground);letter-spacing:0}mdx-content a,link{color:var(--orbit-link);text-underline-offset:0.18em}#content-area a.link{background:none!important;border:none!important;border-radius:0!important;box-shadow:none!important;padding:0!important;color:var(--orbit-link);font-weight:500;text-decoration:underline;text-decoration-thickness:1px;text-decoration-color:var(--orbit-link-underline);text-underline-offset:0.2em}#content-area a.link:hover{color:var(--orbit-link-hover);text-decoration-color:var(--orbit-link-hover)}card,callout,accordion,expandable,tabs,code-block,#request-example,#response-example,#api-playground-input{border-color:var(--orbit-accent-border);background:var(--orbit-surface);box-shadow:0 18px 60px -42px var(--orbit-shadow);backdrop-filter:blur(12px)}card:hover{border-color:var(--orbit-accent-border-hover);background:var(--orbit-accent-surface)}code-block{background:rgba(4, 9, 20, 0.94)}method-pill,method-nav-pill{border-radius:999px;font-weight:700}#pagination{border-color:var(--orbit-border)}footer,#footer{border-top:1px solid var(--orbit-border);background:var(--orbit-footer)}@media (max-width: 1023px){#navbar div.hidden.lg\\:flex.h-12{display:contents!important}#navbar div.hidden.lg\\:flex.h-12>.flex-1:first-child,#navbar div.hidden.lg\\:flex.h-12>nav{display:none!important}#navbar .topbar-right-container{position:fixed!important;top:3px!important;right:56px!important;height:69px!important;z-index:45!important;display:flex!important;align-items:center!important;gap:6px!important}#navbar .topbar-right-container>div:first-child{display:none!important}#navbar .topbar-right-container ul{display:flex!important;flex-direction:row!important;align-items:center!important;gap:10px!important;list-style:none!important}#navbar .topbar-right-container .navbar-link{display:flex!important;flex-shrink:0!important}#navbar .topbar-right-container .navbar-link a{display:block!important;width:34px!important;height:34px!important;min-width:34px!important;min-height:34px!important;padding:0!important;border:none!important;border-radius:10px!important;font-size:0!important;line-height:0!important;text-indent:-9999px!important;color:transparent!important;background:var(--orbit-surface-strong)!important;position:relative!important;overflow:hidden!important}#navbar .topbar-right-container .navbar-link a::before{content:\"\"!important;position:absolute!important;top:50%!important;left:50%!important;transform:translate(-50%, -50%)!important;width:15px!important;height:15px!important;background:var(--orbit-muted)!important;-webkit-mask-size:contain!important;mask-size:contain!important;-webkit-mask-repeat:no-repeat!important;mask-repeat:no-repeat!important;-webkit-mask-position:center!important;mask-position:center!important}#navbar .topbar-right-container .navbar-link:first-child a::before{-webkit-mask-image:url(\"data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' width='24' height='24' viewBox='0 0 24 24' fill='none' stroke='%23fff' stroke-width='2' stroke-linecap='round' stroke-linejoin='round'%3E%3Ccircle cx='12' cy='12' r='10'/%3E%3Cpath d='M12 2a14.5 14.5 0 0 0 0 20 14.5 14.5 0 0 0 0-20'/%3E%3Cpath d='M2 12h20'/%3E%3C/svg%3E\")!important;mask-image:url(\"data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' width='24' height='24' viewBox='0 0 24 24' fill='none' stroke='%23fff' stroke-width='2' stroke-linecap='round' stroke-linejoin='round'%3E%3Ccircle cx='12' cy='12' r='10'/%3E%3Cpath d='M12 2a14.5 14.5 0 0 0 0 20 14.5 14.5 0 0 0 0-20'/%3E%3Cpath d='M2 12h20'/%3E%3C/svg%3E\")!important}#navbar .topbar-right-container .navbar-link:nth-child(2) a::before{-webkit-mask-image:url(\"data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' width='24' height='24' viewBox='0 0 24 24' fill='none' stroke='%23fff' stroke-width='2' stroke-linecap='round' stroke-linejoin='round'%3E%3Crect width='7' height='9' x='3' y='3' rx='1'/%3E%3Crect width='7' height='5' x='14' y='3' rx='1'/%3E%3Crect width='7' height='9' x='14' y='12' rx='1'/%3E%3Crect width='7' height='5' x='3' y='16' rx='1'/%3E%3C/svg%3E\")!important;mask-image:url(\"data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' width='24' height='24' viewBox='0 0 24 24' fill='none' stroke='%23fff' stroke-width='2' stroke-linecap='round' stroke-linejoin='round'%3E%3Crect width='7' height='9' x='3' y='3' rx='1'/%3E%3Crect width='7' height='5' x='14' y='3' rx='1'/%3E%3Crect width='7' height='9' x='14' y='12' rx='1'/%3E%3Crect width='7' height='5' x='3' y='16' rx='1'/%3E%3C/svg%3E\")!important}#topbar-cta-button{display:flex!important}#topbar-cta-button>a{width:34px!important;height:34px!important;padding:0!important;justify-content:center!important;border-radius:50%!important;position:relative!important;overflow:hidden!important}#topbar-cta-button>a .flex{font-size:0!important;color:transparent!important}#topbar-cta-button>a .flex::before{content:\"\"!important;position:absolute!important;top:50%!important;left:50%!important;transform:translate(-50%, -50%)!important;width:18px!important;height:18px!important;background:var(--orbit-cta-text)!important;-webkit-mask-image:url(\"data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' width='24' height='24' viewBox='0 0 24 24' fill='none' stroke='%23000' stroke-width='2' stroke-linecap='round' stroke-linejoin='round'%3E%3Cpath d='m15.5 7.5 2.3 2.3a1 1 0 0 0 1.4 0l2.1-2.1a1 1 0 0 0 0-1.4L19 4'/%3E%3Cpath d='m21 2-9.6 9.6'/%3E%3Ccircle cx='7.5' cy='15.5' r='5.5'/%3E%3C/svg%3E\")!important;mask-image:url(\"data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' width='24' height='24' viewBox='0 0 24 24' fill='none' stroke='%23000' stroke-width='2' stroke-linecap='round' stroke-linejoin='round'%3E%3Cpath d='m15.5 7.5 2.3 2.3a1 1 0 0 0 1.4 0l2.1-2.1a1 1 0 0 0 0-1.4L19 4'/%3E%3Cpath d='m21 2-9.6 9.6'/%3E%3Ccircle cx='7.5' cy='15.5' r='5.5'/%3E%3C/svg%3E\")!important;-webkit-mask-size:contain!important;mask-size:contain!important;-webkit-mask-repeat:no-repeat!important;mask-repeat:no-repeat!important}#topbar-cta-button>a span{display:none!important}#topbar-cta-button>a svg{display:none!important}#navbar button[aria-label=\"More actions\"]{display:none!important}}@media (max-width: 1023px){#content-area{padding-top:0!important}}@media (max-width: 1023px){#navbar div.lg\\:hidden.h-12{height:70px!important;padding-left:16px!important;padding-right:60px!important}#navbar~button.h-14,button.h-14.lg\\:hidden{position:fixed!important;top:3px!important;right:16px!important;left:auto!important;width:36px!important;height:69px!important;padding:2px!important;display:flex!important;align-items:center!important;justify-content:center!important;z-index:50!important;background:transparent!important}button.h-14.lg\\:hidden>.ml-4{display:none!important}button.h-14.lg\\:hidden>div:first-child{color:var(--orbit-muted)!important}button.h-14.lg\\:hidden>div:first-child svg{height:16px!important;width:20px!important}#navigation-items{padding-top:2px!important}#sidebar,#mobile-nav,#sidebar-content{background:var(--orbit-sidebar)!important;backdrop-filter:blur(18px)!important;border-color:var(--orbit-border)!important}#sidebar-content{top:70px!important;left:0!important;right:0!important;width:100%!important;max-height:calc(100vh - 70px)!important;border-radius:0 0 16px 16px!important;border-top:none!important;border-bottom:1px solid var(--orbit-border)!important;box-shadow:0 24px 80px -40px var(--orbit-shadow)!important}}.update [data-component-part=\"update-tag-list\"],.update [data-component-part=\"update-description\"]{margin-top:0.3rem}.update [data-component-part=\"update-content\"]>:first-child strong{color:var(--orbit-foreground);display:inline-block;font-size:1.25rem;line-height:1.3;margin-bottom:0.35rem}.mdx-content:has(.update) h2{margin-top:3.25rem;padding-bottom:0.65rem;border-bottom:1px solid var(--orbit-border)}@media (min-width: 1024px){#content-container:not(:has(#content-side-layout .code-group,#request-example,#response-example,#response-examples)) #content-area{max-width:56rem;margin-left:max(0px, calc(50vw - 28rem - 14rem))}}#page-context-menu button{border-color:var(--orbit-border-strong)}#page-context-menu button[aria-haspopup] svg{color:var(--orbit-muted)}@media (prefers-reduced-motion: reduce){*,*::before,*::after{animation-duration:0.001ms!important;animation-iteration-count:1!important;scroll-behavior:auto!important;transition-duration:0.001ms!important}}#content-area:has(>#footer){display:flex;flex-direction:column;min-height:calc(100dvh - 4rem)}#content-area>#footer{margin-top:auto;padding-top:1.5rem;padding-bottom:1.5rem;background:transparent}@media (max-width: 1023px){#content-area:has(>#footer){min-height:calc(100dvh - 6.5rem)}}"}],"page":{"pagePath":"api/search/population","slug":"/api/search/population","pageMetadata":{"title":"Search a Population","sidebarTitle":"Search a Population","description":"Search everyone at a company or everyone who attended a school. Results arrive while the search runs.","openapi":"openapi.json POST /v3/search/populations","href":"/api/search/population"},"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: \"Search everyone at a company or everyone who attended a school. Results arrive while the search runs.\"\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`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,..._provideComponents(),...props.components},{CodeBlock,Heading,Table}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Table)_missingMdxReference(`Table`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`A population search is a search whose results are everyone in one population: every current employee of a company, or everyone who attended a school. The search adds people to its results as it finds them.`}),`\n`,_jsxs(_components.p,{children:[`Price the search first with `,_jsx(_components.a,{href:`/api/search/population-quote`,children:`Price a population`}),`. Starting it reserves the quoted credits.`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`9`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes dark-plus dark-plus`,style:{backgroundColor:`#0B0C0E`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`9`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#DCDCAA`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#569CD6`,\"--shiki-dark\":`#569CD6`},children:` -X`}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:` POST`}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:` \"https://api.orbitsearch.com/v3/search/populations\"`}),_jsx(_components.span,{style:{color:`#D7BA7D`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#569CD6`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:` \"Authorization: Bearer `}),_jsx(_components.span,{style:{color:`#9CDCFE`,\"--shiki-dark\":`#9CDCFE`},children:`$ORBIT_API_KEY`}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:`\"`}),_jsx(_components.span,{style:{color:`#D7BA7D`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#569CD6`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:` \"Content-Type: application/json\"`}),_jsx(_components.span,{style:{color:`#D7BA7D`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#569CD6`,\"--shiki-dark\":`#569CD6`},children:` -d`}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:` '{`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:` \"request_id\": \"a6c1c2f0-4d3e-4b0f-9b3e-2e2a5a4f1c11\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:` \"population\": { \"kind\": \"company\", \"id\": \"1441\", \"name\": \"OpenAI\" },`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:` \"size\": 2400,`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:` \"profile_depth\": \"partial\"`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:` }'`})}),`\n`]})})}),`\n`,_jsx(Heading,{level:`2`,id:`request-body`,children:`Request Body`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Field`}),_jsx(_components.th,{children:`Type`}),_jsx(_components.th,{children:`Default`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`request_id`})}),_jsx(_components.td,{children:`string`}),_jsx(_components.td,{children:`generated`}),_jsxs(_components.td,{children:[`Idempotency key. The same `,_jsx(_components.code,{children:`request_id`}),` returns the same search; a different population under the same id returns `,_jsx(_components.code,{children:`409`}),`.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`population.kind`})}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`company`}),` or `,_jsx(_components.code,{children:`school`})]}),_jsx(_components.td,{children:`—`}),_jsx(_components.td,{children:`What the population is.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`population.id`})}),_jsx(_components.td,{children:`string`}),_jsx(_components.td,{children:`—`}),_jsx(_components.td,{children:`The numeric id of the company or school.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`population.name`})}),_jsx(_components.td,{children:`string`}),_jsx(_components.td,{children:`—`}),_jsx(_components.td,{children:`The company or school name, 1–200 characters.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`size`})}),_jsx(_components.td,{children:`integer`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`null`})}),_jsx(_components.td,{children:`How many people the population has, when you know it.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`profile_depth`})}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`quick`}),`, `,_jsx(_components.code,{children:`partial`}),`, or `,_jsx(_components.code,{children:`full`})]}),_jsx(_components.td,{children:_jsx(_components.code,{children:`partial`})}),_jsxs(_components.td,{children:[`The depth every person in the population is built to. `,_jsx(_components.code,{children:`quick`}),` builds each person to a level 1 profile. See `,_jsx(_components.a,{href:`/concepts/search#2-profile-depth`,children:`Profile depth`}),`.`]})]})]})]}),`\n`,_jsx(Heading,{level:`2`,id:`response`,children:`Response`}),`\n`,_jsxs(_components.p,{children:[`The response is a `,_jsx(_components.a,{href:`/api/search/search-status`,children:`search snapshot`}),`. Poll `,_jsx(_components.code,{children:`GET /v3/search/{search_id}`}),` while `,_jsx(_components.code,{children:`status`}),` is `,_jsx(_components.code,{children:`running`}),`; results are append-only, so every poll returns everyone found so far. Population searches use `,_jsx(_components.code,{children:`include_profile: false`}),`; read a profile with `,_jsx(_components.a,{href:`/api/enrich/read-profile`,children:`Read a profile`}),`.`]}),`\n`,_jsxs(_components.p,{children:[`The snapshot carries a `,_jsx(_components.code,{children:`population`}),` block:`]}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Field`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[_jsx(_components.code,{children:`kind`}),`, `,_jsx(_components.code,{children:`id`}),`, `,_jsx(_components.code,{children:`name`})]}),_jsx(_components.td,{children:`The population’s subject.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`size`})}),_jsxs(_components.td,{children:[`The population’s size as given, or `,_jsx(_components.code,{children:`null`}),`.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`profile_depth`})}),_jsx(_components.td,{children:`The depth every person is built to.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`credits_quoted`})}),_jsx(_components.td,{children:`The credits reserved when the search started.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`status`})}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`running`}),`, `,_jsx(_components.code,{children:`completed`}),`, `,_jsx(_components.code,{children:`completed_with_errors`}),`, `,_jsx(_components.code,{children:`failed`}),` or `,_jsx(_components.code,{children:`cancelled`}),`. The search’s own `,_jsx(_components.code,{children:`status`}),` is `,_jsx(_components.code,{children:`completed_with_errors`}),` when the population ends `,_jsx(_components.code,{children:`failed`}),` or `,_jsx(_components.code,{children:`cancelled`}),`.`]})]})]})]}),`\n`,_jsxs(_components.p,{children:[`The search completes when the whole population is in. A person who could not be built ends `,_jsx(_components.code,{children:`failed`}),` and the search ends `,_jsx(_components.code,{children:`completed_with_errors`}),`.`]}),`\n`,_jsx(Heading,{level:`2`,id:`billing`,children:`Billing`}),`\n`,_jsxs(_components.p,{children:[`Orbit reserves the quoted credits when the search starts, settles them as the work completes, and releases what it did not use when the search ends. See `,_jsx(_components.a,{href:`/concepts/credits`,children:`Credits`}),`.`]}),`\n`,_jsx(Heading,{level:`2`,id:`rate-limits`,children:`Rate Limits`}),`\n`,_jsxs(_components.p,{children:[`A population start spends the same rate-limit bucket as `,_jsx(_components.code,{children:`POST /v3/search`}),`. The quote spends the status bucket.`]})]})}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":{"codeStyling":"dark","config":{},"pageMetadata":{"title":"Search a Population","sidebarTitle":"Search a Population","description":"Search everyone at a company or everyone who attended a school. Results arrive while the search runs.","openapi":"openapi.json POST /v3/search/populations","href":"/api/search/population"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Request Body","slug":"request-body","depth":2,"children":[]},{"title":"Response","slug":"response","depth":2,"children":[]},{"title":"Billing","slug":"billing","depth":2,"children":[]},{"title":"Rate Limits","slug":"rate-limits","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":["/_mintlify/custom/orbit-5c173338/dc4679301029635e/toc-months.js"],"openApiReferenceData":{"operation":{"tags":["Search"],"summary":"Search a Population","description":"Search everyone at a company or everyone who attended a school. Results arrive while the search runs.","operationId":"startPopulationSearch","parameters":["d9fefd09-90c9-4ec6-ad5a-0f83f899667f"],"requestBody":"fab7549d-8327-4ec2-8111-7f06cd5b9ff1","responses":{"200":"e44b11f8-df75-451f-ba1f-99f30b00d959","202":"e21f9302-8617-4efc-9be5-749db9a632f4","400":"b745d311-0e69-4105-a665-d3dad7fc7857","401":"938d1acb-5128-4cf5-94d3-f86bc58c6c78","402":"3bf50adc-19ae-43b9-9c2d-84f2bf15805b","403":"3259fe1d-a410-4462-bb75-844e46e9fb9c","409":"56fbdccd-9195-4363-ad8d-0925dfc421f0","429":"3a5ddbee-c157-4b2e-8a14-1eee3048e2b6"},"method":"post","type":"path","servers":["1b4a0f77-4036-4a1c-8df8-e593ae1ad48d"],"security":["9cbd971c-25cc-46c5-8e19-38bb281e438c"],"path":"/v3/search/populations","baseUrlOptions":["https://api.orbitsearch.com"],"title":"Search a Population","codeSamples":[],"requestExampleLanguages":["bash","javascript","python"],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"d9fefd09-90c9-4ec6-ad5a-0f83f899667f":{"name":"Idempotency-Key","in":"header","required":false,"description":"A client-generated key for a safe retry. If the body omits `request_id`, Orbit can use this value as the request ID.","schema":{"type":"string","maxLength":200,"isRequired":false,"description":"A client-generated key for a safe retry. If the body omits `request_id`, Orbit can use this value as the request ID.","uniqueKey":"","typeLabel":"string"}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["population"],"properties":{"population":{"type":"object","required":["kind","id","name"],"properties":{"kind":{"type":"string","enum":["company","school"],"description":"What the population is: the current employees of a company, or the alumni of a school.","isRequired":true,"uniqueKey":"population.kind","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"The numeric id of the company or school.","isRequired":true,"uniqueKey":"population.id","typeLabel":"string"},"name":{"type":"string","minLength":1,"maxLength":200,"description":"The company or school name.","isRequired":true,"uniqueKey":"population.name","typeLabel":"string"}},"isRequired":true,"uniqueKey":"population","typeLabel":"object"},"request_id":{"type":"string","maxLength":200,"description":"Idempotency key. The same request_id returns the same search; a different population under the same id returns 409.","uniqueKey":"request_id","typeLabel":"string"},"size":{"oneOf":[{"type":"integer","minimum":0,"description":"How many people the population has, when you know it.","uniqueKey":"size.oneOf.0","typeLabel":"integer"},{"type":"null","minimum":0,"description":"How many people the population has, when you know it.","uniqueKey":"size.oneOf.1","typeLabel":"null"}],"uniqueKey":"size","typeLabel":"integer | null"},"profile_depth":{"type":"string","enum":["quick","partial","full"],"default":"partial","description":"The depth every person in the population is built to.","uniqueKey":"profile_depth","typeLabel":"enum\u003cstring>"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"population":{"id":"\u003cstring>","name":"\u003cstring>"},"request_id":"\u003cstring>","size":1,"profile_depth":"partial"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"e44b11f8-df75-451f-ba1f-99f30b00d959":{"description":"The search completed at once.","content":{"application/json":{"schema":{"type":"object","required":["search_id","request_id","status","candidate_discovery","profile_depth","include_profile","profile_upgrades_completed","results","created_at","updated_at","links"],"properties":{"search_id":{"type":"string","description":"Server-generated identifier for this search. Use it to poll the status endpoint.","isRequired":true,"uniqueKey":"search_id","typeLabel":"string"},"request_id":{"type":"string","description":"The idempotency key from the original request, or a generated value when the request omitted it.","isRequired":true,"uniqueKey":"request_id","typeLabel":"string"},"status":{"type":"string","description":"Overall search lifecycle. `running` means work is still in progress; poll until the status is terminal. `completed` means every result reached the requested profile depth; a search can complete with an empty results list when nothing matched. `completed_with_errors` means ready results are available but some work failed. `failed` means work failed and no ready results are available.","enum":["running","completed","completed_with_errors","failed"],"isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"candidate_discovery":{"type":"boolean","description":"Whether this search runs candidate discovery, as resolved from the request.","isRequired":true,"uniqueKey":"candidate_discovery","typeLabel":"boolean"},"profile_depth":{"type":"string","description":"The minimum profile depth requested for each ready result.","enum":["quick","partial","full"],"isRequired":true,"uniqueKey":"profile_depth","typeLabel":"enum\u003cstring>"},"include_profile":{"type":"boolean","description":"Whether readable results embed their Search profile.","isRequired":true,"uniqueKey":"include_profile","typeLabel":"boolean"},"profile_upgrades_completed":{"type":"boolean","description":"Whether every result in results has reached the requested profile_depth or failed. While candidate_discovery_completed is false, discovery can still add results with new profile work.","isRequired":true,"uniqueKey":"profile_upgrades_completed","typeLabel":"boolean"},"results":{"type":"array","description":"The people this search has found so far. Results are append-only: a reported result is never removed, and a ready result never regresses.","items":{"type":"object","required":["profile_id","status","generation_level","sources"],"properties":{"profile_id":{"type":"string","description":"Stable identifier for this person. Use it with the profile endpoints.","isRequired":true,"uniqueKey":"results.items.[INDEX].profile_id","typeLabel":"string"},"status":{"type":"string","description":"Result lifecycle. `generating` means candidate discovery found this person but no readable profile exists yet; it appears only on candidate discovery results. `enriching` means a readable profile exists but is below the requested depth. `ready` means the profile reached the requested profile_depth. `failed` means this result cannot reach the requested depth; failure explains why. Statuses only move forward.","enum":["generating","enriching","ready","failed"],"isRequired":true,"uniqueKey":"results.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"generation_level":{"oneOf":[{"type":"integer","description":"The stored generation level of this profile: 1 contains Orbit identity data, 2 adds LinkedIn enrichment, 3 adds web, social, and OSINT enrichment. A `quick` depth requires at least level 1, a `partial` depth requires at least level 2, and a `full` depth requires level 3. Null until the profile is first published.","minimum":1,"isRequired":true,"uniqueKey":"results.items.[INDEX].generation_level.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The stored generation level of this profile: 1 contains Orbit identity data, 2 adds LinkedIn enrichment, 3 adds web, social, and OSINT enrichment. A `quick` depth requires at least level 1, a `partial` depth requires at least level 2, and a `full` depth requires level 3. Null until the profile is first published.","isRequired":true,"uniqueKey":"results.items.[INDEX].generation_level.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"results.items.[INDEX].generation_level","typeLabel":"integer | null"},"sources":{"type":"array","description":"The origins that produced this result. This field does not contain source receipts.","items":{"type":"string","enum":["search","candidate_discovery"],"uniqueKey":"results.items.[INDEX].sources.items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":true,"uniqueKey":"results.items.[INDEX].sources","typeLabel":"enum\u003cstring>[]"},"candidate_sources":{"type":"array","description":"The person's source pages, present with either `include_profile` value. The pages Candidate Discovery assigned to this result come first and stay stable when the result becomes ready; each of them is also listed in `discovered_sources`. The other pages Orbit holds for the person follow, up to 200 pages in all.","items":{"type":"object","additionalProperties":false,"required":["link","title","sourceImage"],"properties":{"link":{"type":"string","format":"uri","description":"URL of the discovered source page.","isRequired":true,"uniqueKey":"results.items.[INDEX].candidate_sources.items.[INDEX].link","typeLabel":"string\u003curi>"},"title":{"type":"string","description":"Display title of the source page or site.","isRequired":true,"uniqueKey":"results.items.[INDEX].candidate_sources.items.[INDEX].title","typeLabel":"string"},"sourceImage":{"type":"string","format":"uri","description":"URL of the favicon for the site that hosts the source page.","isRequired":true,"uniqueKey":"results.items.[INDEX].candidate_sources.items.[INDEX].sourceImage","typeLabel":"string\u003curi>"},"face_match":{"type":"object","description":"Present on a face search for each page the search found a face on. A page with `kept` true is a page of the picked face, and a confirmed page is a strong match. A page with `kept` false shows another face that looks alike.","required":["score","confirmed"],"properties":{"score":{"type":"number","minimum":0,"maximum":1,"description":"How alike the face on this page and the picked face are, from 0 to 1.","isRequired":true,"uniqueKey":"results.items.[INDEX].candidate_sources.items.[INDEX].face_match.score","typeLabel":"number"},"confirmed":{"type":"boolean","description":"Whether the score is high enough to confirm the same person.","isRequired":true,"uniqueKey":"results.items.[INDEX].candidate_sources.items.[INDEX].face_match.confirmed","typeLabel":"boolean"},"kept":{"type":"boolean","description":"Whether the search counts this page as a page of the picked face. A page with `kept` false shows another face that looks alike and is listed in `discovered_sources` only.","uniqueKey":"results.items.[INDEX].candidate_sources.items.[INDEX].face_match.kept","typeLabel":"boolean"},"thumbnail":{"type":"string","description":"A small image of the face found on the page, as a `data:` URL.","uniqueKey":"results.items.[INDEX].candidate_sources.items.[INDEX].face_match.thumbnail","typeLabel":"string"}},"uniqueKey":"results.items.[INDEX].candidate_sources.items.[INDEX].face_match","typeLabel":"object"}},"uniqueKey":"results.items.[INDEX].candidate_sources.items.[INDEX]","typeLabel":"object"},"uniqueKey":"results.items.[INDEX].candidate_sources","typeLabel":"object[]"},"preview":{"type":"object","additionalProperties":true,"description":"Lightweight search preview built from the data Search returned for this person, such as name, avatar, location, headline, and generation level. Known-search results carry it with either include_profile value.","uniqueKey":"results.items.[INDEX].preview","typeLabel":"object"},"profile":{"type":"object","description":"The profile embedded in a readable result when include_profile is true: identity fields, contact fields, and generated sections. Read GET /v3/enrich/{profile_id} for the image gallery and source links.","required":["id","generationLevel","avatarUrl","verified","sections"],"additionalProperties":true,"properties":{"id":{"type":"any","isRequired":true,"uniqueKey":"results.items.[INDEX].profile.id","typeLabel":"any"},"generationLevel":{"type":"any","isRequired":true,"uniqueKey":"results.items.[INDEX].profile.generationLevel","typeLabel":"any"},"avatarUrl":{"type":"any","isRequired":true,"uniqueKey":"results.items.[INDEX].profile.avatarUrl","typeLabel":"any"},"verified":{"type":"any","isRequired":true,"uniqueKey":"results.items.[INDEX].profile.verified","typeLabel":"any"},"sections":{"type":"object","description":"Generated profile sections, such as bio, jobs, and education. Each section carries its content fields. Read GET /v3/enrich/{profile_id} for the image gallery and source links.","required":["socials"],"properties":{"socials":{"type":"object","description":"A generated section with its items. Each item carries its content fields.","required":["items"],"additionalProperties":true,"properties":{"items":{"type":"array","items":{"type":"object","additionalProperties":true,"uniqueKey":"results.items.[INDEX].profile.sections.socials.\\items.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"results.items.[INDEX].profile.sections.socials.\\items","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"results.items.[INDEX].profile.sections.socials","typeLabel":"object"},"bio":{"oneOf":[{"type":"null","uniqueKey":"results.items.[INDEX].profile.sections.bio.oneOf.0","typeLabel":"null"},{"type":"object","description":"The generated bio text.","required":["bio"],"properties":{"bio":{"type":"string","isRequired":true,"uniqueKey":"results.items.[INDEX].profile.sections.bio.oneOf.1.bio","typeLabel":"string"}},"additionalProperties":true,"uniqueKey":"results.items.[INDEX].profile.sections.bio.oneOf.1","typeLabel":"object"}],"uniqueKey":"results.items.[INDEX].profile.sections.bio","typeLabel":"null | object"},"basic":{"oneOf":[{"type":"null","uniqueKey":"results.items.[INDEX].profile.sections.basic.oneOf.0","typeLabel":"null"},{"type":"object","description":"A generated section with its items. Each item carries its content fields.","required":["items"],"properties":{"items":{"type":"array","items":{"type":"object","additionalProperties":true,"uniqueKey":"results.items.[INDEX].profile.sections.basic.oneOf.1.\\items.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"results.items.[INDEX].profile.sections.basic.oneOf.1.\\items","typeLabel":"object[]"}},"additionalProperties":true,"uniqueKey":"results.items.[INDEX].profile.sections.basic.oneOf.1","typeLabel":"object"}],"uniqueKey":"results.items.[INDEX].profile.sections.basic","typeLabel":"null | object"},"personalLife":{"oneOf":[{"type":"null","uniqueKey":"results.items.[INDEX].profile.sections.personalLife.oneOf.0","typeLabel":"null"},{"type":"object","description":"A generated section with its items. Each item carries its content fields.","required":["items"],"properties":{"items":{"type":"array","items":{"type":"object","additionalProperties":true,"uniqueKey":"results.items.[INDEX].profile.sections.personalLife.oneOf.1.\\items.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"results.items.[INDEX].profile.sections.personalLife.oneOf.1.\\items","typeLabel":"object[]"}},"additionalProperties":true,"uniqueKey":"results.items.[INDEX].profile.sections.personalLife.oneOf.1","typeLabel":"object"}],"uniqueKey":"results.items.[INDEX].profile.sections.personalLife","typeLabel":"null | object"},"jobs":{"oneOf":[{"type":"null","uniqueKey":"results.items.[INDEX].profile.sections.jobs.oneOf.0","typeLabel":"null"},{"type":"object","description":"A generated section with its items. Each item carries its content fields.","required":["items"],"properties":{"items":{"type":"array","items":{"type":"object","additionalProperties":true,"uniqueKey":"results.items.[INDEX].profile.sections.jobs.oneOf.1.\\items.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"results.items.[INDEX].profile.sections.jobs.oneOf.1.\\items","typeLabel":"object[]"}},"additionalProperties":true,"uniqueKey":"results.items.[INDEX].profile.sections.jobs.oneOf.1","typeLabel":"object"}],"uniqueKey":"results.items.[INDEX].profile.sections.jobs","typeLabel":"null | object"},"education":{"oneOf":[{"type":"null","uniqueKey":"results.items.[INDEX].profile.sections.education.oneOf.0","typeLabel":"null"},{"type":"object","description":"A generated section with its items. Each item carries its content fields.","required":["items"],"properties":{"items":{"type":"array","items":{"type":"object","additionalProperties":true,"uniqueKey":"results.items.[INDEX].profile.sections.education.oneOf.1.\\items.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"results.items.[INDEX].profile.sections.education.oneOf.1.\\items","typeLabel":"object[]"}},"additionalProperties":true,"uniqueKey":"results.items.[INDEX].profile.sections.education.oneOf.1","typeLabel":"object"}],"uniqueKey":"results.items.[INDEX].profile.sections.education","typeLabel":"null | object"},"passions":{"oneOf":[{"type":"null","uniqueKey":"results.items.[INDEX].profile.sections.passions.oneOf.0","typeLabel":"null"},{"type":"object","description":"A generated section with its items. Each item carries its content fields.","required":["items"],"properties":{"items":{"type":"array","items":{"type":"object","additionalProperties":true,"uniqueKey":"results.items.[INDEX].profile.sections.passions.oneOf.1.\\items.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"results.items.[INDEX].profile.sections.passions.oneOf.1.\\items","typeLabel":"object[]"}},"additionalProperties":true,"uniqueKey":"results.items.[INDEX].profile.sections.passions.oneOf.1","typeLabel":"object"}],"uniqueKey":"results.items.[INDEX].profile.sections.passions","typeLabel":"null | object"},"worldview":{"oneOf":[{"type":"null","uniqueKey":"results.items.[INDEX].profile.sections.worldview.oneOf.0","typeLabel":"null"},{"type":"object","description":"A generated section with its items. Each item carries its content fields.","required":["items"],"properties":{"items":{"type":"array","items":{"type":"object","additionalProperties":true,"uniqueKey":"results.items.[INDEX].profile.sections.worldview.oneOf.1.\\items.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"results.items.[INDEX].profile.sections.worldview.oneOf.1.\\items","typeLabel":"object[]"}},"additionalProperties":true,"uniqueKey":"results.items.[INDEX].profile.sections.worldview.oneOf.1","typeLabel":"object"}],"uniqueKey":"results.items.[INDEX].profile.sections.worldview","typeLabel":"null | object"},"accomplishments":{"oneOf":[{"type":"null","uniqueKey":"results.items.[INDEX].profile.sections.accomplishments.oneOf.0","typeLabel":"null"},{"type":"object","description":"A generated section with its items. Each item carries its content fields.","required":["items"],"properties":{"items":{"type":"array","items":{"type":"object","additionalProperties":true,"uniqueKey":"results.items.[INDEX].profile.sections.accomplishments.oneOf.1.\\items.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"results.items.[INDEX].profile.sections.accomplishments.oneOf.1.\\items","typeLabel":"object[]"}},"additionalProperties":true,"uniqueKey":"results.items.[INDEX].profile.sections.accomplishments.oneOf.1","typeLabel":"object"}],"uniqueKey":"results.items.[INDEX].profile.sections.accomplishments","typeLabel":"null | object"},"controversies":{"oneOf":[{"type":"null","uniqueKey":"results.items.[INDEX].profile.sections.controversies.oneOf.0","typeLabel":"null"},{"type":"object","description":"A generated section with its items. Each item carries its content fields.","required":["items"],"properties":{"items":{"type":"array","items":{"type":"object","additionalProperties":true,"uniqueKey":"results.items.[INDEX].profile.sections.controversies.oneOf.1.\\items.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"results.items.[INDEX].profile.sections.controversies.oneOf.1.\\items","typeLabel":"object[]"}},"additionalProperties":true,"uniqueKey":"results.items.[INDEX].profile.sections.controversies.oneOf.1","typeLabel":"object"}],"uniqueKey":"results.items.[INDEX].profile.sections.controversies","typeLabel":"null | object"},"bestQualities":{"oneOf":[{"type":"null","uniqueKey":"results.items.[INDEX].profile.sections.bestQualities.oneOf.0","typeLabel":"null"},{"type":"object","description":"A generated section with its items. Each item carries its content fields.","required":["items"],"properties":{"items":{"type":"array","items":{"type":"object","additionalProperties":true,"uniqueKey":"results.items.[INDEX].profile.sections.bestQualities.oneOf.1.\\items.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"results.items.[INDEX].profile.sections.bestQualities.oneOf.1.\\items","typeLabel":"object[]"}},"additionalProperties":true,"uniqueKey":"results.items.[INDEX].profile.sections.bestQualities.oneOf.1","typeLabel":"object"}],"uniqueKey":"results.items.[INDEX].profile.sections.bestQualities","typeLabel":"null | object"},"netWorth":{"oneOf":[{"type":"null","uniqueKey":"results.items.[INDEX].profile.sections.netWorth.oneOf.0","typeLabel":"null"},{"type":"object","description":"A generated section with its items. Each item carries its content fields.","required":["items"],"properties":{"items":{"type":"array","items":{"type":"object","additionalProperties":true,"uniqueKey":"results.items.[INDEX].profile.sections.netWorth.oneOf.1.\\items.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"results.items.[INDEX].profile.sections.netWorth.oneOf.1.\\items","typeLabel":"object[]"}},"additionalProperties":true,"uniqueKey":"results.items.[INDEX].profile.sections.netWorth.oneOf.1","typeLabel":"object"}],"uniqueKey":"results.items.[INDEX].profile.sections.netWorth","typeLabel":"null | object"},"eventsTimeline":{"oneOf":[{"type":"null","uniqueKey":"results.items.[INDEX].profile.sections.eventsTimeline.oneOf.0","typeLabel":"null"},{"type":"object","description":"A generated section with its items. Each item carries its content fields.","required":["items"],"properties":{"items":{"type":"array","items":{"type":"object","additionalProperties":true,"uniqueKey":"results.items.[INDEX].profile.sections.eventsTimeline.oneOf.1.\\items.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"results.items.[INDEX].profile.sections.eventsTimeline.oneOf.1.\\items","typeLabel":"object[]"}},"additionalProperties":true,"uniqueKey":"results.items.[INDEX].profile.sections.eventsTimeline.oneOf.1","typeLabel":"object"}],"uniqueKey":"results.items.[INDEX].profile.sections.eventsTimeline","typeLabel":"null | object"},"portfolio":{"oneOf":[{"type":"null","uniqueKey":"results.items.[INDEX].profile.sections.portfolio.oneOf.0","typeLabel":"null"},{"type":"object","description":"A generated section with its items. Each item carries its content fields.","required":["items"],"properties":{"items":{"type":"array","items":{"type":"object","additionalProperties":true,"uniqueKey":"results.items.[INDEX].profile.sections.portfolio.oneOf.1.\\items.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"results.items.[INDEX].profile.sections.portfolio.oneOf.1.\\items","typeLabel":"object[]"}},"additionalProperties":true,"uniqueKey":"results.items.[INDEX].profile.sections.portfolio.oneOf.1","typeLabel":"object"}],"uniqueKey":"results.items.[INDEX].profile.sections.portfolio","typeLabel":"null | object"},"families":{"oneOf":[{"type":"null","uniqueKey":"results.items.[INDEX].profile.sections.families.oneOf.0","typeLabel":"null"},{"type":"object","description":"A generated section with its items. Each item carries its content fields.","required":["items"],"properties":{"items":{"type":"array","items":{"type":"object","additionalProperties":true,"uniqueKey":"results.items.[INDEX].profile.sections.families.oneOf.1.\\items.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"results.items.[INDEX].profile.sections.families.oneOf.1.\\items","typeLabel":"object[]"}},"additionalProperties":true,"uniqueKey":"results.items.[INDEX].profile.sections.families.oneOf.1","typeLabel":"object"}],"uniqueKey":"results.items.[INDEX].profile.sections.families","typeLabel":"null | object"},"researchPapers":{"type":"object","description":"A generated section with its items. Each item carries its content fields.","required":["items"],"additionalProperties":true,"properties":{"items":{"type":"array","items":{"type":"object","additionalProperties":true,"uniqueKey":"results.items.[INDEX].profile.sections.researchPapers.\\items.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"results.items.[INDEX].profile.sections.researchPapers.\\items","typeLabel":"object[]"}},"uniqueKey":"results.items.[INDEX].profile.sections.researchPapers","typeLabel":"object"},"githubRepos":{"type":"object","description":"A generated section with its items. Each item carries its content fields.","required":["items"],"additionalProperties":true,"properties":{"items":{"type":"array","items":{"type":"object","additionalProperties":true,"uniqueKey":"results.items.[INDEX].profile.sections.githubRepos.\\items.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"results.items.[INDEX].profile.sections.githubRepos.\\items","typeLabel":"object[]"}},"uniqueKey":"results.items.[INDEX].profile.sections.githubRepos","typeLabel":"object"},"mediaCredits":{"type":"object","description":"A generated section with its items. Each item carries its content fields.","required":["items"],"additionalProperties":true,"properties":{"items":{"type":"array","items":{"type":"object","additionalProperties":true,"uniqueKey":"results.items.[INDEX].profile.sections.mediaCredits.\\items.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"results.items.[INDEX].profile.sections.mediaCredits.\\items","typeLabel":"object[]"}},"uniqueKey":"results.items.[INDEX].profile.sections.mediaCredits","typeLabel":"object"},"musicCredits":{"type":"object","description":"A generated section with its items. Each item carries its content fields.","required":["items"],"additionalProperties":true,"properties":{"items":{"type":"array","items":{"type":"object","additionalProperties":true,"uniqueKey":"results.items.[INDEX].profile.sections.musicCredits.\\items.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"results.items.[INDEX].profile.sections.musicCredits.\\items","typeLabel":"object[]"}},"uniqueKey":"results.items.[INDEX].profile.sections.musicCredits","typeLabel":"object"},"books":{"type":"object","description":"A generated section with its items. Each item carries its content fields.","required":["items"],"additionalProperties":true,"properties":{"items":{"type":"array","items":{"type":"object","additionalProperties":true,"uniqueKey":"results.items.[INDEX].profile.sections.books.\\items.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"results.items.[INDEX].profile.sections.books.\\items","typeLabel":"object[]"}},"uniqueKey":"results.items.[INDEX].profile.sections.books","typeLabel":"object"}},"isRequired":true,"uniqueKey":"results.items.[INDEX].profile.sections","typeLabel":"object"},"displayName":{"type":"any","uniqueKey":"results.items.[INDEX].profile.displayName","typeLabel":"any"},"personName":{"type":"any","uniqueKey":"results.items.[INDEX].profile.personName","typeLabel":"any"},"aliases":{"type":"any","uniqueKey":"results.items.[INDEX].profile.aliases","typeLabel":"any"},"profileUrl":{"type":"any","uniqueKey":"results.items.[INDEX].profile.profileUrl","typeLabel":"any"},"slug":{"type":"any","uniqueKey":"results.items.[INDEX].profile.slug","typeLabel":"any"},"category":{"type":"any","uniqueKey":"results.items.[INDEX].profile.category","typeLabel":"any"},"location":{"type":"any","uniqueKey":"results.items.[INDEX].profile.location","typeLabel":"any"},"headline":{"type":"any","uniqueKey":"results.items.[INDEX].profile.headline","typeLabel":"any"},"emails":{"type":"any","uniqueKey":"results.items.[INDEX].profile.emails","typeLabel":"any"},"emailDetails":{"type":"array","description":"One summary for each published email address: its type, the employer behind the domain, and whether mail reaches it, when available.","items":{"type":"object","required":["email","type","typeBasis","verification"],"additionalProperties":true,"properties":{"email":{"type":"string","format":"email","isRequired":true,"uniqueKey":"results.items.[INDEX].profile.emailDetails.items.[INDEX].email","typeLabel":"string\u003cemail>"},"type":{"type":"string","enum":["personal","work","unknown"],"description":"`unknown` means the evidence on hand leaves the type open.","isRequired":true,"uniqueKey":"results.items.[INDEX].profile.emailDetails.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"typeBasis":{"type":"string","enum":["consumer_domain","provider_free_domain","employment_domain","employment_name","provider_employer_claim","role_address","academic_domain","conflicting_evidence","insufficient_evidence"],"description":"The evidence behind `type`.","isRequired":true,"uniqueKey":"results.items.[INDEX].profile.emailDetails.items.[INDEX].typeBasis","typeLabel":"enum\u003cstring>"},"verification":{"type":"object","required":["status"],"additionalProperties":true,"properties":{"status":{"type":"string","enum":["deliverable","undeliverable","risky","unverified"],"description":"`risky` means the domain accepts every address or the check was weak. `unverified` means the address was reported with no check.","isRequired":true,"uniqueKey":"results.items.[INDEX].profile.emailDetails.items.[INDEX].verification.status","typeLabel":"enum\u003cstring>"},"verifiedAt":{"type":"string","format":"date-time","description":"When the check ran.","uniqueKey":"results.items.[INDEX].profile.emailDetails.items.[INDEX].verification.verifiedAt","typeLabel":"string\u003cdate-time>"},"catchAllDomain":{"type":"boolean","description":"Whether the domain accepts every address.","uniqueKey":"results.items.[INDEX].profile.emailDetails.items.[INDEX].verification.catchAllDomain","typeLabel":"boolean"}},"isRequired":true,"uniqueKey":"results.items.[INDEX].profile.emailDetails.items.[INDEX].verification","typeLabel":"object"},"employer":{"type":"object","required":["association"],"additionalProperties":true,"description":"The company that owns the domain, when one is known.","properties":{"association":{"type":"string","enum":["current","former","unknown"],"description":"Whether the person still works at the company. `unknown` means a company was reported with no tenure.","isRequired":true,"uniqueKey":"results.items.[INDEX].profile.emailDetails.items.[INDEX].employer.association","typeLabel":"enum\u003cstring>"},"companyName":{"type":"string","uniqueKey":"results.items.[INDEX].profile.emailDetails.items.[INDEX].employer.companyName","typeLabel":"string"},"companyDomain":{"type":"string","uniqueKey":"results.items.[INDEX].profile.emailDetails.items.[INDEX].employer.companyDomain","typeLabel":"string"}},"uniqueKey":"results.items.[INDEX].profile.emailDetails.items.[INDEX].employer","typeLabel":"object"}},"uniqueKey":"results.items.[INDEX].profile.emailDetails.items.[INDEX]","typeLabel":"object"},"uniqueKey":"results.items.[INDEX].profile.emailDetails","typeLabel":"object[]"},"employmentDomains":{"type":"array","description":"Employer domains from the profile's employment history, with whether each role is current, when available.","items":{"type":"object","required":["isCurrent"],"additionalProperties":true,"properties":{"isCurrent":{"type":"boolean","description":"Whether this role is current.","isRequired":true,"uniqueKey":"results.items.[INDEX].profile.employmentDomains.items.[INDEX].isCurrent","typeLabel":"boolean"},"companyName":{"type":"string","uniqueKey":"results.items.[INDEX].profile.employmentDomains.items.[INDEX].companyName","typeLabel":"string"},"domain":{"type":"string","uniqueKey":"results.items.[INDEX].profile.employmentDomains.items.[INDEX].domain","typeLabel":"string"}},"uniqueKey":"results.items.[INDEX].profile.employmentDomains.items.[INDEX]","typeLabel":"object"},"uniqueKey":"results.items.[INDEX].profile.employmentDomains","typeLabel":"object[]"},"phoneNumbers":{"type":"any","uniqueKey":"results.items.[INDEX].profile.phoneNumbers","typeLabel":"any"},"phoneDetails":{"type":"array","description":"What providers reported about each phone number, when available.","items":{"type":"object","required":["phoneNumber","type"],"additionalProperties":true,"properties":{"phoneNumber":{"type":"string","isRequired":true,"uniqueKey":"results.items.[INDEX].profile.phoneDetails.items.[INDEX].phoneNumber","typeLabel":"string"},"type":{"type":"string","enum":["mobile","landline","voip","unknown"],"isRequired":true,"uniqueKey":"results.items.[INDEX].profile.phoneDetails.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"isConnected":{"type":"boolean","uniqueKey":"results.items.[INDEX].profile.phoneDetails.items.[INDEX].isConnected","typeLabel":"boolean"},"firstReported":{"type":"number","uniqueKey":"results.items.[INDEX].profile.phoneDetails.items.[INDEX].firstReported","typeLabel":"number"},"lastReported":{"type":"number","uniqueKey":"results.items.[INDEX].profile.phoneDetails.items.[INDEX].lastReported","typeLabel":"number"}},"uniqueKey":"results.items.[INDEX].profile.phoneDetails.items.[INDEX]","typeLabel":"object"},"uniqueKey":"results.items.[INDEX].profile.phoneDetails","typeLabel":"object[]"},"addresses":{"type":"any","uniqueKey":"results.items.[INDEX].profile.addresses","typeLabel":"any"}},"uniqueKey":"results.items.[INDEX].profile","typeLabel":"object"},"confidence":{"type":"number","minimum":0,"maximum":1,"description":"How well this result matches the search inputs, from 0 to 1. Each result is scored on its own. For a face search it includes how strongly the face matches this person.","uniqueKey":"results.items.[INDEX].confidence","typeLabel":"number"},"confidence_level":{"type":"string","enum":["low","medium","high"],"description":"`confidence` as a level: `high` from 0.75, `medium` from 0.35, and `low` below.","uniqueKey":"results.items.[INDEX].confidence_level","typeLabel":"enum\u003cstring>"},"confidence_status":{"type":"string","enum":["provisional","final"],"description":"`provisional` while the result list can still change, `final` once it is final.","uniqueKey":"results.items.[INDEX].confidence_status","typeLabel":"enum\u003cstring>"},"match_summary":{"type":"object","description":"The search inputs this result matches, partly matches, conflicts with, or has no data for.","properties":{"matches":{"type":"array","items":{"type":"object","required":["field","query"],"properties":{"field":{"type":"string","description":"The kind of input, such as `name`, `email`, `employment`, `location`, or `face`.","isRequired":true,"uniqueKey":"results.items.[INDEX].match_summary.matches.items.[INDEX].field","typeLabel":"string"},"query":{"type":"string","description":"The input as the search read it.","isRequired":true,"uniqueKey":"results.items.[INDEX].match_summary.matches.items.[INDEX].query","typeLabel":"string"},"candidate":{"type":"string","description":"The value on this result that Orbit compared with the input.","uniqueKey":"results.items.[INDEX].match_summary.matches.items.[INDEX].candidate","typeLabel":"string"},"outcome":{"type":"string","enum":["exact","equivalent","compatible","semantic"],"description":"How closely the value matches. Present on `matches` and `partial_matches`.","uniqueKey":"results.items.[INDEX].match_summary.matches.items.[INDEX].outcome","typeLabel":"enum\u003cstring>"},"evidence_level":{"type":"string","enum":["weak","moderate","strong"],"description":"How much this match adds to `confidence`.","uniqueKey":"results.items.[INDEX].match_summary.matches.items.[INDEX].evidence_level","typeLabel":"enum\u003cstring>"}},"uniqueKey":"results.items.[INDEX].match_summary.matches.items.[INDEX]","typeLabel":"object"},"uniqueKey":"results.items.[INDEX].match_summary.matches","typeLabel":"object[]"},"partial_matches":{"type":"array","items":{"type":"object","required":["field","query"],"properties":{"field":{"type":"string","description":"The kind of input, such as `name`, `email`, `employment`, `location`, or `face`.","isRequired":true,"uniqueKey":"results.items.[INDEX].match_summary.partial_matches.items.[INDEX].field","typeLabel":"string"},"query":{"type":"string","description":"The input as the search read it.","isRequired":true,"uniqueKey":"results.items.[INDEX].match_summary.partial_matches.items.[INDEX].query","typeLabel":"string"},"candidate":{"type":"string","description":"The value on this result that Orbit compared with the input.","uniqueKey":"results.items.[INDEX].match_summary.partial_matches.items.[INDEX].candidate","typeLabel":"string"},"outcome":{"type":"string","enum":["exact","equivalent","compatible","semantic"],"description":"How closely the value matches. Present on `matches` and `partial_matches`.","uniqueKey":"results.items.[INDEX].match_summary.partial_matches.items.[INDEX].outcome","typeLabel":"enum\u003cstring>"},"evidence_level":{"type":"string","enum":["weak","moderate","strong"],"description":"How much this match adds to `confidence`.","uniqueKey":"results.items.[INDEX].match_summary.partial_matches.items.[INDEX].evidence_level","typeLabel":"enum\u003cstring>"}},"uniqueKey":"results.items.[INDEX].match_summary.partial_matches.items.[INDEX]","typeLabel":"object"},"uniqueKey":"results.items.[INDEX].match_summary.partial_matches","typeLabel":"object[]"},"apparent_conflicts":{"type":"array","items":{"type":"object","required":["field","query"],"properties":{"field":{"type":"string","description":"The kind of input, such as `name`, `email`, `employment`, `location`, or `face`.","isRequired":true,"uniqueKey":"results.items.[INDEX].match_summary.apparent_conflicts.items.[INDEX].field","typeLabel":"string"},"query":{"type":"string","description":"The input as the search read it.","isRequired":true,"uniqueKey":"results.items.[INDEX].match_summary.apparent_conflicts.items.[INDEX].query","typeLabel":"string"},"candidate":{"type":"string","description":"The value on this result that Orbit compared with the input.","uniqueKey":"results.items.[INDEX].match_summary.apparent_conflicts.items.[INDEX].candidate","typeLabel":"string"},"outcome":{"type":"string","enum":["exact","equivalent","compatible","semantic"],"description":"How closely the value matches. Present on `matches` and `partial_matches`.","uniqueKey":"results.items.[INDEX].match_summary.apparent_conflicts.items.[INDEX].outcome","typeLabel":"enum\u003cstring>"},"evidence_level":{"type":"string","enum":["weak","moderate","strong"],"description":"How much this match adds to `confidence`.","uniqueKey":"results.items.[INDEX].match_summary.apparent_conflicts.items.[INDEX].evidence_level","typeLabel":"enum\u003cstring>"}},"uniqueKey":"results.items.[INDEX].match_summary.apparent_conflicts.items.[INDEX]","typeLabel":"object"},"uniqueKey":"results.items.[INDEX].match_summary.apparent_conflicts","typeLabel":"object[]"},"unknown":{"type":"array","items":{"type":"object","required":["field","query"],"properties":{"field":{"type":"string","description":"The kind of input, such as `name`, `email`, `employment`, `location`, or `face`.","isRequired":true,"uniqueKey":"results.items.[INDEX].match_summary.unknown.items.[INDEX].field","typeLabel":"string"},"query":{"type":"string","description":"The input as the search read it.","isRequired":true,"uniqueKey":"results.items.[INDEX].match_summary.unknown.items.[INDEX].query","typeLabel":"string"},"candidate":{"type":"string","description":"The value on this result that Orbit compared with the input.","uniqueKey":"results.items.[INDEX].match_summary.unknown.items.[INDEX].candidate","typeLabel":"string"},"outcome":{"type":"string","enum":["exact","equivalent","compatible","semantic"],"description":"How closely the value matches. Present on `matches` and `partial_matches`.","uniqueKey":"results.items.[INDEX].match_summary.unknown.items.[INDEX].outcome","typeLabel":"enum\u003cstring>"},"evidence_level":{"type":"string","enum":["weak","moderate","strong"],"description":"How much this match adds to `confidence`.","uniqueKey":"results.items.[INDEX].match_summary.unknown.items.[INDEX].evidence_level","typeLabel":"enum\u003cstring>"}},"uniqueKey":"results.items.[INDEX].match_summary.unknown.items.[INDEX]","typeLabel":"object"},"uniqueKey":"results.items.[INDEX].match_summary.unknown","typeLabel":"object[]"}},"uniqueKey":"results.items.[INDEX].match_summary","typeLabel":"object"},"failure":{"type":"object","required":["code","message","retryable","reason"],"properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"results.items.[INDEX].failure.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"results.items.[INDEX].failure.message","typeLabel":"string"},"retryable":{"type":"boolean","isRequired":true,"uniqueKey":"results.items.[INDEX].failure.retryable","typeLabel":"boolean"},"reason":{"type":"string","isRequired":true,"uniqueKey":"results.items.[INDEX].failure.reason","typeLabel":"string"},"suggested_inputs":{"type":"array","items":{"type":"string","uniqueKey":"results.items.[INDEX].failure.suggested_inputs.items.[INDEX]","typeLabel":"string"},"uniqueKey":"results.items.[INDEX].failure.suggested_inputs","typeLabel":"string[]"}},"uniqueKey":"results.items.[INDEX].failure","typeLabel":"object"}},"uniqueKey":"results.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"results","typeLabel":"object[]"},"created_at":{"type":"string","format":"date-time","description":"When the search was created.","isRequired":true,"uniqueKey":"created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","description":"When the snapshot last changed.","isRequired":true,"uniqueKey":"updated_at","typeLabel":"string\u003cdate-time>"},"links":{"type":"object","required":["status"],"properties":{"status":{"type":"string","description":"Relative URL for the search status endpoint.","isRequired":true,"uniqueKey":"links.status","typeLabel":"string"}},"isRequired":true,"uniqueKey":"links","typeLabel":"object"},"candidate_discovery_completed":{"type":"boolean","description":"Whether the result list is final. Once true, discovery adds no more results to this search; the results themselves can still be generating or enriching toward the requested depth. For discovery searches this becomes true when clustering completes and every discovered person appears in results. If discovery failed, candidate_discovery_failure explains why. Present only when candidate_discovery is true.","uniqueKey":"candidate_discovery_completed","typeLabel":"boolean"},"provider_results_final":{"type":"boolean","description":"Whether the people-data provider lookup for a supplied phone, email, or address returned its complete owner set. Once true, every owner of that contact is in results with the contacts the provider reported, usually within the first response and before biography work. Discovery by name can still add results until candidate_discovery_completed is true. Present only when candidate_discovery is true and the request carried a phone, email, or address signal.","uniqueKey":"provider_results_final","typeLabel":"boolean"},"confidence_kind":{"type":"string","enum":["identity","criteria"],"description":"`identity` when the search looks for one person, such as by name, contact, or face, and `criteria` when it looks for everyone who fits a description.","uniqueKey":"confidence_kind","typeLabel":"enum\u003cstring>"},"none_of_above_confidence":{"type":"number","minimum":0,"maximum":1,"description":"One minus the best result's `confidence`. It is high when no result matches well. Present on `identity` searches.","uniqueKey":"none_of_above_confidence","typeLabel":"number"},"discovered_sources":{"type":"array","description":"Every page the search has found, in the order the search first found each one. The list starts filling within seconds and holds up to 200 pages. A page stays listed through later polls and after the search ends, including a page Candidate Discovery assigned to a result. Present when candidate_discovery is true.","items":{"type":"object","additionalProperties":false,"required":["link","title","sourceImage"],"properties":{"link":{"type":"string","format":"uri","description":"URL of the discovered source page.","isRequired":true,"uniqueKey":"discovered_sources.items.[INDEX].link","typeLabel":"string\u003curi>"},"title":{"type":"string","description":"Display title of the source page or site.","isRequired":true,"uniqueKey":"discovered_sources.items.[INDEX].title","typeLabel":"string"},"sourceImage":{"type":"string","format":"uri","description":"URL of the favicon for the site that hosts the source page.","isRequired":true,"uniqueKey":"discovered_sources.items.[INDEX].sourceImage","typeLabel":"string\u003curi>"},"face_match":{"type":"object","description":"Present on a face search for each page the search found a face on. A page with `kept` true is a page of the picked face, and a confirmed page is a strong match. A page with `kept` false shows another face that looks alike.","required":["score","confirmed"],"properties":{"score":{"type":"number","minimum":0,"maximum":1,"description":"How alike the face on this page and the picked face are, from 0 to 1.","isRequired":true,"uniqueKey":"discovered_sources.items.[INDEX].face_match.score","typeLabel":"number"},"confirmed":{"type":"boolean","description":"Whether the score is high enough to confirm the same person.","isRequired":true,"uniqueKey":"discovered_sources.items.[INDEX].face_match.confirmed","typeLabel":"boolean"},"kept":{"type":"boolean","description":"Whether the search counts this page as a page of the picked face. A page with `kept` false shows another face that looks alike and is listed in `discovered_sources` only.","uniqueKey":"discovered_sources.items.[INDEX].face_match.kept","typeLabel":"boolean"},"thumbnail":{"type":"string","description":"A small image of the face found on the page, as a `data:` URL.","uniqueKey":"discovered_sources.items.[INDEX].face_match.thumbnail","typeLabel":"string"}},"uniqueKey":"discovered_sources.items.[INDEX].face_match","typeLabel":"object"}},"uniqueKey":"discovered_sources.items.[INDEX]","typeLabel":"object"},"uniqueKey":"discovered_sources","typeLabel":"object[]"},"candidate_discovery_failure":{"type":"object","required":["code","message","retryable","reason"],"properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"candidate_discovery_failure.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"candidate_discovery_failure.message","typeLabel":"string"},"retryable":{"type":"boolean","isRequired":true,"uniqueKey":"candidate_discovery_failure.retryable","typeLabel":"boolean"},"reason":{"type":"string","isRequired":true,"uniqueKey":"candidate_discovery_failure.reason","typeLabel":"string"},"suggested_inputs":{"type":"array","items":{"type":"string","uniqueKey":"candidate_discovery_failure.suggested_inputs.items.[INDEX]","typeLabel":"string"},"uniqueKey":"candidate_discovery_failure.suggested_inputs","typeLabel":"string[]"}},"description":"Why candidate discovery failed. Present only when discovery failed.","uniqueKey":"candidate_discovery_failure","typeLabel":"object"},"population":{"type":"object","required":["kind","id","name","size","profile_depth","credits_quoted","status"],"description":"Present on population searches: the subject, the depth, the reserved credits and where the search is.","properties":{"kind":{"type":"string","enum":["company","school"],"isRequired":true,"uniqueKey":"population.kind","typeLabel":"enum\u003cstring>"},"id":{"type":"string","isRequired":true,"uniqueKey":"population.id","typeLabel":"string"},"name":{"type":"string","isRequired":true,"uniqueKey":"population.name","typeLabel":"string"},"size":{"oneOf":[{"type":"integer","description":"The population's size as given, or null.","isRequired":true,"uniqueKey":"population.size.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The population's size as given, or null.","isRequired":true,"uniqueKey":"population.size.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"population.size","typeLabel":"integer | null"},"profile_depth":{"type":"string","enum":["quick","partial","full"],"description":"The depth every person is built to.","isRequired":true,"uniqueKey":"population.profile_depth","typeLabel":"enum\u003cstring>"},"credits_quoted":{"type":"integer","description":"The credits reserved when the search started.","isRequired":true,"uniqueKey":"population.credits_quoted","typeLabel":"integer"},"status":{"type":"string","enum":["running","completed","completed_with_errors","failed","cancelled"],"description":"Where the population search is. The search's own status is running while this is running, completed when this is completed, and completed_with_errors when this is completed_with_errors, failed or cancelled.","isRequired":true,"uniqueKey":"population.status","typeLabel":"enum\u003cstring>"}},"uniqueKey":"population","typeLabel":"object"},"query_intent":{"type":"object","description":"Present when the search parsed a plain-English query.","required":["organizations","schools","person_named"],"properties":{"organizations":{"type":"array","items":{"type":"string","uniqueKey":"query_intent.organizations.items.[INDEX]","typeLabel":"string"},"description":"The companies the query names.","isRequired":true,"uniqueKey":"query_intent.organizations","typeLabel":"string[]"},"schools":{"type":"array","items":{"type":"string","uniqueKey":"query_intent.schools.items.[INDEX]","typeLabel":"string"},"description":"The schools the query names.","isRequired":true,"uniqueKey":"query_intent.schools","typeLabel":"string[]"},"person_named":{"type":"boolean","description":"Whether the query names a specific person.","isRequired":true,"uniqueKey":"query_intent.person_named","typeLabel":"boolean"}},"uniqueKey":"query_intent","typeLabel":"object"},"billing":{"type":"object","description":"Credits held and spent for this search. The final consumedCredits is the full charge once status is settled.","required":["id","pricingVersion","reservedCredits","consumedCredits","releasedCredits","heldCredits","status"],"properties":{"id":{"type":"string","format":"uuid","description":"The billing operation behind this request.","isRequired":true,"uniqueKey":"billing.id","typeLabel":"string\u003cuuid>"},"pricingVersion":{"type":"string","description":"The pricing catalog version this operation settles under.","isRequired":true,"uniqueKey":"billing.pricingVersion","typeLabel":"string"},"reservedCredits":{"type":"integer","minimum":0,"description":"The credits held for this operation.","isRequired":true,"uniqueKey":"billing.reservedCredits","typeLabel":"integer"},"consumedCredits":{"type":"integer","minimum":0,"description":"The credits charged so far.","isRequired":true,"uniqueKey":"billing.consumedCredits","typeLabel":"integer"},"releasedCredits":{"type":"integer","minimum":0,"description":"The credits returned to your balance.","isRequired":true,"uniqueKey":"billing.releasedCredits","typeLabel":"integer"},"heldCredits":{"type":"integer","minimum":0,"description":"The credits still held: reservedCredits less consumedCredits and releasedCredits.","isRequired":true,"uniqueKey":"billing.heldCredits","typeLabel":"integer"},"status":{"type":"string","enum":["open","settled"],"description":"open while the operation can still charge, and settled once its charge is final.","isRequired":true,"uniqueKey":"billing.status","typeLabel":"enum\u003cstring>"}},"uniqueKey":"billing","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"search_id":"\u003cstring>","request_id":"\u003cstring>","status":"running","candidate_discovery":true,"profile_depth":"quick","include_profile":true,"profile_upgrades_completed":true,"results":[{"profile_id":"\u003cstring>","status":"generating","generation_level":2,"sources":["search"],"candidate_sources":[{"link":"\u003cstring>","title":"\u003cstring>","sourceImage":"\u003cstring>","face_match":{"score":0.5,"confirmed":true,"kept":true,"thumbnail":"\u003cstring>"}}],"preview":{},"profile":{"id":"\u003cunknown>","generationLevel":"\u003cunknown>","avatarUrl":"\u003cunknown>","verified":"\u003cunknown>","sections":{"socials":{"items":[{}]},"bio":{"bio":"\u003cstring>"},"basic":{"items":[{}]},"personalLife":{"items":[{}]},"jobs":{"items":[{}]},"education":{"items":[{}]},"passions":{"items":[{}]},"worldview":{"items":[{}]},"accomplishments":{"items":[{}]},"controversies":{"items":[{}]},"bestQualities":{"items":[{}]},"netWorth":{"items":[{}]},"eventsTimeline":{"items":[{}]},"portfolio":{"items":[{}]},"families":{"items":[{}]},"researchPapers":{"items":[{}]},"githubRepos":{"items":[{}]},"mediaCredits":{"items":[{}]},"musicCredits":{"items":[{}]},"books":{"items":[{}]}},"displayName":"\u003cunknown>","personName":"\u003cunknown>","aliases":"\u003cunknown>","profileUrl":"\u003cunknown>","slug":"\u003cunknown>","category":"\u003cunknown>","location":"\u003cunknown>","headline":"\u003cunknown>","emails":"\u003cunknown>","emailDetails":[{"email":"jsmith@example.com","type":"personal","typeBasis":"consumer_domain","verification":{"status":"deliverable","verifiedAt":"2023-11-07T05:31:56Z","catchAllDomain":true},"employer":{"association":"current","companyName":"\u003cstring>","companyDomain":"\u003cstring>"}}],"employmentDomains":[{"isCurrent":true,"companyName":"\u003cstring>","domain":"\u003cstring>"}],"phoneNumbers":"\u003cunknown>","phoneDetails":[{"phoneNumber":"\u003cstring>","type":"mobile","isConnected":true,"firstReported":123,"lastReported":123}],"addresses":"\u003cunknown>"},"confidence":0.5,"confidence_level":"low","confidence_status":"provisional","match_summary":{"matches":[{"field":"\u003cstring>","query":"\u003cstring>","candidate":"\u003cstring>","outcome":"exact","evidence_level":"weak"}],"partial_matches":[{"field":"\u003cstring>","query":"\u003cstring>","candidate":"\u003cstring>","outcome":"exact","evidence_level":"weak"}],"apparent_conflicts":[{"field":"\u003cstring>","query":"\u003cstring>","candidate":"\u003cstring>","outcome":"exact","evidence_level":"weak"}],"unknown":[{"field":"\u003cstring>","query":"\u003cstring>","candidate":"\u003cstring>","outcome":"exact","evidence_level":"weak"}]},"failure":{"code":"\u003cstring>","message":"\u003cstring>","retryable":true,"reason":"\u003cstring>","suggested_inputs":["\u003cstring>"]}}],"created_at":"2023-11-07T05:31:56Z","updated_at":"2023-11-07T05:31:56Z","links":{"status":"\u003cstring>"},"candidate_discovery_completed":true,"provider_results_final":true,"confidence_kind":"identity","none_of_above_confidence":0.5,"discovered_sources":[{"link":"\u003cstring>","title":"\u003cstring>","sourceImage":"\u003cstring>","face_match":{"score":0.5,"confirmed":true,"kept":true,"thumbnail":"\u003cstring>"}}],"candidate_discovery_failure":{"code":"\u003cstring>","message":"\u003cstring>","retryable":true,"reason":"\u003cstring>","suggested_inputs":["\u003cstring>"]},"population":{"kind":"company","id":"\u003cstring>","name":"\u003cstring>","size":123,"profile_depth":"quick","credits_quoted":123,"status":"running"},"query_intent":{"organizations":["\u003cstring>"],"schools":["\u003cstring>"],"person_named":true},"billing":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","pricingVersion":"\u003cstring>","reservedCredits":1,"consumedCredits":1,"releasedCredits":1,"heldCredits":1,"status":"open"}}}},"exampleType":"generated"}},"exampleType":"generated"},"e21f9302-8617-4efc-9be5-749db9a632f4":{"description":"The search is running. Poll GET /v3/search/{search_id}.","content":{"application/json":{"schema":{"type":"object","required":["search_id","request_id","status","candidate_discovery","profile_depth","include_profile","profile_upgrades_completed","results","created_at","updated_at","links"],"properties":{"search_id":{"type":"string","description":"Server-generated identifier for this search. Use it to poll the status endpoint.","isRequired":true,"uniqueKey":"search_id","typeLabel":"string"},"request_id":{"type":"string","description":"The idempotency key from the original request, or a generated value when the request omitted it.","isRequired":true,"uniqueKey":"request_id","typeLabel":"string"},"status":{"type":"string","description":"Overall search lifecycle. `running` means work is still in progress; poll until the status is terminal. `completed` means every result reached the requested profile depth; a search can complete with an empty results list when nothing matched. `completed_with_errors` means ready results are available but some work failed. `failed` means work failed and no ready results are available.","enum":["running","completed","completed_with_errors","failed"],"isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"candidate_discovery":{"type":"boolean","description":"Whether this search runs candidate discovery, as resolved from the request.","isRequired":true,"uniqueKey":"candidate_discovery","typeLabel":"boolean"},"profile_depth":{"type":"string","description":"The minimum profile depth requested for each ready result.","enum":["quick","partial","full"],"isRequired":true,"uniqueKey":"profile_depth","typeLabel":"enum\u003cstring>"},"include_profile":{"type":"boolean","description":"Whether readable results embed their Search profile.","isRequired":true,"uniqueKey":"include_profile","typeLabel":"boolean"},"profile_upgrades_completed":{"type":"boolean","description":"Whether every result in results has reached the requested profile_depth or failed. While candidate_discovery_completed is false, discovery can still add results with new profile work.","isRequired":true,"uniqueKey":"profile_upgrades_completed","typeLabel":"boolean"},"results":{"type":"array","description":"The people this search has found so far. Results are append-only: a reported result is never removed, and a ready result never regresses.","items":{"type":"object","required":["profile_id","status","generation_level","sources"],"properties":{"profile_id":{"type":"string","description":"Stable identifier for this person. Use it with the profile endpoints.","isRequired":true,"uniqueKey":"results.items.[INDEX].profile_id","typeLabel":"string"},"status":{"type":"string","description":"Result lifecycle. `generating` means candidate discovery found this person but no readable profile exists yet; it appears only on candidate discovery results. `enriching` means a readable profile exists but is below the requested depth. `ready` means the profile reached the requested profile_depth. `failed` means this result cannot reach the requested depth; failure explains why. Statuses only move forward.","enum":["generating","enriching","ready","failed"],"isRequired":true,"uniqueKey":"results.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"generation_level":{"oneOf":[{"type":"integer","description":"The stored generation level of this profile: 1 contains Orbit identity data, 2 adds LinkedIn enrichment, 3 adds web, social, and OSINT enrichment. A `quick` depth requires at least level 1, a `partial` depth requires at least level 2, and a `full` depth requires level 3. Null until the profile is first published.","minimum":1,"isRequired":true,"uniqueKey":"results.items.[INDEX].generation_level.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The stored generation level of this profile: 1 contains Orbit identity data, 2 adds LinkedIn enrichment, 3 adds web, social, and OSINT enrichment. A `quick` depth requires at least level 1, a `partial` depth requires at least level 2, and a `full` depth requires level 3. Null until the profile is first published.","isRequired":true,"uniqueKey":"results.items.[INDEX].generation_level.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"results.items.[INDEX].generation_level","typeLabel":"integer | null"},"sources":{"type":"array","description":"The origins that produced this result. This field does not contain source receipts.","items":{"type":"string","enum":["search","candidate_discovery"],"uniqueKey":"results.items.[INDEX].sources.items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":true,"uniqueKey":"results.items.[INDEX].sources","typeLabel":"enum\u003cstring>[]"},"candidate_sources":{"type":"array","description":"The person's source pages, present with either `include_profile` value. The pages Candidate Discovery assigned to this result come first and stay stable when the result becomes ready; each of them is also listed in `discovered_sources`. The other pages Orbit holds for the person follow, up to 200 pages in all.","items":{"type":"object","additionalProperties":false,"required":["link","title","sourceImage"],"properties":{"link":{"type":"string","format":"uri","description":"URL of the discovered source page.","isRequired":true,"uniqueKey":"results.items.[INDEX].candidate_sources.items.[INDEX].link","typeLabel":"string\u003curi>"},"title":{"type":"string","description":"Display title of the source page or site.","isRequired":true,"uniqueKey":"results.items.[INDEX].candidate_sources.items.[INDEX].title","typeLabel":"string"},"sourceImage":{"type":"string","format":"uri","description":"URL of the favicon for the site that hosts the source page.","isRequired":true,"uniqueKey":"results.items.[INDEX].candidate_sources.items.[INDEX].sourceImage","typeLabel":"string\u003curi>"},"face_match":{"type":"object","description":"Present on a face search for each page the search found a face on. A page with `kept` true is a page of the picked face, and a confirmed page is a strong match. A page with `kept` false shows another face that looks alike.","required":["score","confirmed"],"properties":{"score":{"type":"number","minimum":0,"maximum":1,"description":"How alike the face on this page and the picked face are, from 0 to 1.","isRequired":true,"uniqueKey":"results.items.[INDEX].candidate_sources.items.[INDEX].face_match.score","typeLabel":"number"},"confirmed":{"type":"boolean","description":"Whether the score is high enough to confirm the same person.","isRequired":true,"uniqueKey":"results.items.[INDEX].candidate_sources.items.[INDEX].face_match.confirmed","typeLabel":"boolean"},"kept":{"type":"boolean","description":"Whether the search counts this page as a page of the picked face. A page with `kept` false shows another face that looks alike and is listed in `discovered_sources` only.","uniqueKey":"results.items.[INDEX].candidate_sources.items.[INDEX].face_match.kept","typeLabel":"boolean"},"thumbnail":{"type":"string","description":"A small image of the face found on the page, as a `data:` URL.","uniqueKey":"results.items.[INDEX].candidate_sources.items.[INDEX].face_match.thumbnail","typeLabel":"string"}},"uniqueKey":"results.items.[INDEX].candidate_sources.items.[INDEX].face_match","typeLabel":"object"}},"uniqueKey":"results.items.[INDEX].candidate_sources.items.[INDEX]","typeLabel":"object"},"uniqueKey":"results.items.[INDEX].candidate_sources","typeLabel":"object[]"},"preview":{"type":"object","additionalProperties":true,"description":"Lightweight search preview built from the data Search returned for this person, such as name, avatar, location, headline, and generation level. Known-search results carry it with either include_profile value.","uniqueKey":"results.items.[INDEX].preview","typeLabel":"object"},"profile":{"type":"object","description":"The profile embedded in a readable result when include_profile is true: identity fields, contact fields, and generated sections. Read GET /v3/enrich/{profile_id} for the image gallery and source links.","required":["id","generationLevel","avatarUrl","verified","sections"],"additionalProperties":true,"properties":{"id":{"type":"any","isRequired":true,"uniqueKey":"results.items.[INDEX].profile.id","typeLabel":"any"},"generationLevel":{"type":"any","isRequired":true,"uniqueKey":"results.items.[INDEX].profile.generationLevel","typeLabel":"any"},"avatarUrl":{"type":"any","isRequired":true,"uniqueKey":"results.items.[INDEX].profile.avatarUrl","typeLabel":"any"},"verified":{"type":"any","isRequired":true,"uniqueKey":"results.items.[INDEX].profile.verified","typeLabel":"any"},"sections":{"type":"object","description":"Generated profile sections, such as bio, jobs, and education. Each section carries its content fields. Read GET /v3/enrich/{profile_id} for the image gallery and source links.","required":["socials"],"properties":{"socials":{"type":"object","description":"A generated section with its items. Each item carries its content fields.","required":["items"],"additionalProperties":true,"properties":{"items":{"type":"array","items":{"type":"object","additionalProperties":true,"uniqueKey":"results.items.[INDEX].profile.sections.socials.\\items.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"results.items.[INDEX].profile.sections.socials.\\items","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"results.items.[INDEX].profile.sections.socials","typeLabel":"object"},"bio":{"oneOf":[{"type":"null","uniqueKey":"results.items.[INDEX].profile.sections.bio.oneOf.0","typeLabel":"null"},{"type":"object","description":"The generated bio text.","required":["bio"],"properties":{"bio":{"type":"string","isRequired":true,"uniqueKey":"results.items.[INDEX].profile.sections.bio.oneOf.1.bio","typeLabel":"string"}},"additionalProperties":true,"uniqueKey":"results.items.[INDEX].profile.sections.bio.oneOf.1","typeLabel":"object"}],"uniqueKey":"results.items.[INDEX].profile.sections.bio","typeLabel":"null | object"},"basic":{"oneOf":[{"type":"null","uniqueKey":"results.items.[INDEX].profile.sections.basic.oneOf.0","typeLabel":"null"},{"type":"object","description":"A generated section with its items. Each item carries its content fields.","required":["items"],"properties":{"items":{"type":"array","items":{"type":"object","additionalProperties":true,"uniqueKey":"results.items.[INDEX].profile.sections.basic.oneOf.1.\\items.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"results.items.[INDEX].profile.sections.basic.oneOf.1.\\items","typeLabel":"object[]"}},"additionalProperties":true,"uniqueKey":"results.items.[INDEX].profile.sections.basic.oneOf.1","typeLabel":"object"}],"uniqueKey":"results.items.[INDEX].profile.sections.basic","typeLabel":"null | object"},"personalLife":{"oneOf":[{"type":"null","uniqueKey":"results.items.[INDEX].profile.sections.personalLife.oneOf.0","typeLabel":"null"},{"type":"object","description":"A generated section with its items. Each item carries its content fields.","required":["items"],"properties":{"items":{"type":"array","items":{"type":"object","additionalProperties":true,"uniqueKey":"results.items.[INDEX].profile.sections.personalLife.oneOf.1.\\items.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"results.items.[INDEX].profile.sections.personalLife.oneOf.1.\\items","typeLabel":"object[]"}},"additionalProperties":true,"uniqueKey":"results.items.[INDEX].profile.sections.personalLife.oneOf.1","typeLabel":"object"}],"uniqueKey":"results.items.[INDEX].profile.sections.personalLife","typeLabel":"null | object"},"jobs":{"oneOf":[{"type":"null","uniqueKey":"results.items.[INDEX].profile.sections.jobs.oneOf.0","typeLabel":"null"},{"type":"object","description":"A generated section with its items. Each item carries its content fields.","required":["items"],"properties":{"items":{"type":"array","items":{"type":"object","additionalProperties":true,"uniqueKey":"results.items.[INDEX].profile.sections.jobs.oneOf.1.\\items.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"results.items.[INDEX].profile.sections.jobs.oneOf.1.\\items","typeLabel":"object[]"}},"additionalProperties":true,"uniqueKey":"results.items.[INDEX].profile.sections.jobs.oneOf.1","typeLabel":"object"}],"uniqueKey":"results.items.[INDEX].profile.sections.jobs","typeLabel":"null | object"},"education":{"oneOf":[{"type":"null","uniqueKey":"results.items.[INDEX].profile.sections.education.oneOf.0","typeLabel":"null"},{"type":"object","description":"A generated section with its items. Each item carries its content fields.","required":["items"],"properties":{"items":{"type":"array","items":{"type":"object","additionalProperties":true,"uniqueKey":"results.items.[INDEX].profile.sections.education.oneOf.1.\\items.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"results.items.[INDEX].profile.sections.education.oneOf.1.\\items","typeLabel":"object[]"}},"additionalProperties":true,"uniqueKey":"results.items.[INDEX].profile.sections.education.oneOf.1","typeLabel":"object"}],"uniqueKey":"results.items.[INDEX].profile.sections.education","typeLabel":"null | object"},"passions":{"oneOf":[{"type":"null","uniqueKey":"results.items.[INDEX].profile.sections.passions.oneOf.0","typeLabel":"null"},{"type":"object","description":"A generated section with its items. Each item carries its content fields.","required":["items"],"properties":{"items":{"type":"array","items":{"type":"object","additionalProperties":true,"uniqueKey":"results.items.[INDEX].profile.sections.passions.oneOf.1.\\items.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"results.items.[INDEX].profile.sections.passions.oneOf.1.\\items","typeLabel":"object[]"}},"additionalProperties":true,"uniqueKey":"results.items.[INDEX].profile.sections.passions.oneOf.1","typeLabel":"object"}],"uniqueKey":"results.items.[INDEX].profile.sections.passions","typeLabel":"null | object"},"worldview":{"oneOf":[{"type":"null","uniqueKey":"results.items.[INDEX].profile.sections.worldview.oneOf.0","typeLabel":"null"},{"type":"object","description":"A generated section with its items. Each item carries its content fields.","required":["items"],"properties":{"items":{"type":"array","items":{"type":"object","additionalProperties":true,"uniqueKey":"results.items.[INDEX].profile.sections.worldview.oneOf.1.\\items.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"results.items.[INDEX].profile.sections.worldview.oneOf.1.\\items","typeLabel":"object[]"}},"additionalProperties":true,"uniqueKey":"results.items.[INDEX].profile.sections.worldview.oneOf.1","typeLabel":"object"}],"uniqueKey":"results.items.[INDEX].profile.sections.worldview","typeLabel":"null | object"},"accomplishments":{"oneOf":[{"type":"null","uniqueKey":"results.items.[INDEX].profile.sections.accomplishments.oneOf.0","typeLabel":"null"},{"type":"object","description":"A generated section with its items. Each item carries its content fields.","required":["items"],"properties":{"items":{"type":"array","items":{"type":"object","additionalProperties":true,"uniqueKey":"results.items.[INDEX].profile.sections.accomplishments.oneOf.1.\\items.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"results.items.[INDEX].profile.sections.accomplishments.oneOf.1.\\items","typeLabel":"object[]"}},"additionalProperties":true,"uniqueKey":"results.items.[INDEX].profile.sections.accomplishments.oneOf.1","typeLabel":"object"}],"uniqueKey":"results.items.[INDEX].profile.sections.accomplishments","typeLabel":"null | object"},"controversies":{"oneOf":[{"type":"null","uniqueKey":"results.items.[INDEX].profile.sections.controversies.oneOf.0","typeLabel":"null"},{"type":"object","description":"A generated section with its items. Each item carries its content fields.","required":["items"],"properties":{"items":{"type":"array","items":{"type":"object","additionalProperties":true,"uniqueKey":"results.items.[INDEX].profile.sections.controversies.oneOf.1.\\items.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"results.items.[INDEX].profile.sections.controversies.oneOf.1.\\items","typeLabel":"object[]"}},"additionalProperties":true,"uniqueKey":"results.items.[INDEX].profile.sections.controversies.oneOf.1","typeLabel":"object"}],"uniqueKey":"results.items.[INDEX].profile.sections.controversies","typeLabel":"null | object"},"bestQualities":{"oneOf":[{"type":"null","uniqueKey":"results.items.[INDEX].profile.sections.bestQualities.oneOf.0","typeLabel":"null"},{"type":"object","description":"A generated section with its items. Each item carries its content fields.","required":["items"],"properties":{"items":{"type":"array","items":{"type":"object","additionalProperties":true,"uniqueKey":"results.items.[INDEX].profile.sections.bestQualities.oneOf.1.\\items.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"results.items.[INDEX].profile.sections.bestQualities.oneOf.1.\\items","typeLabel":"object[]"}},"additionalProperties":true,"uniqueKey":"results.items.[INDEX].profile.sections.bestQualities.oneOf.1","typeLabel":"object"}],"uniqueKey":"results.items.[INDEX].profile.sections.bestQualities","typeLabel":"null | object"},"netWorth":{"oneOf":[{"type":"null","uniqueKey":"results.items.[INDEX].profile.sections.netWorth.oneOf.0","typeLabel":"null"},{"type":"object","description":"A generated section with its items. Each item carries its content fields.","required":["items"],"properties":{"items":{"type":"array","items":{"type":"object","additionalProperties":true,"uniqueKey":"results.items.[INDEX].profile.sections.netWorth.oneOf.1.\\items.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"results.items.[INDEX].profile.sections.netWorth.oneOf.1.\\items","typeLabel":"object[]"}},"additionalProperties":true,"uniqueKey":"results.items.[INDEX].profile.sections.netWorth.oneOf.1","typeLabel":"object"}],"uniqueKey":"results.items.[INDEX].profile.sections.netWorth","typeLabel":"null | object"},"eventsTimeline":{"oneOf":[{"type":"null","uniqueKey":"results.items.[INDEX].profile.sections.eventsTimeline.oneOf.0","typeLabel":"null"},{"type":"object","description":"A generated section with its items. Each item carries its content fields.","required":["items"],"properties":{"items":{"type":"array","items":{"type":"object","additionalProperties":true,"uniqueKey":"results.items.[INDEX].profile.sections.eventsTimeline.oneOf.1.\\items.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"results.items.[INDEX].profile.sections.eventsTimeline.oneOf.1.\\items","typeLabel":"object[]"}},"additionalProperties":true,"uniqueKey":"results.items.[INDEX].profile.sections.eventsTimeline.oneOf.1","typeLabel":"object"}],"uniqueKey":"results.items.[INDEX].profile.sections.eventsTimeline","typeLabel":"null | object"},"portfolio":{"oneOf":[{"type":"null","uniqueKey":"results.items.[INDEX].profile.sections.portfolio.oneOf.0","typeLabel":"null"},{"type":"object","description":"A generated section with its items. Each item carries its content fields.","required":["items"],"properties":{"items":{"type":"array","items":{"type":"object","additionalProperties":true,"uniqueKey":"results.items.[INDEX].profile.sections.portfolio.oneOf.1.\\items.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"results.items.[INDEX].profile.sections.portfolio.oneOf.1.\\items","typeLabel":"object[]"}},"additionalProperties":true,"uniqueKey":"results.items.[INDEX].profile.sections.portfolio.oneOf.1","typeLabel":"object"}],"uniqueKey":"results.items.[INDEX].profile.sections.portfolio","typeLabel":"null | object"},"families":{"oneOf":[{"type":"null","uniqueKey":"results.items.[INDEX].profile.sections.families.oneOf.0","typeLabel":"null"},{"type":"object","description":"A generated section with its items. Each item carries its content fields.","required":["items"],"properties":{"items":{"type":"array","items":{"type":"object","additionalProperties":true,"uniqueKey":"results.items.[INDEX].profile.sections.families.oneOf.1.\\items.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"results.items.[INDEX].profile.sections.families.oneOf.1.\\items","typeLabel":"object[]"}},"additionalProperties":true,"uniqueKey":"results.items.[INDEX].profile.sections.families.oneOf.1","typeLabel":"object"}],"uniqueKey":"results.items.[INDEX].profile.sections.families","typeLabel":"null | object"},"researchPapers":{"type":"object","description":"A generated section with its items. Each item carries its content fields.","required":["items"],"additionalProperties":true,"properties":{"items":{"type":"array","items":{"type":"object","additionalProperties":true,"uniqueKey":"results.items.[INDEX].profile.sections.researchPapers.\\items.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"results.items.[INDEX].profile.sections.researchPapers.\\items","typeLabel":"object[]"}},"uniqueKey":"results.items.[INDEX].profile.sections.researchPapers","typeLabel":"object"},"githubRepos":{"type":"object","description":"A generated section with its items. Each item carries its content fields.","required":["items"],"additionalProperties":true,"properties":{"items":{"type":"array","items":{"type":"object","additionalProperties":true,"uniqueKey":"results.items.[INDEX].profile.sections.githubRepos.\\items.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"results.items.[INDEX].profile.sections.githubRepos.\\items","typeLabel":"object[]"}},"uniqueKey":"results.items.[INDEX].profile.sections.githubRepos","typeLabel":"object"},"mediaCredits":{"type":"object","description":"A generated section with its items. Each item carries its content fields.","required":["items"],"additionalProperties":true,"properties":{"items":{"type":"array","items":{"type":"object","additionalProperties":true,"uniqueKey":"results.items.[INDEX].profile.sections.mediaCredits.\\items.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"results.items.[INDEX].profile.sections.mediaCredits.\\items","typeLabel":"object[]"}},"uniqueKey":"results.items.[INDEX].profile.sections.mediaCredits","typeLabel":"object"},"musicCredits":{"type":"object","description":"A generated section with its items. Each item carries its content fields.","required":["items"],"additionalProperties":true,"properties":{"items":{"type":"array","items":{"type":"object","additionalProperties":true,"uniqueKey":"results.items.[INDEX].profile.sections.musicCredits.\\items.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"results.items.[INDEX].profile.sections.musicCredits.\\items","typeLabel":"object[]"}},"uniqueKey":"results.items.[INDEX].profile.sections.musicCredits","typeLabel":"object"},"books":{"type":"object","description":"A generated section with its items. Each item carries its content fields.","required":["items"],"additionalProperties":true,"properties":{"items":{"type":"array","items":{"type":"object","additionalProperties":true,"uniqueKey":"results.items.[INDEX].profile.sections.books.\\items.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"results.items.[INDEX].profile.sections.books.\\items","typeLabel":"object[]"}},"uniqueKey":"results.items.[INDEX].profile.sections.books","typeLabel":"object"}},"isRequired":true,"uniqueKey":"results.items.[INDEX].profile.sections","typeLabel":"object"},"displayName":{"type":"any","uniqueKey":"results.items.[INDEX].profile.displayName","typeLabel":"any"},"personName":{"type":"any","uniqueKey":"results.items.[INDEX].profile.personName","typeLabel":"any"},"aliases":{"type":"any","uniqueKey":"results.items.[INDEX].profile.aliases","typeLabel":"any"},"profileUrl":{"type":"any","uniqueKey":"results.items.[INDEX].profile.profileUrl","typeLabel":"any"},"slug":{"type":"any","uniqueKey":"results.items.[INDEX].profile.slug","typeLabel":"any"},"category":{"type":"any","uniqueKey":"results.items.[INDEX].profile.category","typeLabel":"any"},"location":{"type":"any","uniqueKey":"results.items.[INDEX].profile.location","typeLabel":"any"},"headline":{"type":"any","uniqueKey":"results.items.[INDEX].profile.headline","typeLabel":"any"},"emails":{"type":"any","uniqueKey":"results.items.[INDEX].profile.emails","typeLabel":"any"},"emailDetails":{"type":"array","description":"One summary for each published email address: its type, the employer behind the domain, and whether mail reaches it, when available.","items":{"type":"object","required":["email","type","typeBasis","verification"],"additionalProperties":true,"properties":{"email":{"type":"string","format":"email","isRequired":true,"uniqueKey":"results.items.[INDEX].profile.emailDetails.items.[INDEX].email","typeLabel":"string\u003cemail>"},"type":{"type":"string","enum":["personal","work","unknown"],"description":"`unknown` means the evidence on hand leaves the type open.","isRequired":true,"uniqueKey":"results.items.[INDEX].profile.emailDetails.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"typeBasis":{"type":"string","enum":["consumer_domain","provider_free_domain","employment_domain","employment_name","provider_employer_claim","role_address","academic_domain","conflicting_evidence","insufficient_evidence"],"description":"The evidence behind `type`.","isRequired":true,"uniqueKey":"results.items.[INDEX].profile.emailDetails.items.[INDEX].typeBasis","typeLabel":"enum\u003cstring>"},"verification":{"type":"object","required":["status"],"additionalProperties":true,"properties":{"status":{"type":"string","enum":["deliverable","undeliverable","risky","unverified"],"description":"`risky` means the domain accepts every address or the check was weak. `unverified` means the address was reported with no check.","isRequired":true,"uniqueKey":"results.items.[INDEX].profile.emailDetails.items.[INDEX].verification.status","typeLabel":"enum\u003cstring>"},"verifiedAt":{"type":"string","format":"date-time","description":"When the check ran.","uniqueKey":"results.items.[INDEX].profile.emailDetails.items.[INDEX].verification.verifiedAt","typeLabel":"string\u003cdate-time>"},"catchAllDomain":{"type":"boolean","description":"Whether the domain accepts every address.","uniqueKey":"results.items.[INDEX].profile.emailDetails.items.[INDEX].verification.catchAllDomain","typeLabel":"boolean"}},"isRequired":true,"uniqueKey":"results.items.[INDEX].profile.emailDetails.items.[INDEX].verification","typeLabel":"object"},"employer":{"type":"object","required":["association"],"additionalProperties":true,"description":"The company that owns the domain, when one is known.","properties":{"association":{"type":"string","enum":["current","former","unknown"],"description":"Whether the person still works at the company. `unknown` means a company was reported with no tenure.","isRequired":true,"uniqueKey":"results.items.[INDEX].profile.emailDetails.items.[INDEX].employer.association","typeLabel":"enum\u003cstring>"},"companyName":{"type":"string","uniqueKey":"results.items.[INDEX].profile.emailDetails.items.[INDEX].employer.companyName","typeLabel":"string"},"companyDomain":{"type":"string","uniqueKey":"results.items.[INDEX].profile.emailDetails.items.[INDEX].employer.companyDomain","typeLabel":"string"}},"uniqueKey":"results.items.[INDEX].profile.emailDetails.items.[INDEX].employer","typeLabel":"object"}},"uniqueKey":"results.items.[INDEX].profile.emailDetails.items.[INDEX]","typeLabel":"object"},"uniqueKey":"results.items.[INDEX].profile.emailDetails","typeLabel":"object[]"},"employmentDomains":{"type":"array","description":"Employer domains from the profile's employment history, with whether each role is current, when available.","items":{"type":"object","required":["isCurrent"],"additionalProperties":true,"properties":{"isCurrent":{"type":"boolean","description":"Whether this role is current.","isRequired":true,"uniqueKey":"results.items.[INDEX].profile.employmentDomains.items.[INDEX].isCurrent","typeLabel":"boolean"},"companyName":{"type":"string","uniqueKey":"results.items.[INDEX].profile.employmentDomains.items.[INDEX].companyName","typeLabel":"string"},"domain":{"type":"string","uniqueKey":"results.items.[INDEX].profile.employmentDomains.items.[INDEX].domain","typeLabel":"string"}},"uniqueKey":"results.items.[INDEX].profile.employmentDomains.items.[INDEX]","typeLabel":"object"},"uniqueKey":"results.items.[INDEX].profile.employmentDomains","typeLabel":"object[]"},"phoneNumbers":{"type":"any","uniqueKey":"results.items.[INDEX].profile.phoneNumbers","typeLabel":"any"},"phoneDetails":{"type":"array","description":"What providers reported about each phone number, when available.","items":{"type":"object","required":["phoneNumber","type"],"additionalProperties":true,"properties":{"phoneNumber":{"type":"string","isRequired":true,"uniqueKey":"results.items.[INDEX].profile.phoneDetails.items.[INDEX].phoneNumber","typeLabel":"string"},"type":{"type":"string","enum":["mobile","landline","voip","unknown"],"isRequired":true,"uniqueKey":"results.items.[INDEX].profile.phoneDetails.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"isConnected":{"type":"boolean","uniqueKey":"results.items.[INDEX].profile.phoneDetails.items.[INDEX].isConnected","typeLabel":"boolean"},"firstReported":{"type":"number","uniqueKey":"results.items.[INDEX].profile.phoneDetails.items.[INDEX].firstReported","typeLabel":"number"},"lastReported":{"type":"number","uniqueKey":"results.items.[INDEX].profile.phoneDetails.items.[INDEX].lastReported","typeLabel":"number"}},"uniqueKey":"results.items.[INDEX].profile.phoneDetails.items.[INDEX]","typeLabel":"object"},"uniqueKey":"results.items.[INDEX].profile.phoneDetails","typeLabel":"object[]"},"addresses":{"type":"any","uniqueKey":"results.items.[INDEX].profile.addresses","typeLabel":"any"}},"uniqueKey":"results.items.[INDEX].profile","typeLabel":"object"},"confidence":{"type":"number","minimum":0,"maximum":1,"description":"How well this result matches the search inputs, from 0 to 1. Each result is scored on its own. For a face search it includes how strongly the face matches this person.","uniqueKey":"results.items.[INDEX].confidence","typeLabel":"number"},"confidence_level":{"type":"string","enum":["low","medium","high"],"description":"`confidence` as a level: `high` from 0.75, `medium` from 0.35, and `low` below.","uniqueKey":"results.items.[INDEX].confidence_level","typeLabel":"enum\u003cstring>"},"confidence_status":{"type":"string","enum":["provisional","final"],"description":"`provisional` while the result list can still change, `final` once it is final.","uniqueKey":"results.items.[INDEX].confidence_status","typeLabel":"enum\u003cstring>"},"match_summary":{"type":"object","description":"The search inputs this result matches, partly matches, conflicts with, or has no data for.","properties":{"matches":{"type":"array","items":{"type":"object","required":["field","query"],"properties":{"field":{"type":"string","description":"The kind of input, such as `name`, `email`, `employment`, `location`, or `face`.","isRequired":true,"uniqueKey":"results.items.[INDEX].match_summary.matches.items.[INDEX].field","typeLabel":"string"},"query":{"type":"string","description":"The input as the search read it.","isRequired":true,"uniqueKey":"results.items.[INDEX].match_summary.matches.items.[INDEX].query","typeLabel":"string"},"candidate":{"type":"string","description":"The value on this result that Orbit compared with the input.","uniqueKey":"results.items.[INDEX].match_summary.matches.items.[INDEX].candidate","typeLabel":"string"},"outcome":{"type":"string","enum":["exact","equivalent","compatible","semantic"],"description":"How closely the value matches. Present on `matches` and `partial_matches`.","uniqueKey":"results.items.[INDEX].match_summary.matches.items.[INDEX].outcome","typeLabel":"enum\u003cstring>"},"evidence_level":{"type":"string","enum":["weak","moderate","strong"],"description":"How much this match adds to `confidence`.","uniqueKey":"results.items.[INDEX].match_summary.matches.items.[INDEX].evidence_level","typeLabel":"enum\u003cstring>"}},"uniqueKey":"results.items.[INDEX].match_summary.matches.items.[INDEX]","typeLabel":"object"},"uniqueKey":"results.items.[INDEX].match_summary.matches","typeLabel":"object[]"},"partial_matches":{"type":"array","items":{"type":"object","required":["field","query"],"properties":{"field":{"type":"string","description":"The kind of input, such as `name`, `email`, `employment`, `location`, or `face`.","isRequired":true,"uniqueKey":"results.items.[INDEX].match_summary.partial_matches.items.[INDEX].field","typeLabel":"string"},"query":{"type":"string","description":"The input as the search read it.","isRequired":true,"uniqueKey":"results.items.[INDEX].match_summary.partial_matches.items.[INDEX].query","typeLabel":"string"},"candidate":{"type":"string","description":"The value on this result that Orbit compared with the input.","uniqueKey":"results.items.[INDEX].match_summary.partial_matches.items.[INDEX].candidate","typeLabel":"string"},"outcome":{"type":"string","enum":["exact","equivalent","compatible","semantic"],"description":"How closely the value matches. Present on `matches` and `partial_matches`.","uniqueKey":"results.items.[INDEX].match_summary.partial_matches.items.[INDEX].outcome","typeLabel":"enum\u003cstring>"},"evidence_level":{"type":"string","enum":["weak","moderate","strong"],"description":"How much this match adds to `confidence`.","uniqueKey":"results.items.[INDEX].match_summary.partial_matches.items.[INDEX].evidence_level","typeLabel":"enum\u003cstring>"}},"uniqueKey":"results.items.[INDEX].match_summary.partial_matches.items.[INDEX]","typeLabel":"object"},"uniqueKey":"results.items.[INDEX].match_summary.partial_matches","typeLabel":"object[]"},"apparent_conflicts":{"type":"array","items":{"type":"object","required":["field","query"],"properties":{"field":{"type":"string","description":"The kind of input, such as `name`, `email`, `employment`, `location`, or `face`.","isRequired":true,"uniqueKey":"results.items.[INDEX].match_summary.apparent_conflicts.items.[INDEX].field","typeLabel":"string"},"query":{"type":"string","description":"The input as the search read it.","isRequired":true,"uniqueKey":"results.items.[INDEX].match_summary.apparent_conflicts.items.[INDEX].query","typeLabel":"string"},"candidate":{"type":"string","description":"The value on this result that Orbit compared with the input.","uniqueKey":"results.items.[INDEX].match_summary.apparent_conflicts.items.[INDEX].candidate","typeLabel":"string"},"outcome":{"type":"string","enum":["exact","equivalent","compatible","semantic"],"description":"How closely the value matches. Present on `matches` and `partial_matches`.","uniqueKey":"results.items.[INDEX].match_summary.apparent_conflicts.items.[INDEX].outcome","typeLabel":"enum\u003cstring>"},"evidence_level":{"type":"string","enum":["weak","moderate","strong"],"description":"How much this match adds to `confidence`.","uniqueKey":"results.items.[INDEX].match_summary.apparent_conflicts.items.[INDEX].evidence_level","typeLabel":"enum\u003cstring>"}},"uniqueKey":"results.items.[INDEX].match_summary.apparent_conflicts.items.[INDEX]","typeLabel":"object"},"uniqueKey":"results.items.[INDEX].match_summary.apparent_conflicts","typeLabel":"object[]"},"unknown":{"type":"array","items":{"type":"object","required":["field","query"],"properties":{"field":{"type":"string","description":"The kind of input, such as `name`, `email`, `employment`, `location`, or `face`.","isRequired":true,"uniqueKey":"results.items.[INDEX].match_summary.unknown.items.[INDEX].field","typeLabel":"string"},"query":{"type":"string","description":"The input as the search read it.","isRequired":true,"uniqueKey":"results.items.[INDEX].match_summary.unknown.items.[INDEX].query","typeLabel":"string"},"candidate":{"type":"string","description":"The value on this result that Orbit compared with the input.","uniqueKey":"results.items.[INDEX].match_summary.unknown.items.[INDEX].candidate","typeLabel":"string"},"outcome":{"type":"string","enum":["exact","equivalent","compatible","semantic"],"description":"How closely the value matches. Present on `matches` and `partial_matches`.","uniqueKey":"results.items.[INDEX].match_summary.unknown.items.[INDEX].outcome","typeLabel":"enum\u003cstring>"},"evidence_level":{"type":"string","enum":["weak","moderate","strong"],"description":"How much this match adds to `confidence`.","uniqueKey":"results.items.[INDEX].match_summary.unknown.items.[INDEX].evidence_level","typeLabel":"enum\u003cstring>"}},"uniqueKey":"results.items.[INDEX].match_summary.unknown.items.[INDEX]","typeLabel":"object"},"uniqueKey":"results.items.[INDEX].match_summary.unknown","typeLabel":"object[]"}},"uniqueKey":"results.items.[INDEX].match_summary","typeLabel":"object"},"failure":{"type":"object","required":["code","message","retryable","reason"],"properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"results.items.[INDEX].failure.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"results.items.[INDEX].failure.message","typeLabel":"string"},"retryable":{"type":"boolean","isRequired":true,"uniqueKey":"results.items.[INDEX].failure.retryable","typeLabel":"boolean"},"reason":{"type":"string","isRequired":true,"uniqueKey":"results.items.[INDEX].failure.reason","typeLabel":"string"},"suggested_inputs":{"type":"array","items":{"type":"string","uniqueKey":"results.items.[INDEX].failure.suggested_inputs.items.[INDEX]","typeLabel":"string"},"uniqueKey":"results.items.[INDEX].failure.suggested_inputs","typeLabel":"string[]"}},"uniqueKey":"results.items.[INDEX].failure","typeLabel":"object"}},"uniqueKey":"results.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"results","typeLabel":"object[]"},"created_at":{"type":"string","format":"date-time","description":"When the search was created.","isRequired":true,"uniqueKey":"created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","description":"When the snapshot last changed.","isRequired":true,"uniqueKey":"updated_at","typeLabel":"string\u003cdate-time>"},"links":{"type":"object","required":["status"],"properties":{"status":{"type":"string","description":"Relative URL for the search status endpoint.","isRequired":true,"uniqueKey":"links.status","typeLabel":"string"}},"isRequired":true,"uniqueKey":"links","typeLabel":"object"},"candidate_discovery_completed":{"type":"boolean","description":"Whether the result list is final. Once true, discovery adds no more results to this search; the results themselves can still be generating or enriching toward the requested depth. For discovery searches this becomes true when clustering completes and every discovered person appears in results. If discovery failed, candidate_discovery_failure explains why. Present only when candidate_discovery is true.","uniqueKey":"candidate_discovery_completed","typeLabel":"boolean"},"provider_results_final":{"type":"boolean","description":"Whether the people-data provider lookup for a supplied phone, email, or address returned its complete owner set. Once true, every owner of that contact is in results with the contacts the provider reported, usually within the first response and before biography work. Discovery by name can still add results until candidate_discovery_completed is true. Present only when candidate_discovery is true and the request carried a phone, email, or address signal.","uniqueKey":"provider_results_final","typeLabel":"boolean"},"confidence_kind":{"type":"string","enum":["identity","criteria"],"description":"`identity` when the search looks for one person, such as by name, contact, or face, and `criteria` when it looks for everyone who fits a description.","uniqueKey":"confidence_kind","typeLabel":"enum\u003cstring>"},"none_of_above_confidence":{"type":"number","minimum":0,"maximum":1,"description":"One minus the best result's `confidence`. It is high when no result matches well. Present on `identity` searches.","uniqueKey":"none_of_above_confidence","typeLabel":"number"},"discovered_sources":{"type":"array","description":"Every page the search has found, in the order the search first found each one. The list starts filling within seconds and holds up to 200 pages. A page stays listed through later polls and after the search ends, including a page Candidate Discovery assigned to a result. Present when candidate_discovery is true.","items":{"type":"object","additionalProperties":false,"required":["link","title","sourceImage"],"properties":{"link":{"type":"string","format":"uri","description":"URL of the discovered source page.","isRequired":true,"uniqueKey":"discovered_sources.items.[INDEX].link","typeLabel":"string\u003curi>"},"title":{"type":"string","description":"Display title of the source page or site.","isRequired":true,"uniqueKey":"discovered_sources.items.[INDEX].title","typeLabel":"string"},"sourceImage":{"type":"string","format":"uri","description":"URL of the favicon for the site that hosts the source page.","isRequired":true,"uniqueKey":"discovered_sources.items.[INDEX].sourceImage","typeLabel":"string\u003curi>"},"face_match":{"type":"object","description":"Present on a face search for each page the search found a face on. A page with `kept` true is a page of the picked face, and a confirmed page is a strong match. A page with `kept` false shows another face that looks alike.","required":["score","confirmed"],"properties":{"score":{"type":"number","minimum":0,"maximum":1,"description":"How alike the face on this page and the picked face are, from 0 to 1.","isRequired":true,"uniqueKey":"discovered_sources.items.[INDEX].face_match.score","typeLabel":"number"},"confirmed":{"type":"boolean","description":"Whether the score is high enough to confirm the same person.","isRequired":true,"uniqueKey":"discovered_sources.items.[INDEX].face_match.confirmed","typeLabel":"boolean"},"kept":{"type":"boolean","description":"Whether the search counts this page as a page of the picked face. A page with `kept` false shows another face that looks alike and is listed in `discovered_sources` only.","uniqueKey":"discovered_sources.items.[INDEX].face_match.kept","typeLabel":"boolean"},"thumbnail":{"type":"string","description":"A small image of the face found on the page, as a `data:` URL.","uniqueKey":"discovered_sources.items.[INDEX].face_match.thumbnail","typeLabel":"string"}},"uniqueKey":"discovered_sources.items.[INDEX].face_match","typeLabel":"object"}},"uniqueKey":"discovered_sources.items.[INDEX]","typeLabel":"object"},"uniqueKey":"discovered_sources","typeLabel":"object[]"},"candidate_discovery_failure":{"type":"object","required":["code","message","retryable","reason"],"properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"candidate_discovery_failure.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"candidate_discovery_failure.message","typeLabel":"string"},"retryable":{"type":"boolean","isRequired":true,"uniqueKey":"candidate_discovery_failure.retryable","typeLabel":"boolean"},"reason":{"type":"string","isRequired":true,"uniqueKey":"candidate_discovery_failure.reason","typeLabel":"string"},"suggested_inputs":{"type":"array","items":{"type":"string","uniqueKey":"candidate_discovery_failure.suggested_inputs.items.[INDEX]","typeLabel":"string"},"uniqueKey":"candidate_discovery_failure.suggested_inputs","typeLabel":"string[]"}},"description":"Why candidate discovery failed. Present only when discovery failed.","uniqueKey":"candidate_discovery_failure","typeLabel":"object"},"population":{"type":"object","required":["kind","id","name","size","profile_depth","credits_quoted","status"],"description":"Present on population searches: the subject, the depth, the reserved credits and where the search is.","properties":{"kind":{"type":"string","enum":["company","school"],"isRequired":true,"uniqueKey":"population.kind","typeLabel":"enum\u003cstring>"},"id":{"type":"string","isRequired":true,"uniqueKey":"population.id","typeLabel":"string"},"name":{"type":"string","isRequired":true,"uniqueKey":"population.name","typeLabel":"string"},"size":{"oneOf":[{"type":"integer","description":"The population's size as given, or null.","isRequired":true,"uniqueKey":"population.size.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The population's size as given, or null.","isRequired":true,"uniqueKey":"population.size.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"population.size","typeLabel":"integer | null"},"profile_depth":{"type":"string","enum":["quick","partial","full"],"description":"The depth every person is built to.","isRequired":true,"uniqueKey":"population.profile_depth","typeLabel":"enum\u003cstring>"},"credits_quoted":{"type":"integer","description":"The credits reserved when the search started.","isRequired":true,"uniqueKey":"population.credits_quoted","typeLabel":"integer"},"status":{"type":"string","enum":["running","completed","completed_with_errors","failed","cancelled"],"description":"Where the population search is. The search's own status is running while this is running, completed when this is completed, and completed_with_errors when this is completed_with_errors, failed or cancelled.","isRequired":true,"uniqueKey":"population.status","typeLabel":"enum\u003cstring>"}},"uniqueKey":"population","typeLabel":"object"},"query_intent":{"type":"object","description":"Present when the search parsed a plain-English query.","required":["organizations","schools","person_named"],"properties":{"organizations":{"type":"array","items":{"type":"string","uniqueKey":"query_intent.organizations.items.[INDEX]","typeLabel":"string"},"description":"The companies the query names.","isRequired":true,"uniqueKey":"query_intent.organizations","typeLabel":"string[]"},"schools":{"type":"array","items":{"type":"string","uniqueKey":"query_intent.schools.items.[INDEX]","typeLabel":"string"},"description":"The schools the query names.","isRequired":true,"uniqueKey":"query_intent.schools","typeLabel":"string[]"},"person_named":{"type":"boolean","description":"Whether the query names a specific person.","isRequired":true,"uniqueKey":"query_intent.person_named","typeLabel":"boolean"}},"uniqueKey":"query_intent","typeLabel":"object"},"billing":{"type":"object","description":"Credits held and spent for this search. The final consumedCredits is the full charge once status is settled.","required":["id","pricingVersion","reservedCredits","consumedCredits","releasedCredits","heldCredits","status"],"properties":{"id":{"type":"string","format":"uuid","description":"The billing operation behind this request.","isRequired":true,"uniqueKey":"billing.id","typeLabel":"string\u003cuuid>"},"pricingVersion":{"type":"string","description":"The pricing catalog version this operation settles under.","isRequired":true,"uniqueKey":"billing.pricingVersion","typeLabel":"string"},"reservedCredits":{"type":"integer","minimum":0,"description":"The credits held for this operation.","isRequired":true,"uniqueKey":"billing.reservedCredits","typeLabel":"integer"},"consumedCredits":{"type":"integer","minimum":0,"description":"The credits charged so far.","isRequired":true,"uniqueKey":"billing.consumedCredits","typeLabel":"integer"},"releasedCredits":{"type":"integer","minimum":0,"description":"The credits returned to your balance.","isRequired":true,"uniqueKey":"billing.releasedCredits","typeLabel":"integer"},"heldCredits":{"type":"integer","minimum":0,"description":"The credits still held: reservedCredits less consumedCredits and releasedCredits.","isRequired":true,"uniqueKey":"billing.heldCredits","typeLabel":"integer"},"status":{"type":"string","enum":["open","settled"],"description":"open while the operation can still charge, and settled once its charge is final.","isRequired":true,"uniqueKey":"billing.status","typeLabel":"enum\u003cstring>"}},"uniqueKey":"billing","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"search_id":"\u003cstring>","request_id":"\u003cstring>","status":"running","candidate_discovery":true,"profile_depth":"quick","include_profile":true,"profile_upgrades_completed":true,"results":[{"profile_id":"\u003cstring>","status":"generating","generation_level":2,"sources":["search"],"candidate_sources":[{"link":"\u003cstring>","title":"\u003cstring>","sourceImage":"\u003cstring>","face_match":{"score":0.5,"confirmed":true,"kept":true,"thumbnail":"\u003cstring>"}}],"preview":{},"profile":{"id":"\u003cunknown>","generationLevel":"\u003cunknown>","avatarUrl":"\u003cunknown>","verified":"\u003cunknown>","sections":{"socials":{"items":[{}]},"bio":{"bio":"\u003cstring>"},"basic":{"items":[{}]},"personalLife":{"items":[{}]},"jobs":{"items":[{}]},"education":{"items":[{}]},"passions":{"items":[{}]},"worldview":{"items":[{}]},"accomplishments":{"items":[{}]},"controversies":{"items":[{}]},"bestQualities":{"items":[{}]},"netWorth":{"items":[{}]},"eventsTimeline":{"items":[{}]},"portfolio":{"items":[{}]},"families":{"items":[{}]},"researchPapers":{"items":[{}]},"githubRepos":{"items":[{}]},"mediaCredits":{"items":[{}]},"musicCredits":{"items":[{}]},"books":{"items":[{}]}},"displayName":"\u003cunknown>","personName":"\u003cunknown>","aliases":"\u003cunknown>","profileUrl":"\u003cunknown>","slug":"\u003cunknown>","category":"\u003cunknown>","location":"\u003cunknown>","headline":"\u003cunknown>","emails":"\u003cunknown>","emailDetails":[{"email":"jsmith@example.com","type":"personal","typeBasis":"consumer_domain","verification":{"status":"deliverable","verifiedAt":"2023-11-07T05:31:56Z","catchAllDomain":true},"employer":{"association":"current","companyName":"\u003cstring>","companyDomain":"\u003cstring>"}}],"employmentDomains":[{"isCurrent":true,"companyName":"\u003cstring>","domain":"\u003cstring>"}],"phoneNumbers":"\u003cunknown>","phoneDetails":[{"phoneNumber":"\u003cstring>","type":"mobile","isConnected":true,"firstReported":123,"lastReported":123}],"addresses":"\u003cunknown>"},"confidence":0.5,"confidence_level":"low","confidence_status":"provisional","match_summary":{"matches":[{"field":"\u003cstring>","query":"\u003cstring>","candidate":"\u003cstring>","outcome":"exact","evidence_level":"weak"}],"partial_matches":[{"field":"\u003cstring>","query":"\u003cstring>","candidate":"\u003cstring>","outcome":"exact","evidence_level":"weak"}],"apparent_conflicts":[{"field":"\u003cstring>","query":"\u003cstring>","candidate":"\u003cstring>","outcome":"exact","evidence_level":"weak"}],"unknown":[{"field":"\u003cstring>","query":"\u003cstring>","candidate":"\u003cstring>","outcome":"exact","evidence_level":"weak"}]},"failure":{"code":"\u003cstring>","message":"\u003cstring>","retryable":true,"reason":"\u003cstring>","suggested_inputs":["\u003cstring>"]}}],"created_at":"2023-11-07T05:31:56Z","updated_at":"2023-11-07T05:31:56Z","links":{"status":"\u003cstring>"},"candidate_discovery_completed":true,"provider_results_final":true,"confidence_kind":"identity","none_of_above_confidence":0.5,"discovered_sources":[{"link":"\u003cstring>","title":"\u003cstring>","sourceImage":"\u003cstring>","face_match":{"score":0.5,"confirmed":true,"kept":true,"thumbnail":"\u003cstring>"}}],"candidate_discovery_failure":{"code":"\u003cstring>","message":"\u003cstring>","retryable":true,"reason":"\u003cstring>","suggested_inputs":["\u003cstring>"]},"population":{"kind":"company","id":"\u003cstring>","name":"\u003cstring>","size":123,"profile_depth":"quick","credits_quoted":123,"status":"running"},"query_intent":{"organizations":["\u003cstring>"],"schools":["\u003cstring>"],"person_named":true},"billing":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","pricingVersion":"\u003cstring>","reservedCredits":1,"consumedCredits":1,"releasedCredits":1,"heldCredits":1,"status":"open"}}}},"exampleType":"generated"}},"exampleType":"generated"},"b745d311-0e69-4105-a665-d3dad7fc7857":{"description":"The request is not valid.","content":{"application/json":{"schema":{"type":"object","required":["status","error"],"properties":{"status":{"type":"string","enum":["failed"],"isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"requiredCredits":{"type":"integer","minimum":0,"description":"Credits required when the error is developer_api_credits_insufficient.","uniqueKey":"error.requiredCredits","typeLabel":"integer"},"remainingCredits":{"type":"integer","minimum":0,"description":"Available credits when the error is developer_api_credits_insufficient.","uniqueKey":"error.remainingCredits","typeLabel":"integer"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":"failed","error":{"code":"\u003cstring>","message":"\u003cstring>","requiredCredits":1,"remainingCredits":1}}}},"exampleType":"generated"}},"exampleType":"generated"},"938d1acb-5128-4cf5-94d3-f86bc58c6c78":{"description":"The API key is missing or not valid.","content":{"application/json":{"schema":{"type":"object","required":["status","error"],"properties":{"status":{"type":"string","enum":["failed"],"isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"requiredCredits":{"type":"integer","minimum":0,"description":"Credits required when the error is developer_api_credits_insufficient.","uniqueKey":"error.requiredCredits","typeLabel":"integer"},"remainingCredits":{"type":"integer","minimum":0,"description":"Available credits when the error is developer_api_credits_insufficient.","uniqueKey":"error.remainingCredits","typeLabel":"integer"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":"failed","error":{"code":"\u003cstring>","message":"\u003cstring>","requiredCredits":1,"remainingCredits":1}}}},"exampleType":"generated"}},"exampleType":"generated"},"3bf50adc-19ae-43b9-9c2d-84f2bf15805b":{"description":"The available API credit balance cannot cover the requested work. Top up before retrying.","content":{"application/json":{"schema":{"type":"object","required":["status","error"],"properties":{"status":{"type":"string","enum":["failed"],"isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"requiredCredits":{"type":"integer","minimum":0,"description":"Credits required when the error is developer_api_credits_insufficient.","uniqueKey":"error.requiredCredits","typeLabel":"integer"},"remainingCredits":{"type":"integer","minimum":0,"description":"Available credits when the error is developer_api_credits_insufficient.","uniqueKey":"error.remainingCredits","typeLabel":"integer"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":"failed","error":{"code":"\u003cstring>","message":"\u003cstring>","requiredCredits":1,"remainingCredits":1}}}},"exampleType":"generated"}},"exampleType":"generated"},"3259fe1d-a410-4462-bb75-844e46e9fb9c":{"description":"The API key does not have the required scope.","content":{"application/json":{"schema":{"type":"object","required":["status","error"],"properties":{"status":{"type":"string","enum":["failed"],"isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"requiredCredits":{"type":"integer","minimum":0,"description":"Credits required when the error is developer_api_credits_insufficient.","uniqueKey":"error.requiredCredits","typeLabel":"integer"},"remainingCredits":{"type":"integer","minimum":0,"description":"Available credits when the error is developer_api_credits_insufficient.","uniqueKey":"error.remainingCredits","typeLabel":"integer"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":"failed","error":{"code":"\u003cstring>","message":"\u003cstring>","requiredCredits":1,"remainingCredits":1}}}},"exampleType":"generated"}},"exampleType":"generated"},"56fbdccd-9195-4363-ad8d-0925dfc421f0":{"description":"The request ID was already used with different inputs.","content":{"application/json":{"schema":{"type":"object","required":["status","error"],"properties":{"status":{"type":"string","enum":["failed"],"isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"requiredCredits":{"type":"integer","minimum":0,"description":"Credits required when the error is developer_api_credits_insufficient.","uniqueKey":"error.requiredCredits","typeLabel":"integer"},"remainingCredits":{"type":"integer","minimum":0,"description":"Available credits when the error is developer_api_credits_insufficient.","uniqueKey":"error.remainingCredits","typeLabel":"integer"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":"failed","error":{"code":"\u003cstring>","message":"\u003cstring>","requiredCredits":1,"remainingCredits":1}}}},"exampleType":"generated"}},"exampleType":"generated"},"3a5ddbee-c157-4b2e-8a14-1eee3048e2b6":{"description":"The API key exceeded a rate limit.","headers":{"Retry-After":{"description":"Seconds to wait before another request.","schema":{"type":"integer","minimum":0}}},"content":{"application/json":{"schema":{"type":"object","required":["status","error"],"properties":{"status":{"type":"string","enum":["failed"],"isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"requiredCredits":{"type":"integer","minimum":0,"description":"Credits required when the error is developer_api_credits_insufficient.","uniqueKey":"error.requiredCredits","typeLabel":"integer"},"remainingCredits":{"type":"integer","minimum":0,"description":"Available credits when the error is developer_api_credits_insufficient.","uniqueKey":"error.remainingCredits","typeLabel":"integer"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":"failed","error":{"code":"\u003cstring>","message":"\u003cstring>","requiredCredits":1,"remainingCredits":1}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"9cbd971c-25cc-46c5-8e19-38bb281e438c":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"Orbit API key","description":"Use an Orbit API key from the Developer Dashboard.","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"1b4a0f77-4036-4a1c-8df8-e593ae1ad48d":{"url":"https://api.orbitsearch.com","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"Orbit API key","description":"Use an Orbit API key from the Developer Dashboard.","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Use an Orbit API key from the Developer Dashboard.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"openapi.json"},"subdomain":"orbit-5c173338","siteName":"Orbit Developer API","title":"Search a Population - Orbit Developer API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-23T04:32:36.214Z","originalFileLocation":"api/search/population.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=\"dark\"}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=\"Search everyone at a company or everyone who attended a school. Results arrive while the search runs.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Orbit Developer API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/orbit-5c173338/PimEZ82mOuzZBv5z/_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/orbit-5c173338/PimEZ82mOuzZBv5z/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/orbit-5c173338/PimEZ82mOuzZBv5z/_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/orbit-5c173338/PimEZ82mOuzZBv5z/_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/orbit-5c173338/PimEZ82mOuzZBv5z/_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/orbit-5c173338/PimEZ82mOuzZBv5z/_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/orbit-5c173338/PimEZ82mOuzZBv5z/_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/orbit-5c173338/PimEZ82mOuzZBv5z/_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/orbit-5c173338/PimEZ82mOuzZBv5z/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Search a Population - Orbit Developer API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Search everyone at a company or everyone who attended a school. Results arrive while the search runs.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Orbit Developer API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.orbitsearch.com/api/search/population\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://orbit-5c173338.mintlify.site/_mintlify/api/og/v2?division=Search\u0026amp;title=Search+a+Population\u0026amp;description=Search+everyone+at+a+company+or+everyone+who+attended+a+school.+Results+arrive+while+the+search+runs.\u0026amp;theme=80a38a31624f90b17e1fb697\u0026amp;signature=799173002a0313956a116364c129977627d6f1b1e71b800cb8e31199458de09c\">\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=\"Search a Population - Orbit Developer API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Search everyone at a company or everyone who attended a school. Results arrive while the search runs.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://orbit-5c173338.mintlify.site/_mintlify/api/og/v2?division=Search\u0026amp;title=Search+a+Population\u0026amp;description=Search+everyone+at+a+company+or+everyone+who+attended+a+school.+Results+arrive+while+the+search+runs.\u0026amp;theme=80a38a31624f90b17e1fb697\u0026amp;signature=799173002a0313956a116364c129977627d6f1b1e71b800cb8e31199458de09c\">\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/orbit-5c173338/PimEZ82mOuzZBv5z/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Orbit Developer API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0875B9\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.orbitsearch.com/api/search/population\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api/search/population.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.orbitsearch.com/#organization\",\"name\":\"Orbit Developer API\",\"url\":\"https://docs.orbitsearch.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/orbit-5c173338/k-iXLNt-i1YvMS-Z/assets/orbit-logo-mark.png?fit=max\u0026auto=format\u0026n=k-iXLNt-i1YvMS-Z\u0026q=85\u0026s=8b0d9a458f0dbb073a9c9e109b9057bb\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.orbitsearch.com#website\",\"name\":\"Orbit Developer API\",\"url\":\"https://docs.orbitsearch.com\",\"publisher\":{\"@id\":\"https://docs.orbitsearch.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.orbitsearch.com/api/search/population#webpage\",\"url\":\"https://docs.orbitsearch.com/api/search/population\",\"name\":\"Search a Population\",\"description\":\"Search everyone at a company or everyone who attended a school. Results arrive while the search runs.\",\"dateModified\":\"2026-10-23T04:32:36.214Z\",\"isPartOf\":{\"@id\":\"https://docs.orbitsearch.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.orbitsearch.com/api/search/population#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.orbitsearch.com/api/search/population#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Search\",\"item\":\"https://docs.orbitsearch.com/api/search/search\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Search a Population\",\"item\":\"https://docs.orbitsearch.com/api/search/population\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.orbitsearch.com/api/search/population#apireference\",\"headline\":\"Search a Population\",\"name\":\"Search a Population\",\"description\":\"Search everyone at a company or everyone who attended a school. Results arrive while the search runs.\",\"url\":\"https://docs.orbitsearch.com/api/search/population\",\"mainEntityOfPage\":{\"@id\":\"https://docs.orbitsearch.com/api/search/population#webpage\"},\"dateModified\":\"2026-10-23T04:32:36.214Z\",\"publisher\":{\"@id\":\"https://docs.orbitsearch.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.orbitsearch.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Orbit Developer API\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Orbit Developer API\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api/search/population.md","siteName":"Orbit Developer API","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/introduction"}]},{"tab":"Reference","groups":[{"group":"Search","pages":[{"title":"Start a People Search","sidebarTitle":"Start a Search","openapi":"openapi.json POST /v3/search","href":"/api/search/search"},{"title":"Get Search Status","sidebarTitle":"Get Search Status","openapi":"openapi.json GET /v3/search/{search_id}","href":"/api/search/search-status"},{"title":"Bulk Search","sidebarTitle":"Bulk Search","openapi":"openapi.json POST /v3/search/bulk","href":"/api/search/bulk-search"},{"title":"Structured Search Intent","sidebarTitle":"Structured Intent","href":"/api/search/search-intent"},{"title":"Price a Population Search","sidebarTitle":"Price a Population","description":"See what it costs to search everyone at a company or everyone who attended a school before you start.","openapi":"openapi.json POST /v3/search/populations/quote","href":"/api/search/population-quote"},{"title":"Search a Population","sidebarTitle":"Search a Population","openapi":"openapi.json POST /v3/search/populations","href":"/api/search/population"},{"title":"Detect Faces","sidebarTitle":"Detect Faces","description":"Upload a photo and find every face in it.","openapi":"openapi.json POST /v3/faces/detect","href":"/api/search/faces-detect"},{"title":"Search the Face Index","sidebarTitle":"Search Face Index","openapi":"openapi.json POST /v3/faces/index-search","href":"/api/search/faces-index-search"}]},{"group":"Enrich","pages":[{"title":"Read a Profile","sidebarTitle":"Read a Profile","openapi":"openapi.json GET /v3/enrich/{profile_id}","href":"/api/enrich/read-profile"},{"title":"Enrich a Profile","sidebarTitle":"Enrich a Profile","openapi":"openapi.json POST /v3/enrich/{profile_id}","href":"/api/enrich/enrich-profile"},{"title":"Get Enrichment Status","sidebarTitle":"Get Enrich Status","openapi":"openapi.json GET /v3/enrich/requests/{request_id}","href":"/api/enrich/enrich-status"},{"title":"Batch Enrich Profiles","sidebarTitle":"Batch Enrich","openapi":"openapi.json POST /v3/enrich","href":"/api/enrich/batch-enrich"}]},{"group":"People","pages":[{"title":"Network Graph","sidebarTitle":"Network Graph","openapi":"openapi.json GET /v3/people/{profile_id}/network/path","href":"/api/people/network-graph"}]},{"group":"Watchers","pages":[{"title":"Create a Watcher","sidebarTitle":"Create a Watcher","openapi":"openapi.json POST /v3/watchers","href":"/api/watchers/create"},{"title":"List Watchers","sidebarTitle":"List Watchers","openapi":"openapi.json GET /v3/watchers","href":"/api/watchers/list"},{"title":"Get a Watcher","sidebarTitle":"Get a Watcher","openapi":"openapi.json GET /v3/watchers/{watcher_id}","href":"/api/watchers/get"},{"title":"Update a Watcher","sidebarTitle":"Update a Watcher","openapi":"openapi.json PATCH /v3/watchers/{watcher_id}","href":"/api/watchers/update"},{"title":"Delete a Watcher","sidebarTitle":"Delete a Watcher","openapi":"openapi.json DELETE /v3/watchers/{watcher_id}","href":"/api/watchers/delete"},{"title":"List Watcher Runs","sidebarTitle":"Watcher Runs","openapi":"openapi.json GET /v3/watchers/{watcher_id}/runs","href":"/api/watchers/runs"}]},{"group":"Webhooks","pages":[{"title":"Create a Webhook Endpoint","sidebarTitle":"Create an Endpoint","openapi":"openapi.json POST /v3/webhooks","href":"/api/webhooks/create"},{"title":"List Webhook Endpoints","sidebarTitle":"List Endpoints","openapi":"openapi.json GET /v3/webhooks","href":"/api/webhooks/list"},{"title":"Send a Test Webhook Delivery","sidebarTitle":"Send a Test Delivery","openapi":"openapi.json POST /v3/webhooks/{webhook_id}/test","href":"/api/webhooks/test"},{"title":"Delete a Webhook Endpoint","sidebarTitle":"Delete an Endpoint","openapi":"openapi.json DELETE /v3/webhooks/{webhook_id}","href":"/api/webhooks/delete"},{"title":"Webhook Events and Signature Verification","sidebarTitle":"Events \u0026 Signatures","href":"/api/webhooks/events"}]},{"group":"Agents","pages":[{"title":"Sign Up as an Agent","sidebarTitle":"Agent Signup","openapi":"openapi.json POST /v3/agents/signup","href":"/api/agents/signup"}]},{"group":"Keys","pages":[{"title":"Get Your Orbit Search API Key","sidebarTitle":"Get API Key","href":"/api/api-keys/create"},{"title":"View and Audit Your Orbit Search API Keys","sidebarTitle":"View Keys","href":"/api/api-keys/list"},{"title":"Revoke or Delete an Orbit Search API Key","sidebarTitle":"Revoke Keys","href":"/api/api-keys/revoke"},{"title":"View API Usage","sidebarTitle":"Usage","href":"/api/api-keys/usage"}]}]}]},"basePath":"","title":"Search a Population - Orbit Developer API","deploymentId":"dpl_HhUetB7eHHDAmK9T1Teip38TgFx9","buildId":"dpl_HhUetB7eHHDAmK9T1Teip38TgFx9","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-jJHA3WSo.js","utils-DbZn3Mjn.js","cloneDeep-CnBnaSyy.js","_Uint8Array-CMQtTgBR.js","isObject-FP1Yky1u.js","utils-Bl2DvzOJ.js","addUniqueKeysToSchema-BwOLo9p1.js","snippetPresets-BBiPpKa-.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","Page-DRLI_2Ue.js","ApiExamples-C0px4Tml.js","isEqual-zAyttAAO.js","usePlaygroundInputsStore-Dell6dGw.js","shallow-0VKqkSqN.js","getApiPlaygroundDisplay-CP_ctPEB.js","CodeSnippet-5L35ic0s.js","CodeSnippets-DOXbNhJw.js","getPastedJson-VhzT9m2P.js","icon-CD8_AtCO.js","MethodPill-DGgOMftG.js","DuplicateIcon-DZ6A_EtN.js","createIcon-DUl4oM5f.js","DynamicMarkdown-BGHukeRM.js","SectionHeading-ChrEUs8u.js","axios-vUo_bRtp.js","Markdown-Dj-na-_-.js","dist-C5gjFYHe.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","katex-YMM-FMeD.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js","AssistantPageLink-DEBW87tT.js"]}