Body: { "id": … }, plus the optional fields below.
Lists the people connected to one person, strongest first, a page at a time. Each entry carries the other person, the verdict and strength of the connection, and its evidence; the answer also says what research has been done for the person.
Checked in order: the body (400 invalid_body), limit, min_strength, cursor, types, max_tokens; with on_miss: RESEARCH only, the research and resolve jobs still running (429 research_busy); then, for every call, the balance (402).
An API key, orbb_sk_…, created in the console; or the console’s session token. See Authentication.
Body
application/json
id
string
required
Names the person whose connections are listed: a LinkedIn profile URL, or the public identifier from one (the part after /in/). Spaces around it are ignored; a blank value is answered 400 invalid_body. An id no person matches is answered 404 person_not_found; one that several people have held, 422 ambiguous_person with candidates.
A LinkedIn member token (ACoAA…) is not a public identifier: it is answered 404 person_not_found.
See also /v1/resolve, to find the id from an email or a name.
Required string length: 1 - 512
types
enum<string>[]
Restricts the answer to these connection types: CAREER (worked at the same company at the same time), EDUCATION (studied at the same school), INVESTOR (held investor roles at the same companies), LINKEDIN_COMMENTS (one commented on the other’s LinkedIn post). An empty array, or a member that is not a connection type, is answered 400 invalid_types.
A type listed twice counts once. With on_miss: RESEARCH, only the listed types are researched.
See also on_miss.
Default: every type.
Required array length: 1 - 64 elements
Available options:
CAREER,
EDUCATION,
INVESTOR,
LINKEDIN_COMMENTS
Maximum string length: 64
min_strength
number
default:0
Leaves out people whose connection strength is below this value; stronger connections score higher, and 0 keeps everyone. A value outside the range is answered 400 invalid_min_strength.
total and the pages count only the people kept.
See also limit, cursor.
Required range: 0 <= x <= 1
limit
integer
default:25
Sets the maximum number of people returned in one answer. A value outside the range, or one that is not an integer, is answered 400 invalid_limit.
When more people match, the answer carries next_cursor; pass it as cursor with the same body to read the next page. People are ordered by strength, strongest first.
See also cursor.
Required range: 1 <= x <= 100
cursor
string
Continues a listing from the previous answer’s next_cursor, with the rest of the body unchanged. Absent or blank reads the first page. A value that does not decode as a cursor is answered 400 invalid_cursor.
A cursor is a position in the order, not a query: one from another query, or with other types or min_strength, is not refused and starts at that position in the new order.
Each page reads the data as it stands at that call, so a connection whose strength changed between pages can be listed twice or not at all.
See also limit, next_cursor.
Maximum string length: 512
on_miss
enum<string>
default:UNKNOWN
Sets what happens to a requested type not yet researched for the people asked about. UNKNOWN answers from what is known and reports the type in the answer’s coverage; RESEARCH researches the requested types first, then answers. Any other value is answered 400 invalid_body.
RESEARCH takes longer, and is more often answered 202 with a job to read through /v1/job. A type researched recently is mostly not researched again; on circle and paths, force researches it anyway.
With on_miss: RESEARCH, researches every requested type again, even one researched recently. Without RESEARCH it has no effect, and is not refused.
See also on_miss, types.
max_tokens
number
Sets the tokens reserved for research on top of the call’s price. Taken only with on_miss: RESEARCH: with any other on_miss, even within the range, it is answered 400 invalid_max_tokens; so is a value outside the range, or one with more than 3 decimals.
The range starts above zero: to research nothing, leave out RESEARCH.
The person whose connections are listed: id of a circle, target of paths.
Hide child attributes
subject.key
string
required
The person’s key: the public identifier percent-decoded and lower-cased. Two people in the answers are the same person when their keys are equal.
subject.publicId
string
required
The person’s current LinkedIn public identifier, the part after /in/ of the profile URL. It is a valid id, a, b or target in any call. For a person with no known profile, the identifier as the call gave it, in the form of key.
subject.resolution
object
required
How the id given in the call was matched to this person.
Hide child attributes
subject.resolution.status
enum<string>
required
RESOLVED: one profile matches. AMBIGUOUS: several profiles match, listed in candidates. UNRESOLVED: no profile matches.
In circle, edge and paths answers it is RESOLVED, or UNRESOLVED for a person with no known profile whose connections are known under the id given; an ambiguous id is answered 422 ambiguous_person instead.
Available options:
RESOLVED,
AMBIGUOUS,
UNRESOLVED
subject.resolution.method
enum<string>
required
What answered: EMAIL (the email), NAME_COMPANY (a search by name, the name sent or one taken from the email, run without an email or after the email alone found no one), PUBLIC_ID (a public identifier), LINKEDIN_URL (a profile URL); an email or name search answered UNRESOLVED names the form searched, EMAIL when an email was sent, else NAME_COMPANY; a lookup by id keeps its identifier method whatever the status.
Available options:
PUBLIC_ID,
LINKEDIN_URL,
EMAIL,
NAME_COMPANY
subject.resolution.candidates
object[]
With AMBIGUOUS only: every matching profile. See also 422 ambiguous_person.
Hide child attributes
subject.resolution.candidates.key
string
required
The person’s key: the public identifier percent-decoded and lower-cased. Two people in the answers are the same person when their keys are equal.
subject.resolution.candidates.publicId
string
required
The person’s current LinkedIn public identifier, the part after /in/ of the profile URL. It is a valid id, a, b or target in any call. For a person with no known profile, the identifier as the call gave it, in the form of key.
subject.resolution.candidates.full_name
string
The person’s name. Absent when no known profile carries one.
subject.resolution.candidates.role
string
The title of the person’s current position; without one, the profile’s headline. Absent when the profile has neither, or no profile is known.
subject.resolution.candidates.company
string
The name of the company of the current position shown. Absent when unknown.
subject.resolution.candidates.companyPublicId
string
The LinkedIn page of that company, as company/<slug>, or showcase/<slug> for a showcase page. Absent when unknown.
subject.full_name
string
The person’s name. Absent when no known profile carries one.
subject.role
string
The title of the person’s current position; without one, the profile’s headline. Absent when the profile has neither, or no profile is known.
subject.company
string
The name of the company of the current position shown. Absent when unknown.
subject.companyPublicId
string
The LinkedIn page of that company, as company/<slug>, or showcase/<slug> for a showcase page. Absent when unknown.
research_state
object
required
What research the API has done for the subject.
Hide child attributes
research_state.status
enum<string>
required
The research state of the subject over the requested types. RESEARCHED: the last research of at least one type completed, and none is out of date. STALE: one completed and is out of date. NEVER_RESEARCHED: none completed; each has not run, is running (a re-run included), or failed.
For a person known under several ids, a completed research under any of them counts before a running or failed one under another.
Available options:
RESEARCHED,
NEVER_RESEARCHED,
STALE
research_state.types
object[]
required
One entry per requested type, in the order requested.
Hide child attributes
research_state.types.type
enum<string>
required
The connection type.
Available options:
CAREER,
EDUCATION,
INVESTOR,
LINKEDIN_COMMENTS
research_state.types.coverage
enum<string>
required
EXAMINED: the last research of the type completed, and at least one connection of the type is known. SEARCHED_NO_RESULT: it completed, and none is. UNAVAILABLE: the last research of the type failed, even when an earlier one completed. NOT_EXAMINED: no research of the type has completed, or one is running now, a re-run included.
Available options:
EXAMINED,
SEARCHED_NO_RESULT,
UNAVAILABLE,
NOT_EXAMINED
research_state.types.stale
boolean
required
Whether the research is old enough to be out of date. Never true for LINKEDIN_COMMENTS, which is kept current as comments are found.
research_state.types.depth
enum<string>
How deep the last research of the type read; for a failed one, the part that ran. Absent while a research of the type runs, when none has ended, and when the last one failed as a whole.
Available options:
STANDARD
research_state.types.completed_at
string<date-time>
When the last research of the type ended, completed or failed. Absent while a research of the type runs, and when none has ended.
research_state.types.truncated
boolean
True when the source cut the last research short, so connections can be missing. Absent while a research of the type runs, when none has ended, when the last one failed as a whole, and when none was recorded.
research_state.types.candidates
number
How many people the last research of the type considered. Absent while a research of the type runs, and when not recorded.
research_state.types.judged
number
How many of those people it assessed. Absent while a research of the type runs, and when not recorded.
hit
enum<string>
required
RESEARCHED when the last research of every requested type completed for the subject and none is out of date; UNKNOWN otherwise, a research running now included (for a person known under several ids, see research_state.status).
Available options:
RESEARCHED,
UNKNOWN
basis
enum<string>
required
What the answer is based on. NETWORK_ONLY, the only value today: connections inferred from public professional profiles and activity.
Available options:
NETWORK_ONLY
coverage
object
required
For each requested type, what the subject’s research found, with the limits that apply to the whole answer.
Hide child attributes
coverage.examined
enum<string>[]
required
The types with a connection found. For a circle’s subject: researched, with at least one connection of the type.
Available options:
CAREER,
EDUCATION,
INVESTOR,
LINKEDIN_COMMENTS
coverage.searched_no_result
enum<string>[]
required
The types checked with nothing found. For a circle’s subject: researched, with no connection of the type.
Available options:
CAREER,
EDUCATION,
INVESTOR,
LINKEDIN_COMMENTS
coverage.unavailable
enum<string>[]
required
The types whose research failed: for a pair, a research run in this call; for a circle’s subject, a type whose last research failed, even when an earlier one completed (for a person known under several ids, see research_state.status).
Available options:
CAREER,
EDUCATION,
INVESTOR,
LINKEDIN_COMMENTS
coverage.not_examined
enum<string>[]
required
The types not checked. For a circle’s subject: no research of the type has completed, or one is running now, a re-run included (for a person known under several ids, see research_state.status).
For a pair, LINKEDIN_COMMENTS with no connection found is always here: no comment found does not mean that none exists.
Available options:
CAREER,
EDUCATION,
INVESTOR,
LINKEDIN_COMMENTS
coverage.limits
object[]
required
What limits the answer for a type, one entry per type and reason.
The limits a type always has (NO_LIVE_SEARCH, NEVER_ALONE) are stated once per answer: in a circle or paths answer on the top-level coverage, not on each entry of data.
Hide child attributes
coverage.limits.type
enum<string>
required
The type the limit applies to.
Available options:
CAREER,
EDUCATION,
INVESTOR,
LINKEDIN_COMMENTS
coverage.limits.reason
enum<string>
required
SOURCE_LIMITED: the source cut the research short, or the shared companies of a career connection can no longer be shown. NO_LIVE_SEARCH: comments are read from those already known; a call never searches for new ones. EXCLUDED_BY_SCAN: the research run in this call left the other person out, so the pair was not checked. NEVER_ALONE: an education match is shown only next to another type. STALE: the research or the check of the type is old enough to be out of date.
Available options:
SOURCE_LIMITED,
NO_LIVE_SEARCH,
EXCLUDED_BY_SCAN,
NEVER_ALONE,
STALE
data
object[]
required
The page of connections, strongest first. It can hold fewer than limit entries even when next_cursor is present.
Hide child attributes
data.verdict
enum<string>
required
Whether the two people likely know each other. LIKELY_KNOW: a comment between them was found. POSSIBLE: another requested type was found. NO_EVIDENCE_FOUND: every requested type that can be checked was checked, with nothing found. UNKNOWN: none of these; verdict_reason says why.
Available options:
LIKELY_KNOW,
POSSIBLE,
NO_EVIDENCE_FOUND,
UNKNOWN
data.verdict_reason
enum<string>
required
Why the verdict is what it is: DIRECT_INTERACTION for LIKELY_KNOW, SHARED_HISTORY for POSSIBLE, SEARCHED_NO_RESULT for NO_EVIDENCE_FOUND; for UNKNOWN, UNAVAILABLE when the research of a type failed in this call, otherwise NOT_EXAMINED.
Available options:
DIRECT_INTERACTION,
SHARED_HISTORY,
SEARCHED_NO_RESULT,
UNAVAILABLE,
NOT_EXAMINED
data.evidence
object[]
required
One entry per requested type found, with what was found.
Hide child attributes
data.evidence.type
enum<string>
required
The connection type this evidence is for.
Available options:
CAREER,
EDUCATION,
INVESTOR,
LINKEDIN_COMMENTS
data.evidence.score
number
required
The type’s score, 0 to 1, as in strength.witnesses.
data.evidence.summary
string
required
One sentence that states the evidence, for display. Not meant to be parsed.
data.evidence.sources
object[]
required
Where the evidence comes from, and when it was observed.
Hide child attributes
data.evidence.sources.observed_at
string<date-time>
required
When the evidence was observed.
data.evidence.sources.provider
enum<string>
The profile source the other person’s profile was read from; LINKEDIN_POST_COMMENTS for comments. Absent when the other person has no known profile.
Available options:
LINKEDIN_PROFILES,
MAIN_DATASET,
OLD_DATASET,
LINKEDIN_POST_COMMENTS
data.evidence.model_score
number
The match score of the type: for INVESTOR, 0, 0.5 or 1 per shared organization, summed; for EDUCATION, how closely the degree names match. Absent for the other types.
data.evidence.overlap_days
number
CAREER only: the days both worked at the shared companies at the same time. Absent for the other types.
data.evidence.days_since_worked_together
number
CAREER only: the days since they last worked at the same company at the same time.
data.evidence.company_count
number
CAREER only: the number of companies both worked at together. It can be more than companies lists.
data.evidence.companies
object[]
CAREER: the shared employers, with the months both were there. Empty when the profiles no longer show the overlap; coverage.limits then carries SOURCE_LIMITED.
INVESTOR: the organizations where both held founder, board or investor roles.
Absent for the other types.
Hide child attributes
data.evidence.companies.public_id
string
required
The organization’s LinkedIn page, as company/<slug>, or showcase/<slug> for a showcase page.
data.evidence.companies.name
string
The organization’s name. Absent when unknown.
data.evidence.companies.from
string
CAREER only: the first month both were there, YYYY-MM.
data.evidence.companies.to
string
CAREER only: the last month both were there, YYYY-MM. Absent while both are still there.
data.evidence.companies.company_size
number
INVESTOR only: the organization’s number of employees. Absent when unknown.
data.evidence.companies.subject_titles
string[]
INVESTOR only: the subject’s founder, board or investor titles there. The subject is the circle’s person, or a in an edge.
data.evidence.companies.person_titles
string[]
INVESTOR only: the other person’s titles there.
data.evidence.windows
object[]
INVESTOR only: the months both held an investor role at an organization. An organization without such a period is in companies only.
Hide child attributes
data.evidence.windows.public_id
string
required
The organization’s LinkedIn page, as company/<slug>, or showcase/<slug> for a showcase page.
data.evidence.windows.from
string
required
The first month of the period, YYYY-MM.
data.evidence.windows.name
string
The organization’s name. Absent when unknown.
data.evidence.windows.to
string
The last month of the period, YYYY-MM. Absent while it goes on.
data.evidence.schools
string[]
EDUCATION only: the schools both attended. Can be empty.
data.evidence.subject_degree
object
EDUCATION only: the subject’s degree. A blank string in any of its fields means unknown.
Hide child attributes
data.evidence.subject_degree.name
string
The name of the degree as listed.
data.evidence.subject_degree.degree
string
The kind of degree.
data.evidence.subject_degree.fields
string
The fields of study.
data.evidence.person_degree
object
EDUCATION only: the other person’s degree. A blank string in any of its fields means unknown.
Hide child attributes
data.evidence.person_degree.name
string
The name of the degree as listed.
data.evidence.person_degree.degree
string
The kind of degree.
data.evidence.person_degree.fields
string
The fields of study.
data.evidence.same_start_year_month
number
EDUCATION only: not zero when both started at the school in the same year and month.
data.evidence.classification
enum<string>
LINKEDIN_COMMENTS only: the best class among the comments between them, from very good down to decent. irrelevant is not sent.
Available options:
irrelevant,
decent,
good,
very good
data.evidence.comment_count
number
LINKEDIN_COMMENTS only: the number of comments between them, in both directions.
data.evidence.comments
object[]
LINKEDIN_COMMENTS only: the best of the comments between them, best first. It can hold fewer than comment_count.
Hide child attributes
data.evidence.comments.by
string
required
The key of the person who commented.
data.evidence.comments.on
string
required
The key of the author of the post.
data.evidence.comments.url
string
required
The URL of the comment.
data.evidence.comments.classification
enum<string>
required
The class of the comment. irrelevant is not sent.
Available options:
irrelevant,
decent,
good,
very good
data.evidence.comments.confidence
number
required
The probability, 0 to 1, that the comment is of that class.
data.evidence.comments.date
string
required
When the comment was written, ISO 8601.
data.evidence.comments.post_url
string
The URL of the post. Absent when the comment’s URL is not a feed post’s.
data.counter_evidence
object[]
required
What weighs against the evidence found. Empty when nothing does.
Hide child attributes
data.counter_evidence.kind
enum<string>
required
LARGE_SHARED_ORGANIZATION: the shared organization is large enough that sharing it says little about knowing each other.
Available options:
LARGE_SHARED_ORGANIZATION
data.counter_evidence.type
enum<string>
required
The type the evidence weighs against.
Available options:
CAREER,
EDUCATION,
INVESTOR,
LINKEDIN_COMMENTS
data.counter_evidence.company_size
number
required
The organization’s number of employees, above 5000. For INVESTOR, given only when every shared organization is that large, and then the largest.
data.coverage
object
required
For each requested type, whether the pair was checked and what was found, with the limits that apply.
Hide child attributes
data.coverage.examined
enum<string>[]
required
The types with a connection found. For a circle’s subject: researched, with at least one connection of the type.
Available options:
CAREER,
EDUCATION,
INVESTOR,
LINKEDIN_COMMENTS
data.coverage.searched_no_result
enum<string>[]
required
The types checked with nothing found. For a circle’s subject: researched, with no connection of the type.
Available options:
CAREER,
EDUCATION,
INVESTOR,
LINKEDIN_COMMENTS
data.coverage.unavailable
enum<string>[]
required
The types whose research failed: for a pair, a research run in this call; for a circle’s subject, a type whose last research failed, even when an earlier one completed (for a person known under several ids, see research_state.status).
Available options:
CAREER,
EDUCATION,
INVESTOR,
LINKEDIN_COMMENTS
data.coverage.not_examined
enum<string>[]
required
The types not checked. For a circle’s subject: no research of the type has completed, or one is running now, a re-run included (for a person known under several ids, see research_state.status).
For a pair, LINKEDIN_COMMENTS with no connection found is always here: no comment found does not mean that none exists.
Available options:
CAREER,
EDUCATION,
INVESTOR,
LINKEDIN_COMMENTS
data.coverage.limits
object[]
required
What limits the answer for a type, one entry per type and reason.
The limits a type always has (NO_LIVE_SEARCH, NEVER_ALONE) are stated once per answer: in a circle or paths answer on the top-level coverage, not on each entry of data.
Hide child attributes
data.coverage.limits.type
enum<string>
required
The type the limit applies to.
Available options:
CAREER,
EDUCATION,
INVESTOR,
LINKEDIN_COMMENTS
data.coverage.limits.reason
enum<string>
required
SOURCE_LIMITED: the source cut the research short, or the shared companies of a career connection can no longer be shown. NO_LIVE_SEARCH: comments are read from those already known; a call never searches for new ones. EXCLUDED_BY_SCAN: the research run in this call left the other person out, so the pair was not checked. NEVER_ALONE: an education match is shown only next to another type. STALE: the research or the check of the type is old enough to be out of date.
Available options:
SOURCE_LIMITED,
NO_LIVE_SEARCH,
EXCLUDED_BY_SCAN,
NEVER_ALONE,
STALE
data.hit
enum<string>
required
RESEARCHED when at least one requested type was found or checked for the pair; UNKNOWN otherwise.
Available options:
RESEARCHED,
UNKNOWN
data.person
object
required
The other person. With no known profile, only key and publicId are present.
Hide child attributes
data.person.key
string
required
The person’s key: the public identifier percent-decoded and lower-cased. Two people in the answers are the same person when their keys are equal.
data.person.publicId
string
required
The person’s current LinkedIn public identifier, the part after /in/ of the profile URL. It is a valid id, a, b or target in any call. For a person with no known profile, the identifier as the call gave it, in the form of key.
data.person.full_name
string
The person’s name. Absent when no known profile carries one.
data.person.role
string
The title of the person’s current position; without one, the profile’s headline. Absent when the profile has neither, or no profile is known.
data.person.company
string
The name of the company of the current position shown. Absent when unknown.
data.person.companyPublicId
string
The LinkedIn page of that company, as company/<slug>, or showcase/<slug> for a showcase page. Absent when unknown.
data.strength
object
Present only when a requested type is found. Its absence is not a zero: verdict says what is known.
Hide child attributes
data.strength.value
number
required
How strong the connection is, 0 to 1.
In circle and paths answers it covers every type, not only the requested ones, and is what the listing is ordered by and min_strength filters on. In an edge answer it covers the requested types found.
Each type found sets a lower bound on value, its entry in witnesses; a second type found can raise it.
data.strength.label
enum<string>
required
The band the value falls in, from WEAK up to VERY_STRONG. Rely on it rather than on fixed cut-offs of value.
Available options:
VERY_STRONG,
STRONG,
MODERATE,
WEAK
data.strength.witnesses
object
required
The score of each type found, on the scale of value, 0 to 1. A type not found has no entry.
Hide child attributes
data.strength.witnesses.career
number
The CAREER score.
data.strength.witnesses.education
number
The EDUCATION score.
data.strength.witnesses.investor
number
The INVESTOR score.
data.strength.witnesses.linkedin_comments
number
The LINKEDIN_COMMENTS score.
data.observed_at
string<date-time>
When the newest evidence was observed; with none, when the newest check that found nothing was made. Absent when there is neither.
total
number
required
The number of connections that match types and min_strength; the pages can list fewer. Counting stops at a cap; see total_capped.
total_capped
boolean
required
True when counting stopped at the cap: there are at least total connections.
generated_at
string<date-time>
required
When the answer was made. For an answer read through /v1/job, earlier than the read.
next_cursor
string
Present when more connections follow; absent on the last page. See cursor.
{"docsConfig":{"theme":"maple","$schema":"https://mintlify.com/docs.json","name":"Orbb","description":"Who knows whom, and how well. The Orbb API and MCP server: find a person, list who they know, test whether two people know each other, and find who could introduce you.","colors":{"primary":"#0F4A52","light":"#FD8862","dark":"#0F4A52"},"logo":{"light":"https://mintcdn.com/orbb/fWzU-Pd1c801Da8W/logo/light.svg?fit=max\u0026auto=format\u0026n=fWzU-Pd1c801Da8W\u0026q=85\u0026s=a78a0e2c9c47cbbdc833ef9c7505b822","dark":"https://mintcdn.com/orbb/fWzU-Pd1c801Da8W/logo/dark.svg?fit=max\u0026auto=format\u0026n=fWzU-Pd1c801Da8W\u0026q=85\u0026s=ef7c33c68f3bed3e0e6556784016cb21","href":"https://orbb.com"},"favicon":"https://mintcdn.com/orbb/fWzU-Pd1c801Da8W/favicon.svg?fit=max\u0026auto=format\u0026n=fWzU-Pd1c801Da8W\u0026q=85\u0026s=07577e321c3dd7a878511daba9f490f7","api":{"openapi":"api-reference/openapi.json","params":{"expanded":"all"},"playground":{"display":"interactive"},"examples":{"languages":["curl","python","javascript","go"],"prefill":true},"url":"full"},"appearance":{"default":"system"},"background":{"color":{"light":"#FBF9F6","dark":"#0B1A1C"}},"navbar":{"links":[{"href":"https://platform.orbb.com/console","label":"Console"},{"href":"mailto:support@orbb.com","label":"Support"}],"primary":{"type":"button","label":"Get an API key","href":"https://platform.orbb.com/console/keys"}},"footer":{"socials":{"website":"https://orbb.com"}},"seo":{"metatags":{"og:site_name":"Orbb Developers"}},"fonts":{"heading":{"family":"Tomato Grotesk","source":"fonts/TomatoGrotesk.woff2","format":"woff2"},"body":{"family":"Inter"}},"icons":{"library":"lucide"},"styling":{"codeblocks":"system","latex":false},"errors":{"404":{"redirect":false,"title":"Not here","description":"That page does not exist. Try search, or start at the [introduction](/)."}},"contextual":{"options":["copy","view","claude","chatgpt","cursor","vscode","mcp","add-mcp"],"display":"header"},"variables":{"docs_url":"https://docs.orbb.com"},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"orbb","hasAudioNarration":false,"actualSubdomain":"orbb","customDomains":["docs.orbb.com"],"gitSource":{"type":"github","owner":"intail-ai","repo":"orbb-app","deployBranch":"din/developer-docs","contentDirectory":"developers","isPrivate":true,"mountPath":"","label":"","_id":"6afb0a956b0360be0a17d2ce"},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6afb32a06b660d83a8fe4d48","clientVersion":"0.0.4149","searchFilterCounts":[{"language":"default","tag":"Integrations","count":10},{"language":"default","tag":"API reference","count":7},{"language":"default","tag":"Using the API","count":6},{"language":"default","tag":"MCP","count":6},{"language":"default","tag":"Calls, messaging and outreach","count":4},{"language":"default","tag":"Get started","count":3},{"language":"default","tag":"Concepts","count":3},{"language":"default","tag":"Mail and calendar","count":3},{"language":"default","tag":"CRM","count":2}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/circle","slug":"/api-reference/circle","pageMetadata":{"openapi":"POST /v1/circle","sidebarTitle":"Circle","title":"List the people connected to a person","description":"Body: `{ \"id\": … }`, plus the optional fields below.\n\nLists the people connected to one person, strongest first, a page at a time. Each entry carries the other person, the verdict and strength of the connection, and its evidence; the answer also says what research has been done for the person.\n\nChecked in order: the body (`400 invalid_body`), `limit`, `min_strength`, `cursor`, `types`, `max_tokens`; with `on_miss: RESEARCH` only, the research and resolve jobs still running (`429 research_busy`); then, for every call, the balance (`402`).\n\nSee also [`/v1/paths`](/api-reference/paths), [`/v1/resolve`](/api-reference/resolve), [Jobs](/api/jobs), [Billing](/api/billing), [Rate limits](/api/rate-limits).","href":"/api-reference/circle"},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n a: \"a\",\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsxs(_components.p, {\n children: [\"Body: \", _jsx(_components.code, {\n children: \"{ \\\"id\\\": … }\"\n }), \", plus the optional fields below.\"]\n }), \"\\n\", _jsx(_components.p, {\n children: \"Lists the people connected to one person, strongest first, a page at a time. Each entry carries the other person, the verdict and strength of the connection, and its evidence; the answer also says what research has been done for the person.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Checked in order: the body (\", _jsx(_components.code, {\n children: \"400 invalid_body\"\n }), \"), \", _jsx(_components.code, {\n children: \"limit\"\n }), \", \", _jsx(_components.code, {\n children: \"min_strength\"\n }), \", \", _jsx(_components.code, {\n children: \"cursor\"\n }), \", \", _jsx(_components.code, {\n children: \"types\"\n }), \", \", _jsx(_components.code, {\n children: \"max_tokens\"\n }), \"; with \", _jsx(_components.code, {\n children: \"on_miss: RESEARCH\"\n }), \" only, the research and resolve jobs still running (\", _jsx(_components.code, {\n children: \"429 research_busy\"\n }), \"); then, for every call, the balance (\", _jsx(_components.code, {\n children: \"402\"\n }), \").\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"See also \", _jsx(_components.a, {\n href: \"/api-reference/paths\",\n children: _jsx(_components.code, {\n children: \"/v1/paths\"\n })\n }), \", \", _jsx(_components.a, {\n href: \"/api-reference/resolve\",\n children: _jsx(_components.code, {\n children: \"/v1/resolve\"\n })\n }), \", \", _jsx(_components.a, {\n href: \"/api/jobs\",\n children: \"Jobs\"\n }), \", \", _jsx(_components.a, {\n href: \"/api/billing\",\n children: \"Billing\"\n }), \", \", _jsx(_components.a, {\n href: \"/api/rate-limits\",\n children: \"Rate limits\"\n }), \".\"]\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"codeStyling":"system","config":{},"pageMetadata":{"openapi":"POST /v1/circle","sidebarTitle":"Circle","title":"List the people connected to a person","description":"Body: `{ \"id\": … }`, plus the optional fields below.\n\nLists the people connected to one person, strongest first, a page at a time. Each entry carries the other person, the verdict and strength of the connection, and its evidence; the answer also says what research has been done for the person.\n\nChecked in order: the body (`400 invalid_body`), `limit`, `min_strength`, `cursor`, `types`, `max_tokens`; with `on_miss: RESEARCH` only, the research and resolve jobs still running (`429 research_busy`); then, for every call, the balance (`402`).\n\nSee also [`/v1/paths`](/api-reference/paths), [`/v1/resolve`](/api-reference/resolve), [Jobs](/api/jobs), [Billing](/api/billing), [Rate limits](/api/rate-limits).","href":"/api-reference/circle"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"circle","summary":"List the people connected to a person","description":"Body: `{ \"id\": … }`, plus the optional fields below.\n\nLists the people connected to one person, strongest first, a page at a time. Each entry carries the other person, the verdict and strength of the connection, and its evidence; the answer also says what research has been done for the person.\n\nChecked in order: the body (`400 invalid_body`), `limit`, `min_strength`, `cursor`, `types`, `max_tokens`; with `on_miss: RESEARCH` only, the research and resolve jobs still running (`429 research_busy`); then, for every call, the balance (`402`).\n\nSee also [`/v1/paths`](/api-reference/paths), [`/v1/resolve`](/api-reference/resolve), [Jobs](/api/jobs), [Billing](/api/billing), [Rate limits](/api/rate-limits).","requestBody":"ae122cfe-980e-4e67-bcd3-552c717559aa","responses":{"200":"13d16e58-9a15-4164-a47b-8e7760328137","202":"271b1f62-c14d-467c-a135-cba2bc6067f4","400":"37e44ff4-64c7-4726-9ec1-7f806ff14438","401":"f303f649-94a2-4576-9b66-e5943617328b","402":"9e3abbe8-6b20-406d-a0ea-41366989e23c","404":"dbe369d7-acd5-499a-9e50-0ac71dcf27c1","422":"7cd3ec50-e6bf-4d88-b993-8ab56d858962","429":"e37d0b65-e456-43b6-a749-aba609566a84","503":"aa4a4297-cc38-4ed0-ae09-10951bf25fb9"},"method":"post","type":"path","servers":["0727b844-8410-4aec-84c5-b31bc2f7b788"],"security":["bfc1b1af-45ac-4d66-806e-96d74a0cc685"],"path":"/v1/circle","baseUrlOptions":["https://api.orbb.com"],"title":"List the people connected to a person","codeSamples":[],"requestExampleLanguages":["bash","python","javascript","go"],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[{"body.id":"maya-okafor","body.limit":2}],"urlDisplay":"full"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"Names the person whose connections are listed: a LinkedIn profile URL, or the public identifier from one (the part after `/in/`). Spaces around it are ignored; a blank value is answered `400 invalid_body`. An id no person matches is answered `404 person_not_found`; one that several people have held, `422 ambiguous_person` with `candidates`.\n\nA LinkedIn member token (`ACoAA…`) is not a public identifier: it is answered `404 person_not_found`.\n\nSee also [`/v1/resolve`](/api-reference/resolve), to find the id from an email or a name.","type":"string","minLength":1,"maxLength":512,"isRequired":true,"uniqueKey":"id","typeLabel":"string"},"types":{"minItems":1,"x-default":"every type","description":"Restricts the answer to these connection types: `CAREER` (worked at the same company at the same time), `EDUCATION` (studied at the same school), `INVESTOR` (held investor roles at the same companies), `LINKEDIN_COMMENTS` (one commented on the other’s LinkedIn post). An empty array, or a member that is not a connection type, is answered `400 invalid_types`.\n\nA type listed twice counts once. With `on_miss: RESEARCH`, only the listed types are researched.\n\nSee also `on_miss`.\n\nDefault: every type.","maxItems":64,"type":"array","items":{"enum":["CAREER","EDUCATION","INVESTOR","LINKEDIN_COMMENTS"],"type":"string","maxLength":64,"uniqueKey":"types.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"types","typeLabel":"enum\u003cstring>[]"},"min_strength":{"minimum":0,"maximum":1,"description":"Leaves out people whose connection strength is below this value; stronger connections score higher, and `0` keeps everyone. A value outside the range is answered `400 invalid_min_strength`.\n\n`total` and the pages count only the people kept.\n\nSee also `limit`, `cursor`.","default":0,"type":"number","uniqueKey":"min_strength","typeLabel":"number"},"limit":{"type":"integer","minimum":1,"maximum":100,"description":"Sets the maximum number of people returned in one answer. A value outside the range, or one that is not an integer, is answered `400 invalid_limit`.\n\nWhen more people match, the answer carries `next_cursor`; pass it as `cursor` with the same body to read the next page. People are ordered by strength, strongest first.\n\nSee also `cursor`.","default":25,"uniqueKey":"limit","typeLabel":"integer"},"cursor":{"description":"Continues a listing from the previous answer’s `next_cursor`, with the rest of the body unchanged. Absent or blank reads the first page. A value that does not decode as a cursor is answered `400 invalid_cursor`.\n\nA cursor is a position in the order, not a query: one from another query, or with other `types` or `min_strength`, is not refused and starts at that position in the new order.\n\nEach page reads the data as it stands at that call, so a connection whose strength changed between pages can be listed twice or not at all.\n\nSee also `limit`, `next_cursor`.","type":"string","maxLength":512,"uniqueKey":"cursor","typeLabel":"string"},"on_miss":{"description":"Sets what happens to a requested type not yet researched for the people asked about. `UNKNOWN` answers from what is known and reports the type in the answer’s `coverage`; `RESEARCH` researches the requested types first, then answers. Any other value is answered `400 invalid_body`.\n\n`RESEARCH` takes longer, and is more often answered `202` with a job to read through `/v1/job`. A type researched recently is mostly not researched again; on circle and paths, `force` researches it anyway.\n\nSee also `max_tokens`, `force`, [`/v1/job`](/api-reference/job), [Jobs](/api/jobs), [Billing](/api/billing), [Rate limits](/api/rate-limits).","default":"UNKNOWN","type":"string","enum":["UNKNOWN","RESEARCH"],"uniqueKey":"on_miss","typeLabel":"enum\u003cstring>"},"force":{"description":"With `on_miss: RESEARCH`, researches every requested type again, even one researched recently. Without `RESEARCH` it has no effect, and is not refused.\n\nSee also `on_miss`, `types`.","default":false,"type":"boolean","uniqueKey":"force","typeLabel":"boolean"},"max_tokens":{"minimum":0.001,"maximum":600,"x-default":"`2` with `on_miss: RESEARCH`","description":"Sets the tokens reserved for research on top of the call’s price. Taken only with `on_miss: RESEARCH`: with any other `on_miss`, even within the range, it is answered `400 invalid_max_tokens`; so is a value outside the range, or one with more than 3 decimals.\n\nThe range starts above zero: to research nothing, leave out `RESEARCH`.\n\nSee also `on_miss`, [Billing](/api/billing).\n\nDefault: `2` with `on_miss: RESEARCH`.","type":"number","uniqueKey":"max_tokens","typeLabel":"number"}},"required":["id"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"example":{"id":"maya-okafor","limit":2},"examples":{"Example":{"title":"Example","value":{"id":"maya-okafor","limit":2}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"13d16e58-9a15-4164-a47b-8e7760328137":{"description":"A page of the person’s connections.","headers":{"X-Request-Id":{"description":"The id of the request. Every answer carries it; an error body repeats it as `request_id`. See Request ids.","schema":{"type":"string"}},"RateLimit-Limit":{"description":"The calls the account may make per minute. On every answer past authentication: not on a `401`, nor on a `400 invalid_body` for a body that could not be parsed. See Rate limits.","schema":{"type":"integer"}},"X-Orbb-Reserved":{"description":"The tokens the call reserved. On the answers of a call that reserved, a `202` included; not on a refusal before the reservation, nor on a `503` whose reservation was returned. `/v1/job` answers do not carry it. See Billing.","schema":{"type":"number"}},"X-Orbb-Balance":{"description":"The tokens available after the reservation. On the same answers as `X-Orbb-Reserved`.","schema":{"type":"number"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"subject":{"description":"The person whose connections are listed: `id` of a circle, `target` of paths.","type":"object","properties":{"key":{"description":"The person’s key: the public identifier percent-decoded and lower-cased. Two people in the answers are the same person when their keys are equal.","type":"string","isRequired":true,"uniqueKey":"subject.key","typeLabel":"string"},"publicId":{"description":"The person’s current LinkedIn public identifier, the part after `/in/` of the profile URL. It is a valid `id`, `a`, `b` or `target` in any call. For a person with no known profile, the identifier as the call gave it, in the form of `key`.","type":"string","isRequired":true,"uniqueKey":"subject.publicId","typeLabel":"string"},"resolution":{"description":"How the id given in the call was matched to this person.","type":"object","properties":{"status":{"description":"`RESOLVED`: one profile matches. `AMBIGUOUS`: several profiles match, listed in `candidates`. `UNRESOLVED`: no profile matches.\n\nIn circle, edge and paths answers it is `RESOLVED`, or `UNRESOLVED` for a person with no known profile whose connections are known under the id given; an ambiguous id is answered `422 ambiguous_person` instead.","type":"string","enum":["RESOLVED","AMBIGUOUS","UNRESOLVED"],"isRequired":true,"uniqueKey":"subject.resolution.status","typeLabel":"enum\u003cstring>"},"method":{"description":"What answered: `EMAIL` (the email), `NAME_COMPANY` (a search by name, the name sent or one taken from the email, run without an email or after the email alone found no one), `PUBLIC_ID` (a public identifier), `LINKEDIN_URL` (a profile URL); an email or name search answered `UNRESOLVED` names the form searched, `EMAIL` when an email was sent, else `NAME_COMPANY`; a lookup by id keeps its identifier method whatever the status.","type":"string","enum":["PUBLIC_ID","LINKEDIN_URL","EMAIL","NAME_COMPANY"],"isRequired":true,"uniqueKey":"subject.resolution.method","typeLabel":"enum\u003cstring>"},"candidates":{"description":"With `AMBIGUOUS` only: every matching profile. See also `422 ambiguous_person`.","type":"array","items":{"type":"object","properties":{"key":{"description":"The person’s key: the public identifier percent-decoded and lower-cased. Two people in the answers are the same person when their keys are equal.","type":"string","isRequired":true,"uniqueKey":"subject.resolution.candidates.items.[INDEX].key","typeLabel":"string"},"publicId":{"description":"The person’s current LinkedIn public identifier, the part after `/in/` of the profile URL. It is a valid `id`, `a`, `b` or `target` in any call. For a person with no known profile, the identifier as the call gave it, in the form of `key`.","type":"string","isRequired":true,"uniqueKey":"subject.resolution.candidates.items.[INDEX].publicId","typeLabel":"string"},"full_name":{"description":"The person’s name. Absent when no known profile carries one.","type":"string","uniqueKey":"subject.resolution.candidates.items.[INDEX].full_name","typeLabel":"string"},"role":{"description":"The title of the person’s current position; without one, the profile’s headline. Absent when the profile has neither, or no profile is known.","type":"string","uniqueKey":"subject.resolution.candidates.items.[INDEX].role","typeLabel":"string"},"company":{"description":"The name of the company of the current position shown. Absent when unknown.","type":"string","uniqueKey":"subject.resolution.candidates.items.[INDEX].company","typeLabel":"string"},"companyPublicId":{"description":"The LinkedIn page of that company, as `company/\u003cslug>`, or `showcase/\u003cslug>` for a showcase page. Absent when unknown.","type":"string","uniqueKey":"subject.resolution.candidates.items.[INDEX].companyPublicId","typeLabel":"string"}},"required":["key","publicId"],"uniqueKey":"subject.resolution.candidates.items.[INDEX]","typeLabel":"object"},"uniqueKey":"subject.resolution.candidates","typeLabel":"object[]"}},"required":["status","method"],"isRequired":true,"uniqueKey":"subject.resolution","typeLabel":"object"},"full_name":{"description":"The person’s name. Absent when no known profile carries one.","type":"string","uniqueKey":"subject.full_name","typeLabel":"string"},"role":{"description":"The title of the person’s current position; without one, the profile’s headline. Absent when the profile has neither, or no profile is known.","type":"string","uniqueKey":"subject.role","typeLabel":"string"},"company":{"description":"The name of the company of the current position shown. Absent when unknown.","type":"string","uniqueKey":"subject.company","typeLabel":"string"},"companyPublicId":{"description":"The LinkedIn page of that company, as `company/\u003cslug>`, or `showcase/\u003cslug>` for a showcase page. Absent when unknown.","type":"string","uniqueKey":"subject.companyPublicId","typeLabel":"string"}},"required":["key","publicId","resolution"],"isRequired":true,"uniqueKey":"subject","typeLabel":"object"},"research_state":{"description":"What research the API has done for the subject.","type":"object","properties":{"status":{"description":"The research state of the subject over the requested types. `RESEARCHED`: the last research of at least one type completed, and none is out of date. `STALE`: one completed and is out of date. `NEVER_RESEARCHED`: none completed; each has not run, is running (a re-run included), or failed.\n\nFor a person known under several ids, a completed research under any of them counts before a running or failed one under another.","type":"string","enum":["RESEARCHED","NEVER_RESEARCHED","STALE"],"isRequired":true,"uniqueKey":"research_state.status","typeLabel":"enum\u003cstring>"},"types":{"description":"One entry per requested type, in the order requested.","type":"array","items":{"type":"object","properties":{"type":{"description":"The connection type.","type":"string","enum":["CAREER","EDUCATION","INVESTOR","LINKEDIN_COMMENTS"],"isRequired":true,"uniqueKey":"research_state.types.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"coverage":{"description":"`EXAMINED`: the last research of the type completed, and at least one connection of the type is known. `SEARCHED_NO_RESULT`: it completed, and none is. `UNAVAILABLE`: the last research of the type failed, even when an earlier one completed. `NOT_EXAMINED`: no research of the type has completed, or one is running now, a re-run included.","type":"string","enum":["EXAMINED","SEARCHED_NO_RESULT","UNAVAILABLE","NOT_EXAMINED"],"isRequired":true,"uniqueKey":"research_state.types.items.[INDEX].coverage","typeLabel":"enum\u003cstring>"},"stale":{"description":"Whether the research is old enough to be out of date. Never true for `LINKEDIN_COMMENTS`, which is kept current as comments are found.","type":"boolean","isRequired":true,"uniqueKey":"research_state.types.items.[INDEX].stale","typeLabel":"boolean"},"depth":{"description":"How deep the last research of the type read; for a failed one, the part that ran. Absent while a research of the type runs, when none has ended, and when the last one failed as a whole.","type":"string","enum":["STANDARD"],"uniqueKey":"research_state.types.items.[INDEX].depth","typeLabel":"enum\u003cstring>"},"completed_at":{"description":"When the last research of the type ended, completed or failed. Absent while a research of the type runs, and when none has ended.","format":"date-time","type":"string","uniqueKey":"research_state.types.items.[INDEX].completed_at","typeLabel":"string\u003cdate-time>"},"truncated":{"description":"True when the source cut the last research short, so connections can be missing. Absent while a research of the type runs, when none has ended, when the last one failed as a whole, and when none was recorded.","type":"boolean","uniqueKey":"research_state.types.items.[INDEX].truncated","typeLabel":"boolean"},"candidates":{"description":"How many people the last research of the type considered. Absent while a research of the type runs, and when not recorded.","type":"number","uniqueKey":"research_state.types.items.[INDEX].candidates","typeLabel":"number"},"judged":{"description":"How many of those people it assessed. Absent while a research of the type runs, and when not recorded.","type":"number","uniqueKey":"research_state.types.items.[INDEX].judged","typeLabel":"number"}},"required":["type","coverage","stale"],"uniqueKey":"research_state.types.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"research_state.types","typeLabel":"object[]"}},"required":["status","types"],"isRequired":true,"uniqueKey":"research_state","typeLabel":"object"},"hit":{"description":"`RESEARCHED` when the last research of every requested type completed for the subject and none is out of date; `UNKNOWN` otherwise, a research running now included (for a person known under several ids, see `research_state.status`).","type":"string","enum":["RESEARCHED","UNKNOWN"],"isRequired":true,"uniqueKey":"hit","typeLabel":"enum\u003cstring>"},"basis":{"description":"What the answer is based on. `NETWORK_ONLY`, the only value today: connections inferred from public professional profiles and activity.","type":"string","enum":["NETWORK_ONLY"],"isRequired":true,"uniqueKey":"basis","typeLabel":"enum\u003cstring>"},"coverage":{"description":"For each requested type, what the subject’s research found, with the limits that apply to the whole answer.","type":"object","properties":{"examined":{"description":"The types with a connection found. For a circle’s subject: researched, with at least one connection of the type.","type":"array","items":{"type":"string","enum":["CAREER","EDUCATION","INVESTOR","LINKEDIN_COMMENTS"],"uniqueKey":"coverage.examined.items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":true,"uniqueKey":"coverage.examined","typeLabel":"enum\u003cstring>[]"},"searched_no_result":{"description":"The types checked with nothing found. For a circle’s subject: researched, with no connection of the type.","type":"array","items":{"type":"string","enum":["CAREER","EDUCATION","INVESTOR","LINKEDIN_COMMENTS"],"uniqueKey":"coverage.searched_no_result.items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":true,"uniqueKey":"coverage.searched_no_result","typeLabel":"enum\u003cstring>[]"},"unavailable":{"description":"The types whose research failed: for a pair, a research run in this call; for a circle’s subject, a type whose last research failed, even when an earlier one completed (for a person known under several ids, see `research_state.status`).","type":"array","items":{"type":"string","enum":["CAREER","EDUCATION","INVESTOR","LINKEDIN_COMMENTS"],"uniqueKey":"coverage.unavailable.items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":true,"uniqueKey":"coverage.unavailable","typeLabel":"enum\u003cstring>[]"},"not_examined":{"description":"The types not checked. For a circle’s subject: no research of the type has completed, or one is running now, a re-run included (for a person known under several ids, see `research_state.status`).\n\nFor a pair, `LINKEDIN_COMMENTS` with no connection found is always here: no comment found does not mean that none exists.","type":"array","items":{"type":"string","enum":["CAREER","EDUCATION","INVESTOR","LINKEDIN_COMMENTS"],"uniqueKey":"coverage.not_examined.items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":true,"uniqueKey":"coverage.not_examined","typeLabel":"enum\u003cstring>[]"},"limits":{"description":"What limits the answer for a type, one entry per type and reason.\n\nThe limits a type always has (`NO_LIVE_SEARCH`, `NEVER_ALONE`) are stated once per answer: in a circle or paths answer on the top-level `coverage`, not on each entry of `data`.","type":"array","items":{"type":"object","properties":{"type":{"description":"The type the limit applies to.","type":"string","enum":["CAREER","EDUCATION","INVESTOR","LINKEDIN_COMMENTS"],"isRequired":true,"uniqueKey":"coverage.limits.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"reason":{"description":"`SOURCE_LIMITED`: the source cut the research short, or the shared companies of a career connection can no longer be shown. `NO_LIVE_SEARCH`: comments are read from those already known; a call never searches for new ones. `EXCLUDED_BY_SCAN`: the research run in this call left the other person out, so the pair was not checked. `NEVER_ALONE`: an education match is shown only next to another type. `STALE`: the research or the check of the type is old enough to be out of date.","type":"string","enum":["SOURCE_LIMITED","NO_LIVE_SEARCH","EXCLUDED_BY_SCAN","NEVER_ALONE","STALE"],"isRequired":true,"uniqueKey":"coverage.limits.items.[INDEX].reason","typeLabel":"enum\u003cstring>"}},"required":["type","reason"],"uniqueKey":"coverage.limits.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"coverage.limits","typeLabel":"object[]"}},"required":["examined","searched_no_result","unavailable","not_examined","limits"],"isRequired":true,"uniqueKey":"coverage","typeLabel":"object"},"data":{"description":"The page of connections, strongest first. It can hold fewer than `limit` entries even when `next_cursor` is present.","type":"array","items":{"type":"object","properties":{"verdict":{"description":"Whether the two people likely know each other. `LIKELY_KNOW`: a comment between them was found. `POSSIBLE`: another requested type was found. `NO_EVIDENCE_FOUND`: every requested type that can be checked was checked, with nothing found. `UNKNOWN`: none of these; `verdict_reason` says why.","type":"string","enum":["LIKELY_KNOW","POSSIBLE","NO_EVIDENCE_FOUND","UNKNOWN"],"isRequired":true,"uniqueKey":"data.items.[INDEX].verdict","typeLabel":"enum\u003cstring>"},"verdict_reason":{"description":"Why the verdict is what it is: `DIRECT_INTERACTION` for `LIKELY_KNOW`, `SHARED_HISTORY` for `POSSIBLE`, `SEARCHED_NO_RESULT` for `NO_EVIDENCE_FOUND`; for `UNKNOWN`, `UNAVAILABLE` when the research of a type failed in this call, otherwise `NOT_EXAMINED`.","type":"string","enum":["DIRECT_INTERACTION","SHARED_HISTORY","SEARCHED_NO_RESULT","UNAVAILABLE","NOT_EXAMINED"],"isRequired":true,"uniqueKey":"data.items.[INDEX].verdict_reason","typeLabel":"enum\u003cstring>"},"evidence":{"description":"One entry per requested type found, with what was found.","type":"array","items":{"type":"object","properties":{"type":{"description":"The connection type this evidence is for.","type":"string","enum":["CAREER","EDUCATION","INVESTOR","LINKEDIN_COMMENTS"],"isRequired":true,"uniqueKey":"data.items.[INDEX].evidence.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"score":{"description":"The type’s score, 0 to 1, as in `strength.witnesses`.","type":"number","isRequired":true,"uniqueKey":"data.items.[INDEX].evidence.items.[INDEX].score","typeLabel":"number"},"summary":{"description":"One sentence that states the evidence, for display. Not meant to be parsed.","type":"string","isRequired":true,"uniqueKey":"data.items.[INDEX].evidence.items.[INDEX].summary","typeLabel":"string"},"sources":{"description":"Where the evidence comes from, and when it was observed.","type":"array","items":{"type":"object","properties":{"observed_at":{"format":"date-time","description":"When the evidence was observed.","type":"string","isRequired":true,"uniqueKey":"data.items.[INDEX].evidence.items.[INDEX].sources.items.[INDEX].observed_at","typeLabel":"string\u003cdate-time>"},"provider":{"description":"The profile source the other person’s profile was read from; `LINKEDIN_POST_COMMENTS` for comments. Absent when the other person has no known profile.","type":"string","enum":["LINKEDIN_PROFILES","MAIN_DATASET","OLD_DATASET","LINKEDIN_POST_COMMENTS"],"uniqueKey":"data.items.[INDEX].evidence.items.[INDEX].sources.items.[INDEX].provider","typeLabel":"enum\u003cstring>"}},"required":["observed_at"],"uniqueKey":"data.items.[INDEX].evidence.items.[INDEX].sources.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"data.items.[INDEX].evidence.items.[INDEX].sources","typeLabel":"object[]"},"model_score":{"description":"The match score of the type: for `INVESTOR`, 0, 0.5 or 1 per shared organization, summed; for `EDUCATION`, how closely the degree names match. Absent for the other types.","type":"number","uniqueKey":"data.items.[INDEX].evidence.items.[INDEX].model_score","typeLabel":"number"},"overlap_days":{"description":"`CAREER` only: the days both worked at the shared companies at the same time. Absent for the other types.","type":"number","uniqueKey":"data.items.[INDEX].evidence.items.[INDEX].overlap_days","typeLabel":"number"},"days_since_worked_together":{"description":"`CAREER` only: the days since they last worked at the same company at the same time.","type":"number","uniqueKey":"data.items.[INDEX].evidence.items.[INDEX].days_since_worked_together","typeLabel":"number"},"company_count":{"description":"`CAREER` only: the number of companies both worked at together. It can be more than `companies` lists.","type":"number","uniqueKey":"data.items.[INDEX].evidence.items.[INDEX].company_count","typeLabel":"number"},"companies":{"description":"`CAREER`: the shared employers, with the months both were there. Empty when the profiles no longer show the overlap; `coverage.limits` then carries `SOURCE_LIMITED`.\n\n`INVESTOR`: the organizations where both held founder, board or investor roles.\n\nAbsent for the other types.","type":"array","items":{"type":"object","properties":{"public_id":{"description":"The organization’s LinkedIn page, as `company/\u003cslug>`, or `showcase/\u003cslug>` for a showcase page.","type":"string","isRequired":true,"uniqueKey":"data.items.[INDEX].evidence.items.[INDEX].companies.items.[INDEX].public_id","typeLabel":"string"},"name":{"description":"The organization’s name. Absent when unknown.","type":"string","uniqueKey":"data.items.[INDEX].evidence.items.[INDEX].companies.items.[INDEX].name","typeLabel":"string"},"from":{"description":"`CAREER` only: the first month both were there, `YYYY-MM`.","type":"string","uniqueKey":"data.items.[INDEX].evidence.items.[INDEX].companies.items.[INDEX].from","typeLabel":"string"},"to":{"description":"`CAREER` only: the last month both were there, `YYYY-MM`. Absent while both are still there.","type":"string","uniqueKey":"data.items.[INDEX].evidence.items.[INDEX].companies.items.[INDEX].to","typeLabel":"string"},"company_size":{"description":"`INVESTOR` only: the organization’s number of employees. Absent when unknown.","type":"number","uniqueKey":"data.items.[INDEX].evidence.items.[INDEX].companies.items.[INDEX].company_size","typeLabel":"number"},"subject_titles":{"description":"`INVESTOR` only: the subject’s founder, board or investor titles there. The subject is the circle’s person, or `a` in an edge.","type":"array","items":{"type":"string","uniqueKey":"data.items.[INDEX].evidence.items.[INDEX].companies.items.[INDEX].subject_titles.items.[INDEX]","typeLabel":"string"},"uniqueKey":"data.items.[INDEX].evidence.items.[INDEX].companies.items.[INDEX].subject_titles","typeLabel":"string[]"},"person_titles":{"description":"`INVESTOR` only: the other person’s titles there.","type":"array","items":{"type":"string","uniqueKey":"data.items.[INDEX].evidence.items.[INDEX].companies.items.[INDEX].person_titles.items.[INDEX]","typeLabel":"string"},"uniqueKey":"data.items.[INDEX].evidence.items.[INDEX].companies.items.[INDEX].person_titles","typeLabel":"string[]"}},"required":["public_id"],"uniqueKey":"data.items.[INDEX].evidence.items.[INDEX].companies.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.items.[INDEX].evidence.items.[INDEX].companies","typeLabel":"object[]"},"windows":{"description":"`INVESTOR` only: the months both held an investor role at an organization. An organization without such a period is in `companies` only.","type":"array","items":{"type":"object","properties":{"public_id":{"description":"The organization’s LinkedIn page, as `company/\u003cslug>`, or `showcase/\u003cslug>` for a showcase page.","type":"string","isRequired":true,"uniqueKey":"data.items.[INDEX].evidence.items.[INDEX].windows.items.[INDEX].public_id","typeLabel":"string"},"from":{"description":"The first month of the period, `YYYY-MM`.","type":"string","isRequired":true,"uniqueKey":"data.items.[INDEX].evidence.items.[INDEX].windows.items.[INDEX].from","typeLabel":"string"},"name":{"description":"The organization’s name. Absent when unknown.","type":"string","uniqueKey":"data.items.[INDEX].evidence.items.[INDEX].windows.items.[INDEX].name","typeLabel":"string"},"to":{"description":"The last month of the period, `YYYY-MM`. Absent while it goes on.","type":"string","uniqueKey":"data.items.[INDEX].evidence.items.[INDEX].windows.items.[INDEX].to","typeLabel":"string"}},"required":["public_id","from"],"uniqueKey":"data.items.[INDEX].evidence.items.[INDEX].windows.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.items.[INDEX].evidence.items.[INDEX].windows","typeLabel":"object[]"},"schools":{"description":"`EDUCATION` only: the schools both attended. Can be empty.","type":"array","items":{"type":"string","uniqueKey":"data.items.[INDEX].evidence.items.[INDEX].schools.items.[INDEX]","typeLabel":"string"},"uniqueKey":"data.items.[INDEX].evidence.items.[INDEX].schools","typeLabel":"string[]"},"subject_degree":{"description":"`EDUCATION` only: the subject’s degree. A blank string in any of its fields means unknown.","type":"object","properties":{"name":{"description":"The name of the degree as listed.","type":"string","uniqueKey":"data.items.[INDEX].evidence.items.[INDEX].subject_degree.name","typeLabel":"string"},"degree":{"description":"The kind of degree.","type":"string","uniqueKey":"data.items.[INDEX].evidence.items.[INDEX].subject_degree.degree","typeLabel":"string"},"fields":{"description":"The fields of study.","type":"string","uniqueKey":"data.items.[INDEX].evidence.items.[INDEX].subject_degree.fields","typeLabel":"string"}},"uniqueKey":"data.items.[INDEX].evidence.items.[INDEX].subject_degree","typeLabel":"object"},"person_degree":{"description":"`EDUCATION` only: the other person’s degree. A blank string in any of its fields means unknown.","type":"object","properties":{"name":{"description":"The name of the degree as listed.","type":"string","uniqueKey":"data.items.[INDEX].evidence.items.[INDEX].person_degree.name","typeLabel":"string"},"degree":{"description":"The kind of degree.","type":"string","uniqueKey":"data.items.[INDEX].evidence.items.[INDEX].person_degree.degree","typeLabel":"string"},"fields":{"description":"The fields of study.","type":"string","uniqueKey":"data.items.[INDEX].evidence.items.[INDEX].person_degree.fields","typeLabel":"string"}},"uniqueKey":"data.items.[INDEX].evidence.items.[INDEX].person_degree","typeLabel":"object"},"same_start_year_month":{"description":"`EDUCATION` only: not zero when both started at the school in the same year and month.","type":"number","uniqueKey":"data.items.[INDEX].evidence.items.[INDEX].same_start_year_month","typeLabel":"number"},"classification":{"description":"`LINKEDIN_COMMENTS` only: the best class among the comments between them, from `very good` down to `decent`. `irrelevant` is not sent.","type":"string","enum":["irrelevant","decent","good","very good"],"uniqueKey":"data.items.[INDEX].evidence.items.[INDEX].classification","typeLabel":"enum\u003cstring>"},"comment_count":{"description":"`LINKEDIN_COMMENTS` only: the number of comments between them, in both directions.","type":"number","uniqueKey":"data.items.[INDEX].evidence.items.[INDEX].comment_count","typeLabel":"number"},"comments":{"description":"`LINKEDIN_COMMENTS` only: the best of the comments between them, best first. It can hold fewer than `comment_count`.","type":"array","items":{"type":"object","properties":{"by":{"description":"The `key` of the person who commented.","type":"string","isRequired":true,"uniqueKey":"data.items.[INDEX].evidence.items.[INDEX].comments.items.[INDEX].by","typeLabel":"string"},"on":{"description":"The `key` of the author of the post.","type":"string","isRequired":true,"uniqueKey":"data.items.[INDEX].evidence.items.[INDEX].comments.items.[INDEX].on","typeLabel":"string"},"url":{"description":"The URL of the comment.","type":"string","isRequired":true,"uniqueKey":"data.items.[INDEX].evidence.items.[INDEX].comments.items.[INDEX].url","typeLabel":"string"},"classification":{"description":"The class of the comment. `irrelevant` is not sent.","type":"string","enum":["irrelevant","decent","good","very good"],"isRequired":true,"uniqueKey":"data.items.[INDEX].evidence.items.[INDEX].comments.items.[INDEX].classification","typeLabel":"enum\u003cstring>"},"confidence":{"description":"The probability, 0 to 1, that the comment is of that class.","type":"number","isRequired":true,"uniqueKey":"data.items.[INDEX].evidence.items.[INDEX].comments.items.[INDEX].confidence","typeLabel":"number"},"date":{"description":"When the comment was written, ISO 8601.","type":"string","isRequired":true,"uniqueKey":"data.items.[INDEX].evidence.items.[INDEX].comments.items.[INDEX].date","typeLabel":"string"},"post_url":{"description":"The URL of the post. Absent when the comment’s URL is not a feed post’s.","type":"string","uniqueKey":"data.items.[INDEX].evidence.items.[INDEX].comments.items.[INDEX].post_url","typeLabel":"string"}},"required":["by","on","url","classification","confidence","date"],"uniqueKey":"data.items.[INDEX].evidence.items.[INDEX].comments.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.items.[INDEX].evidence.items.[INDEX].comments","typeLabel":"object[]"}},"required":["type","score","summary","sources"],"uniqueKey":"data.items.[INDEX].evidence.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"data.items.[INDEX].evidence","typeLabel":"object[]"},"counter_evidence":{"description":"What weighs against the evidence found. Empty when nothing does.","type":"array","items":{"type":"object","properties":{"kind":{"description":"`LARGE_SHARED_ORGANIZATION`: the shared organization is large enough that sharing it says little about knowing each other.","type":"string","enum":["LARGE_SHARED_ORGANIZATION"],"isRequired":true,"uniqueKey":"data.items.[INDEX].counter_evidence.items.[INDEX].kind","typeLabel":"enum\u003cstring>"},"type":{"description":"The type the evidence weighs against.","type":"string","enum":["CAREER","EDUCATION","INVESTOR","LINKEDIN_COMMENTS"],"isRequired":true,"uniqueKey":"data.items.[INDEX].counter_evidence.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"company_size":{"description":"The organization’s number of employees, above 5000. For `INVESTOR`, given only when every shared organization is that large, and then the largest.","type":"number","isRequired":true,"uniqueKey":"data.items.[INDEX].counter_evidence.items.[INDEX].company_size","typeLabel":"number"}},"required":["kind","type","company_size"],"uniqueKey":"data.items.[INDEX].counter_evidence.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"data.items.[INDEX].counter_evidence","typeLabel":"object[]"},"coverage":{"description":"For each requested type, whether the pair was checked and what was found, with the limits that apply.","type":"object","properties":{"examined":{"description":"The types with a connection found. For a circle’s subject: researched, with at least one connection of the type.","type":"array","items":{"type":"string","enum":["CAREER","EDUCATION","INVESTOR","LINKEDIN_COMMENTS"],"uniqueKey":"data.items.[INDEX].coverage.examined.items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":true,"uniqueKey":"data.items.[INDEX].coverage.examined","typeLabel":"enum\u003cstring>[]"},"searched_no_result":{"description":"The types checked with nothing found. For a circle’s subject: researched, with no connection of the type.","type":"array","items":{"type":"string","enum":["CAREER","EDUCATION","INVESTOR","LINKEDIN_COMMENTS"],"uniqueKey":"data.items.[INDEX].coverage.searched_no_result.items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":true,"uniqueKey":"data.items.[INDEX].coverage.searched_no_result","typeLabel":"enum\u003cstring>[]"},"unavailable":{"description":"The types whose research failed: for a pair, a research run in this call; for a circle’s subject, a type whose last research failed, even when an earlier one completed (for a person known under several ids, see `research_state.status`).","type":"array","items":{"type":"string","enum":["CAREER","EDUCATION","INVESTOR","LINKEDIN_COMMENTS"],"uniqueKey":"data.items.[INDEX].coverage.unavailable.items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":true,"uniqueKey":"data.items.[INDEX].coverage.unavailable","typeLabel":"enum\u003cstring>[]"},"not_examined":{"description":"The types not checked. For a circle’s subject: no research of the type has completed, or one is running now, a re-run included (for a person known under several ids, see `research_state.status`).\n\nFor a pair, `LINKEDIN_COMMENTS` with no connection found is always here: no comment found does not mean that none exists.","type":"array","items":{"type":"string","enum":["CAREER","EDUCATION","INVESTOR","LINKEDIN_COMMENTS"],"uniqueKey":"data.items.[INDEX].coverage.not_examined.items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":true,"uniqueKey":"data.items.[INDEX].coverage.not_examined","typeLabel":"enum\u003cstring>[]"},"limits":{"description":"What limits the answer for a type, one entry per type and reason.\n\nThe limits a type always has (`NO_LIVE_SEARCH`, `NEVER_ALONE`) are stated once per answer: in a circle or paths answer on the top-level `coverage`, not on each entry of `data`.","type":"array","items":{"type":"object","properties":{"type":{"description":"The type the limit applies to.","type":"string","enum":["CAREER","EDUCATION","INVESTOR","LINKEDIN_COMMENTS"],"isRequired":true,"uniqueKey":"data.items.[INDEX].coverage.limits.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"reason":{"description":"`SOURCE_LIMITED`: the source cut the research short, or the shared companies of a career connection can no longer be shown. `NO_LIVE_SEARCH`: comments are read from those already known; a call never searches for new ones. `EXCLUDED_BY_SCAN`: the research run in this call left the other person out, so the pair was not checked. `NEVER_ALONE`: an education match is shown only next to another type. `STALE`: the research or the check of the type is old enough to be out of date.","type":"string","enum":["SOURCE_LIMITED","NO_LIVE_SEARCH","EXCLUDED_BY_SCAN","NEVER_ALONE","STALE"],"isRequired":true,"uniqueKey":"data.items.[INDEX].coverage.limits.items.[INDEX].reason","typeLabel":"enum\u003cstring>"}},"required":["type","reason"],"uniqueKey":"data.items.[INDEX].coverage.limits.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"data.items.[INDEX].coverage.limits","typeLabel":"object[]"}},"required":["examined","searched_no_result","unavailable","not_examined","limits"],"isRequired":true,"uniqueKey":"data.items.[INDEX].coverage","typeLabel":"object"},"hit":{"description":"`RESEARCHED` when at least one requested type was found or checked for the pair; `UNKNOWN` otherwise.","type":"string","enum":["RESEARCHED","UNKNOWN"],"isRequired":true,"uniqueKey":"data.items.[INDEX].hit","typeLabel":"enum\u003cstring>"},"person":{"description":"The other person. With no known profile, only `key` and `publicId` are present.","type":"object","properties":{"key":{"description":"The person’s key: the public identifier percent-decoded and lower-cased. Two people in the answers are the same person when their keys are equal.","type":"string","isRequired":true,"uniqueKey":"data.items.[INDEX].person.key","typeLabel":"string"},"publicId":{"description":"The person’s current LinkedIn public identifier, the part after `/in/` of the profile URL. It is a valid `id`, `a`, `b` or `target` in any call. For a person with no known profile, the identifier as the call gave it, in the form of `key`.","type":"string","isRequired":true,"uniqueKey":"data.items.[INDEX].person.publicId","typeLabel":"string"},"full_name":{"description":"The person’s name. Absent when no known profile carries one.","type":"string","uniqueKey":"data.items.[INDEX].person.full_name","typeLabel":"string"},"role":{"description":"The title of the person’s current position; without one, the profile’s headline. Absent when the profile has neither, or no profile is known.","type":"string","uniqueKey":"data.items.[INDEX].person.role","typeLabel":"string"},"company":{"description":"The name of the company of the current position shown. Absent when unknown.","type":"string","uniqueKey":"data.items.[INDEX].person.company","typeLabel":"string"},"companyPublicId":{"description":"The LinkedIn page of that company, as `company/\u003cslug>`, or `showcase/\u003cslug>` for a showcase page. Absent when unknown.","type":"string","uniqueKey":"data.items.[INDEX].person.companyPublicId","typeLabel":"string"}},"required":["key","publicId"],"isRequired":true,"uniqueKey":"data.items.[INDEX].person","typeLabel":"object"},"strength":{"description":"Present only when a requested type is found. Its absence is not a zero: `verdict` says what is known.","type":"object","properties":{"value":{"description":"How strong the connection is, 0 to 1.\n\nIn circle and paths answers it covers every type, not only the requested ones, and is what the listing is ordered by and `min_strength` filters on. In an edge answer it covers the requested types found.\n\nEach type found sets a lower bound on `value`, its entry in `witnesses`; a second type found can raise it.","type":"number","isRequired":true,"uniqueKey":"data.items.[INDEX].strength.value","typeLabel":"number"},"label":{"description":"The band the value falls in, from `WEAK` up to `VERY_STRONG`. Rely on it rather than on fixed cut-offs of `value`.","type":"string","enum":["VERY_STRONG","STRONG","MODERATE","WEAK"],"isRequired":true,"uniqueKey":"data.items.[INDEX].strength.label","typeLabel":"enum\u003cstring>"},"witnesses":{"description":"The score of each type found, on the scale of `value`, 0 to 1. A type not found has no entry.","type":"object","properties":{"career":{"description":"The `CAREER` score.","type":"number","uniqueKey":"data.items.[INDEX].strength.witnesses.career","typeLabel":"number"},"education":{"description":"The `EDUCATION` score.","type":"number","uniqueKey":"data.items.[INDEX].strength.witnesses.education","typeLabel":"number"},"investor":{"description":"The `INVESTOR` score.","type":"number","uniqueKey":"data.items.[INDEX].strength.witnesses.investor","typeLabel":"number"},"linkedin_comments":{"description":"The `LINKEDIN_COMMENTS` score.","type":"number","uniqueKey":"data.items.[INDEX].strength.witnesses.linkedin_comments","typeLabel":"number"}},"isRequired":true,"uniqueKey":"data.items.[INDEX].strength.witnesses","typeLabel":"object"}},"required":["value","label","witnesses"],"uniqueKey":"data.items.[INDEX].strength","typeLabel":"object"},"observed_at":{"description":"When the newest evidence was observed; with none, when the newest check that found nothing was made. Absent when there is neither.","format":"date-time","type":"string","uniqueKey":"data.items.[INDEX].observed_at","typeLabel":"string\u003cdate-time>"}},"required":["verdict","verdict_reason","evidence","counter_evidence","coverage","hit","person"],"uniqueKey":"data.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"data","typeLabel":"object[]"},"total":{"description":"The number of connections that match `types` and `min_strength`; the pages can list fewer. Counting stops at a cap; see `total_capped`.","type":"number","isRequired":true,"uniqueKey":"total","typeLabel":"number"},"total_capped":{"description":"True when counting stopped at the cap: there are at least `total` connections.","type":"boolean","isRequired":true,"uniqueKey":"total_capped","typeLabel":"boolean"},"generated_at":{"format":"date-time","description":"When the answer was made. For an answer read through `/v1/job`, earlier than the read.","type":"string","isRequired":true,"uniqueKey":"generated_at","typeLabel":"string\u003cdate-time>"},"next_cursor":{"description":"Present when more connections follow; absent on the last page. See `cursor`.","type":"string","uniqueKey":"next_cursor","typeLabel":"string"}},"required":["subject","research_state","hit","basis","coverage","data","total","total_capped","generated_at"],"uniqueKey":"","typeLabel":"object"},"example":{"subject":{"key":"maya-okafor","publicId":"maya-okafor","full_name":"Maya Okafor","role":"VP Engineering","company":"Northwind Labs","companyPublicId":"company/northwind-labs","resolution":{"status":"RESOLVED","method":"PUBLIC_ID"}},"research_state":{"status":"RESEARCHED","types":[{"type":"CAREER","coverage":"EXAMINED","stale":false},{"type":"EDUCATION","coverage":"NOT_EXAMINED","stale":false},{"type":"INVESTOR","coverage":"SEARCHED_NO_RESULT","stale":false},{"type":"LINKEDIN_COMMENTS","coverage":"EXAMINED","stale":false}]},"hit":"UNKNOWN","basis":"NETWORK_ONLY","coverage":{"examined":["CAREER","LINKEDIN_COMMENTS"],"searched_no_result":["INVESTOR"],"unavailable":[],"not_examined":["EDUCATION"],"limits":[{"type":"EDUCATION","reason":"NEVER_ALONE"},{"type":"LINKEDIN_COMMENTS","reason":"NO_LIVE_SEARCH"}]},"data":[{"person":{"key":"daniel-reyes","publicId":"daniel-reyes","full_name":"Daniel Reyes","role":"Head of Partnerships","company":"Contoso","companyPublicId":"company/contoso"},"verdict":"LIKELY_KNOW","verdict_reason":"DIRECT_INTERACTION","strength":{"value":0.72,"label":"STRONG","witnesses":{"career":0.61,"linkedin_comments":0.5}},"evidence":[{"type":"CAREER","score":0.61,"summary":"Worked together at Fabrikam for 3 years, until 2023","sources":[{"provider":"LINKEDIN_PROFILES","observed_at":"2026-10-02T08:14:00.000Z"}],"overlap_days":1126,"days_since_worked_together":1050,"company_count":1,"companies":[{"public_id":"company/fabrikam","name":"Fabrikam","from":"2020-09","to":"2023-10"}]},{"type":"LINKEDIN_COMMENTS","score":0.5,"summary":"1 LinkedIn comment between them; the best is rated good","sources":[{"provider":"LINKEDIN_POST_COMMENTS","observed_at":"2026-09-23T03:28:41.496Z"}],"classification":"good","comment_count":1,"comments":[{"by":"daniel-reyes","on":"maya-okafor","url":"https://www.linkedin.com/feed/update/urn:li:ugcPost:0000000000000000001?commentUrn=example","post_url":"https://www.linkedin.com/feed/update/urn:li:ugcPost:0000000000000000001","classification":"good","confidence":0.81,"date":"2026-08-14T17:02:11.000Z"}]}],"counter_evidence":[],"coverage":{"examined":["CAREER","LINKEDIN_COMMENTS"],"searched_no_result":["INVESTOR"],"unavailable":[],"not_examined":["EDUCATION"],"limits":[]},"hit":"RESEARCHED","observed_at":"2026-10-02T08:14:00.000Z"},{"person":{"key":"priya-natarajan","publicId":"priya-natarajan","full_name":"Priya Natarajan","role":"Director of Product","company":"Northwind Labs","companyPublicId":"company/northwind-labs"},"verdict":"POSSIBLE","verdict_reason":"SHARED_HISTORY","strength":{"value":0.44,"label":"MODERATE","witnesses":{"career":0.44}},"evidence":[{"type":"CAREER","score":0.44,"summary":"Work together at Northwind Labs, for 8 months so far","sources":[{"provider":"LINKEDIN_PROFILES","observed_at":"2026-10-02T08:14:00.000Z"}],"overlap_days":243,"days_since_worked_together":0,"company_count":1,"companies":[{"public_id":"company/northwind-labs","name":"Northwind Labs","from":"2026-03"}]}],"counter_evidence":[],"coverage":{"examined":["CAREER"],"searched_no_result":["INVESTOR","LINKEDIN_COMMENTS"],"unavailable":[],"not_examined":["EDUCATION"],"limits":[]},"hit":"RESEARCHED","observed_at":"2026-10-02T08:14:00.000Z"}],"next_cursor":"eyJvZmZzZXQiOjJ9","total":214,"total_capped":false,"generated_at":"2026-11-16T13:34:10.280Z"},"examples":{"Example":{"title":"Example","value":{"subject":{"key":"maya-okafor","publicId":"maya-okafor","full_name":"Maya Okafor","role":"VP Engineering","company":"Northwind Labs","companyPublicId":"company/northwind-labs","resolution":{"status":"RESOLVED","method":"PUBLIC_ID"}},"research_state":{"status":"RESEARCHED","types":[{"type":"CAREER","coverage":"EXAMINED","stale":false},{"type":"EDUCATION","coverage":"NOT_EXAMINED","stale":false},{"type":"INVESTOR","coverage":"SEARCHED_NO_RESULT","stale":false},{"type":"LINKEDIN_COMMENTS","coverage":"EXAMINED","stale":false}]},"hit":"UNKNOWN","basis":"NETWORK_ONLY","coverage":{"examined":["CAREER","LINKEDIN_COMMENTS"],"searched_no_result":["INVESTOR"],"unavailable":[],"not_examined":["EDUCATION"],"limits":[{"type":"EDUCATION","reason":"NEVER_ALONE"},{"type":"LINKEDIN_COMMENTS","reason":"NO_LIVE_SEARCH"}]},"data":[{"person":{"key":"daniel-reyes","publicId":"daniel-reyes","full_name":"Daniel Reyes","role":"Head of Partnerships","company":"Contoso","companyPublicId":"company/contoso"},"verdict":"LIKELY_KNOW","verdict_reason":"DIRECT_INTERACTION","strength":{"value":0.72,"label":"STRONG","witnesses":{"career":0.61,"linkedin_comments":0.5}},"evidence":[{"type":"CAREER","score":0.61,"summary":"Worked together at Fabrikam for 3 years, until 2023","sources":[{"provider":"LINKEDIN_PROFILES","observed_at":"2026-10-02T08:14:00.000Z"}],"overlap_days":1126,"days_since_worked_together":1050,"company_count":1,"companies":[{"public_id":"company/fabrikam","name":"Fabrikam","from":"2020-09","to":"2023-10"}]},{"type":"LINKEDIN_COMMENTS","score":0.5,"summary":"1 LinkedIn comment between them; the best is rated good","sources":[{"provider":"LINKEDIN_POST_COMMENTS","observed_at":"2026-09-23T03:28:41.496Z"}],"classification":"good","comment_count":1,"comments":[{"by":"daniel-reyes","on":"maya-okafor","url":"https://www.linkedin.com/feed/update/urn:li:ugcPost:0000000000000000001?commentUrn=example","post_url":"https://www.linkedin.com/feed/update/urn:li:ugcPost:0000000000000000001","classification":"good","confidence":0.81,"date":"2026-08-14T17:02:11.000Z"}]}],"counter_evidence":[],"coverage":{"examined":["CAREER","LINKEDIN_COMMENTS"],"searched_no_result":["INVESTOR"],"unavailable":[],"not_examined":["EDUCATION"],"limits":[]},"hit":"RESEARCHED","observed_at":"2026-10-02T08:14:00.000Z"},{"person":{"key":"priya-natarajan","publicId":"priya-natarajan","full_name":"Priya Natarajan","role":"Director of Product","company":"Northwind Labs","companyPublicId":"company/northwind-labs"},"verdict":"POSSIBLE","verdict_reason":"SHARED_HISTORY","strength":{"value":0.44,"label":"MODERATE","witnesses":{"career":0.44}},"evidence":[{"type":"CAREER","score":0.44,"summary":"Work together at Northwind Labs, for 8 months so far","sources":[{"provider":"LINKEDIN_PROFILES","observed_at":"2026-10-02T08:14:00.000Z"}],"overlap_days":243,"days_since_worked_together":0,"company_count":1,"companies":[{"public_id":"company/northwind-labs","name":"Northwind Labs","from":"2026-03"}]}],"counter_evidence":[],"coverage":{"examined":["CAREER"],"searched_no_result":["INVESTOR","LINKEDIN_COMMENTS"],"unavailable":[],"not_examined":["EDUCATION"],"limits":[]},"hit":"RESEARCHED","observed_at":"2026-10-02T08:14:00.000Z"}],"next_cursor":"eyJvZmZzZXQiOjJ9","total":214,"total_capped":false,"generated_at":"2026-11-16T13:34:10.280Z"}}},"exampleType":"examples"}},"exampleType":"examples"},"271b1f62-c14d-467c-a135-cba2bc6067f4":{"description":"The answer is not ready: `job.status` is `PROCESSING`. Read it with `/v1/job`, passing `job.id`. See [Jobs](/api/jobs).","headers":{"X-Request-Id":{"description":"The id of the request. Every answer carries it; an error body repeats it as `request_id`. See Request ids.","schema":{"type":"string"}},"RateLimit-Limit":{"description":"The calls the account may make per minute. On every answer past authentication: not on a `401`, nor on a `400 invalid_body` for a body that could not be parsed. See Rate limits.","schema":{"type":"integer"}},"X-Orbb-Reserved":{"description":"The tokens the call reserved. On the answers of a call that reserved, a `202` included; not on a refusal before the reservation, nor on a `503` whose reservation was returned. `/v1/job` answers do not carry it. See Billing.","schema":{"type":"number"}},"X-Orbb-Balance":{"description":"The tokens available after the reservation. On the same answers as `X-Orbb-Reserved`.","schema":{"type":"number"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"job":{"description":"A job whose answer is not ready (`202`, `PROCESSING`), or that failed (`200` from `/v1/job`, `FAILED`).","type":"object","properties":{"id":{"description":"The job’s id. Pass it to `/v1/job` to read the answer.","type":"string","isRequired":true,"uniqueKey":"job.id","typeLabel":"string"},"status":{"description":"`PROCESSING` in a `202`: the job runs. `FAILED` in a `200` from `/v1/job`: the job failed; this is final. `DONE` in a resolve `200`.","type":"string","enum":["PROCESSING","DONE","FAILED"],"isRequired":true,"uniqueKey":"job.status","typeLabel":"enum\u003cstring>"}},"required":["id","status"],"isRequired":true,"uniqueKey":"job","typeLabel":"object"}},"required":["job"],"uniqueKey":"","typeLabel":"object"},"example":{"job":{"id":"qry_6720f0c2a1b2c3d4e5f60718","status":"PROCESSING"}},"examples":{"Example":{"title":"Example","value":{"job":{"id":"qry_6720f0c2a1b2c3d4e5f60718","status":"PROCESSING"}}}},"exampleType":"examples"}},"exampleType":"examples"},"37e44ff4-64c7-4726-9ec1-7f806ff14438":{"description":"Bad Request.\n\n- `invalid_body`: The body could not be parsed (not valid JSON, larger than 16 kB, or not received in full), or does not match the operation’s body. See [Errors](/api/errors). Fix the body. `detail` names the field when there is one.\n\n- `invalid_limit`: `limit` is outside its range, or is not an integer. Send a `limit` within the range, or leave it out.\n\n- `invalid_types`: `types` is empty, or holds a member that is not a connection type. Send known types, or leave `types` out for every type.\n\n- `invalid_min_strength`: `min_strength` is outside its range. Send a value within the range, or leave it out.\n\n- `invalid_cursor`: `cursor` does not decode as a cursor. Pass an answer’s `next_cursor` as given, or leave `cursor` out to read the first page.\n\n- `invalid_max_tokens`: `max_tokens` is outside its range, has more than 3 decimals, or is sent without `on_miss: RESEARCH`. Fix the value, or leave it out.","headers":{"X-Request-Id":{"description":"The id of the request. Every answer carries it; an error body repeats it as `request_id`. See Request ids.","schema":{"type":"string"}},"RateLimit-Limit":{"description":"The calls the account may make per minute. On every answer past authentication: not on a `401`, nor on a `400 invalid_body` for a body that could not be parsed. See Rate limits.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"The error code. Stable: branch on it.","type":"string","enum":["invalid_body","invalid_session","invalid_api_key","invalid_limit","invalid_types","invalid_min_strength","invalid_cursor","same_person","person_not_found","ambiguous_person","result_unavailable","not_found","too_many_keys","unavailable","rate_limited","too_many_concurrent","research_busy","insufficient_balance","invalid_max_tokens","billing_account_missing"],"isRequired":true,"uniqueKey":"error","typeLabel":"enum\u003cstring>"},"detail":{"description":"A sentence that explains the error, for a person to read. Its wording can change: do not parse it.","type":"string","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"request_id":{"description":"The id of the request, the same as the `X-Request-Id` header.","type":"string","isRequired":true,"uniqueKey":"request_id","typeLabel":"string"},"candidates":{"description":"With `422 ambiguous_person` only: every person the id matched.","type":"array","items":{"type":"object","properties":{"key":{"description":"The person’s key: the public identifier percent-decoded and lower-cased. Two people in the answers are the same person when their keys are equal.","type":"string","isRequired":true,"uniqueKey":"candidates.items.[INDEX].key","typeLabel":"string"},"publicId":{"description":"The person’s current LinkedIn public identifier, the part after `/in/` of the profile URL. It is a valid `id`, `a`, `b` or `target` in any call. For a person with no known profile, the identifier as the call gave it, in the form of `key`.","type":"string","isRequired":true,"uniqueKey":"candidates.items.[INDEX].publicId","typeLabel":"string"},"full_name":{"description":"The person’s name. Absent when no known profile carries one.","type":"string","uniqueKey":"candidates.items.[INDEX].full_name","typeLabel":"string"},"role":{"description":"The title of the person’s current position; without one, the profile’s headline. Absent when the profile has neither, or no profile is known.","type":"string","uniqueKey":"candidates.items.[INDEX].role","typeLabel":"string"},"company":{"description":"The name of the company of the current position shown. Absent when unknown.","type":"string","uniqueKey":"candidates.items.[INDEX].company","typeLabel":"string"},"companyPublicId":{"description":"The LinkedIn page of that company, as `company/\u003cslug>`, or `showcase/\u003cslug>` for a showcase page. Absent when unknown.","type":"string","uniqueKey":"candidates.items.[INDEX].companyPublicId","typeLabel":"string"}},"required":["key","publicId"],"uniqueKey":"candidates.items.[INDEX]","typeLabel":"object"},"uniqueKey":"candidates","typeLabel":"object[]"}},"required":["error","detail","request_id"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"invalid_body","detail":"\u003cstring>","request_id":"\u003cstring>","candidates":[{"key":"\u003cstring>","publicId":"\u003cstring>","full_name":"\u003cstring>","role":"\u003cstring>","company":"\u003cstring>","companyPublicId":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"f303f649-94a2-4576-9b66-e5943617328b":{"description":"Unauthorized.\n\n- `invalid_session`: A token in the form of a session token (three parts separated by dots) was refused: expired, or not a session of the console. Sign in to the console again, or use an API key.\n\n- `invalid_api_key`: The `Authorization` header is missing or is not `Bearer \u003ctoken>`, or the key is unknown, revoked or expired. The answer is the same whatever the reason. Check the key, or create a new one in the console.","headers":{"X-Request-Id":{"description":"The id of the request. Every answer carries it; an error body repeats it as `request_id`. See Request ids.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"The error code. Stable: branch on it.","type":"string","enum":["invalid_body","invalid_session","invalid_api_key","invalid_limit","invalid_types","invalid_min_strength","invalid_cursor","same_person","person_not_found","ambiguous_person","result_unavailable","not_found","too_many_keys","unavailable","rate_limited","too_many_concurrent","research_busy","insufficient_balance","invalid_max_tokens","billing_account_missing"],"isRequired":true,"uniqueKey":"error","typeLabel":"enum\u003cstring>"},"detail":{"description":"A sentence that explains the error, for a person to read. Its wording can change: do not parse it.","type":"string","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"request_id":{"description":"The id of the request, the same as the `X-Request-Id` header.","type":"string","isRequired":true,"uniqueKey":"request_id","typeLabel":"string"},"candidates":{"description":"With `422 ambiguous_person` only: every person the id matched.","type":"array","items":{"type":"object","properties":{"key":{"description":"The person’s key: the public identifier percent-decoded and lower-cased. Two people in the answers are the same person when their keys are equal.","type":"string","isRequired":true,"uniqueKey":"candidates.items.[INDEX].key","typeLabel":"string"},"publicId":{"description":"The person’s current LinkedIn public identifier, the part after `/in/` of the profile URL. It is a valid `id`, `a`, `b` or `target` in any call. For a person with no known profile, the identifier as the call gave it, in the form of `key`.","type":"string","isRequired":true,"uniqueKey":"candidates.items.[INDEX].publicId","typeLabel":"string"},"full_name":{"description":"The person’s name. Absent when no known profile carries one.","type":"string","uniqueKey":"candidates.items.[INDEX].full_name","typeLabel":"string"},"role":{"description":"The title of the person’s current position; without one, the profile’s headline. Absent when the profile has neither, or no profile is known.","type":"string","uniqueKey":"candidates.items.[INDEX].role","typeLabel":"string"},"company":{"description":"The name of the company of the current position shown. Absent when unknown.","type":"string","uniqueKey":"candidates.items.[INDEX].company","typeLabel":"string"},"companyPublicId":{"description":"The LinkedIn page of that company, as `company/\u003cslug>`, or `showcase/\u003cslug>` for a showcase page. Absent when unknown.","type":"string","uniqueKey":"candidates.items.[INDEX].companyPublicId","typeLabel":"string"}},"required":["key","publicId"],"uniqueKey":"candidates.items.[INDEX]","typeLabel":"object"},"uniqueKey":"candidates","typeLabel":"object[]"}},"required":["error","detail","request_id"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"invalid_body","detail":"\u003cstring>","request_id":"\u003cstring>","candidates":[{"key":"\u003cstring>","publicId":"\u003cstring>","full_name":"\u003cstring>","role":"\u003cstring>","company":"\u003cstring>","companyPublicId":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"9e3abbe8-6b20-406d-a0ea-41366989e23c":{"description":"Payment Required.\n\n- `insufficient_balance`: The balance does not cover what the call reserves. Top up the balance, or lower `max_tokens`. See [Billing](/api/billing).\n\n- `billing_account_missing`: The account has no billing account yet. Create an API key in the console: the first key opens the billing account.","headers":{"X-Request-Id":{"description":"The id of the request. Every answer carries it; an error body repeats it as `request_id`. See Request ids.","schema":{"type":"string"}},"RateLimit-Limit":{"description":"The calls the account may make per minute. On every answer past authentication: not on a `401`, nor on a `400 invalid_body` for a body that could not be parsed. See Rate limits.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"The error code. Stable: branch on it.","type":"string","enum":["invalid_body","invalid_session","invalid_api_key","invalid_limit","invalid_types","invalid_min_strength","invalid_cursor","same_person","person_not_found","ambiguous_person","result_unavailable","not_found","too_many_keys","unavailable","rate_limited","too_many_concurrent","research_busy","insufficient_balance","invalid_max_tokens","billing_account_missing"],"isRequired":true,"uniqueKey":"error","typeLabel":"enum\u003cstring>"},"detail":{"description":"A sentence that explains the error, for a person to read. Its wording can change: do not parse it.","type":"string","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"request_id":{"description":"The id of the request, the same as the `X-Request-Id` header.","type":"string","isRequired":true,"uniqueKey":"request_id","typeLabel":"string"},"candidates":{"description":"With `422 ambiguous_person` only: every person the id matched.","type":"array","items":{"type":"object","properties":{"key":{"description":"The person’s key: the public identifier percent-decoded and lower-cased. Two people in the answers are the same person when their keys are equal.","type":"string","isRequired":true,"uniqueKey":"candidates.items.[INDEX].key","typeLabel":"string"},"publicId":{"description":"The person’s current LinkedIn public identifier, the part after `/in/` of the profile URL. It is a valid `id`, `a`, `b` or `target` in any call. For a person with no known profile, the identifier as the call gave it, in the form of `key`.","type":"string","isRequired":true,"uniqueKey":"candidates.items.[INDEX].publicId","typeLabel":"string"},"full_name":{"description":"The person’s name. Absent when no known profile carries one.","type":"string","uniqueKey":"candidates.items.[INDEX].full_name","typeLabel":"string"},"role":{"description":"The title of the person’s current position; without one, the profile’s headline. Absent when the profile has neither, or no profile is known.","type":"string","uniqueKey":"candidates.items.[INDEX].role","typeLabel":"string"},"company":{"description":"The name of the company of the current position shown. Absent when unknown.","type":"string","uniqueKey":"candidates.items.[INDEX].company","typeLabel":"string"},"companyPublicId":{"description":"The LinkedIn page of that company, as `company/\u003cslug>`, or `showcase/\u003cslug>` for a showcase page. Absent when unknown.","type":"string","uniqueKey":"candidates.items.[INDEX].companyPublicId","typeLabel":"string"}},"required":["key","publicId"],"uniqueKey":"candidates.items.[INDEX]","typeLabel":"object"},"uniqueKey":"candidates","typeLabel":"object[]"}},"required":["error","detail","request_id"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"invalid_body","detail":"\u003cstring>","request_id":"\u003cstring>","candidates":[{"key":"\u003cstring>","publicId":"\u003cstring>","full_name":"\u003cstring>","role":"\u003cstring>","company":"\u003cstring>","companyPublicId":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"dbe369d7-acd5-499a-9e50-0ac71dcf27c1":{"description":"Not Found.\n\n- `person_not_found`: No person can be found by the id given. Check the id.","headers":{"X-Request-Id":{"description":"The id of the request. Every answer carries it; an error body repeats it as `request_id`. See Request ids.","schema":{"type":"string"}},"RateLimit-Limit":{"description":"The calls the account may make per minute. On every answer past authentication: not on a `401`, nor on a `400 invalid_body` for a body that could not be parsed. See Rate limits.","schema":{"type":"integer"}},"X-Orbb-Reserved":{"description":"The tokens the call reserved. On the answers of a call that reserved, a `202` included; not on a refusal before the reservation, nor on a `503` whose reservation was returned. `/v1/job` answers do not carry it. See Billing.","schema":{"type":"number"}},"X-Orbb-Balance":{"description":"The tokens available after the reservation. On the same answers as `X-Orbb-Reserved`.","schema":{"type":"number"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"The error code. Stable: branch on it.","type":"string","enum":["invalid_body","invalid_session","invalid_api_key","invalid_limit","invalid_types","invalid_min_strength","invalid_cursor","same_person","person_not_found","ambiguous_person","result_unavailable","not_found","too_many_keys","unavailable","rate_limited","too_many_concurrent","research_busy","insufficient_balance","invalid_max_tokens","billing_account_missing"],"isRequired":true,"uniqueKey":"error","typeLabel":"enum\u003cstring>"},"detail":{"description":"A sentence that explains the error, for a person to read. Its wording can change: do not parse it.","type":"string","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"request_id":{"description":"The id of the request, the same as the `X-Request-Id` header.","type":"string","isRequired":true,"uniqueKey":"request_id","typeLabel":"string"},"candidates":{"description":"With `422 ambiguous_person` only: every person the id matched.","type":"array","items":{"type":"object","properties":{"key":{"description":"The person’s key: the public identifier percent-decoded and lower-cased. Two people in the answers are the same person when their keys are equal.","type":"string","isRequired":true,"uniqueKey":"candidates.items.[INDEX].key","typeLabel":"string"},"publicId":{"description":"The person’s current LinkedIn public identifier, the part after `/in/` of the profile URL. It is a valid `id`, `a`, `b` or `target` in any call. For a person with no known profile, the identifier as the call gave it, in the form of `key`.","type":"string","isRequired":true,"uniqueKey":"candidates.items.[INDEX].publicId","typeLabel":"string"},"full_name":{"description":"The person’s name. Absent when no known profile carries one.","type":"string","uniqueKey":"candidates.items.[INDEX].full_name","typeLabel":"string"},"role":{"description":"The title of the person’s current position; without one, the profile’s headline. Absent when the profile has neither, or no profile is known.","type":"string","uniqueKey":"candidates.items.[INDEX].role","typeLabel":"string"},"company":{"description":"The name of the company of the current position shown. Absent when unknown.","type":"string","uniqueKey":"candidates.items.[INDEX].company","typeLabel":"string"},"companyPublicId":{"description":"The LinkedIn page of that company, as `company/\u003cslug>`, or `showcase/\u003cslug>` for a showcase page. Absent when unknown.","type":"string","uniqueKey":"candidates.items.[INDEX].companyPublicId","typeLabel":"string"}},"required":["key","publicId"],"uniqueKey":"candidates.items.[INDEX]","typeLabel":"object"},"uniqueKey":"candidates","typeLabel":"object[]"}},"required":["error","detail","request_id"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"invalid_body","detail":"\u003cstring>","request_id":"\u003cstring>","candidates":[{"key":"\u003cstring>","publicId":"\u003cstring>","full_name":"\u003cstring>","role":"\u003cstring>","company":"\u003cstring>","companyPublicId":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"7cd3ec50-e6bf-4d88-b993-8ab56d858962":{"description":"Unprocessable Entity.\n\n- `ambiguous_person`: Several people have held the id given; `candidates` lists them. Name the person by a candidate’s `publicId` instead.","headers":{"X-Request-Id":{"description":"The id of the request. Every answer carries it; an error body repeats it as `request_id`. See Request ids.","schema":{"type":"string"}},"RateLimit-Limit":{"description":"The calls the account may make per minute. On every answer past authentication: not on a `401`, nor on a `400 invalid_body` for a body that could not be parsed. See Rate limits.","schema":{"type":"integer"}},"X-Orbb-Reserved":{"description":"The tokens the call reserved. On the answers of a call that reserved, a `202` included; not on a refusal before the reservation, nor on a `503` whose reservation was returned. `/v1/job` answers do not carry it. See Billing.","schema":{"type":"number"}},"X-Orbb-Balance":{"description":"The tokens available after the reservation. On the same answers as `X-Orbb-Reserved`.","schema":{"type":"number"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"The error code. Stable: branch on it.","type":"string","enum":["invalid_body","invalid_session","invalid_api_key","invalid_limit","invalid_types","invalid_min_strength","invalid_cursor","same_person","person_not_found","ambiguous_person","result_unavailable","not_found","too_many_keys","unavailable","rate_limited","too_many_concurrent","research_busy","insufficient_balance","invalid_max_tokens","billing_account_missing"],"isRequired":true,"uniqueKey":"error","typeLabel":"enum\u003cstring>"},"detail":{"description":"A sentence that explains the error, for a person to read. Its wording can change: do not parse it.","type":"string","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"request_id":{"description":"The id of the request, the same as the `X-Request-Id` header.","type":"string","isRequired":true,"uniqueKey":"request_id","typeLabel":"string"},"candidates":{"description":"With `422 ambiguous_person` only: every person the id matched.","type":"array","items":{"type":"object","properties":{"key":{"description":"The person’s key: the public identifier percent-decoded and lower-cased. Two people in the answers are the same person when their keys are equal.","type":"string","isRequired":true,"uniqueKey":"candidates.items.[INDEX].key","typeLabel":"string"},"publicId":{"description":"The person’s current LinkedIn public identifier, the part after `/in/` of the profile URL. It is a valid `id`, `a`, `b` or `target` in any call. For a person with no known profile, the identifier as the call gave it, in the form of `key`.","type":"string","isRequired":true,"uniqueKey":"candidates.items.[INDEX].publicId","typeLabel":"string"},"full_name":{"description":"The person’s name. Absent when no known profile carries one.","type":"string","uniqueKey":"candidates.items.[INDEX].full_name","typeLabel":"string"},"role":{"description":"The title of the person’s current position; without one, the profile’s headline. Absent when the profile has neither, or no profile is known.","type":"string","uniqueKey":"candidates.items.[INDEX].role","typeLabel":"string"},"company":{"description":"The name of the company of the current position shown. Absent when unknown.","type":"string","uniqueKey":"candidates.items.[INDEX].company","typeLabel":"string"},"companyPublicId":{"description":"The LinkedIn page of that company, as `company/\u003cslug>`, or `showcase/\u003cslug>` for a showcase page. Absent when unknown.","type":"string","uniqueKey":"candidates.items.[INDEX].companyPublicId","typeLabel":"string"}},"required":["key","publicId"],"uniqueKey":"candidates.items.[INDEX]","typeLabel":"object"},"uniqueKey":"candidates","typeLabel":"object[]"}},"required":["error","detail","request_id"],"uniqueKey":"","typeLabel":"object"},"example":{"error":"ambiguous_person","candidates":[{"key":"jo-doe","publicId":"jo-doe","full_name":"Jo Doe","role":"CEO","company":"Acme"},{"key":"jo-doe-1","publicId":"jo-doe-1","full_name":"Jo Doe","role":"Engineer"}],"detail":"Several people match. Retry with one candidate's id.","request_id":"6720f0c2a1b2c3d4e5f60718"},"examples":{"Example":{"title":"Example","value":{"error":"ambiguous_person","candidates":[{"key":"jo-doe","publicId":"jo-doe","full_name":"Jo Doe","role":"CEO","company":"Acme"},{"key":"jo-doe-1","publicId":"jo-doe-1","full_name":"Jo Doe","role":"Engineer"}],"detail":"Several people match. Retry with one candidate's id.","request_id":"6720f0c2a1b2c3d4e5f60718"}}},"exampleType":"examples"}},"exampleType":"examples"},"e37d0b65-e456-43b6-a749-aba609566a84":{"description":"Too Many Requests.\n\n- `rate_limited`: The account made more calls in the last minute than `RateLimit-Limit` allows. Wait `Retry-After` seconds, then repeat the same request.\n\n- `too_many_concurrent`: The account has too many calls waiting for an answer at once. Wait for a call to be answered, or `Retry-After` seconds, then repeat the same request.\n\n- `research_busy`: The account has too many research and resolve jobs still running. Wait for a job to end, or `Retry-After` seconds, then call again. See [Rate limits](/api/rate-limits).","headers":{"X-Request-Id":{"description":"The id of the request. Every answer carries it; an error body repeats it as `request_id`. See Request ids.","schema":{"type":"string"}},"RateLimit-Limit":{"description":"The calls the account may make per minute. On every answer past authentication: not on a `401`, nor on a `400 invalid_body` for a body that could not be parsed. See Rate limits.","schema":{"type":"integer"}},"Retry-After":{"description":"The seconds to wait before calling again. On every `429`.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"The error code. Stable: branch on it.","type":"string","enum":["invalid_body","invalid_session","invalid_api_key","invalid_limit","invalid_types","invalid_min_strength","invalid_cursor","same_person","person_not_found","ambiguous_person","result_unavailable","not_found","too_many_keys","unavailable","rate_limited","too_many_concurrent","research_busy","insufficient_balance","invalid_max_tokens","billing_account_missing"],"isRequired":true,"uniqueKey":"error","typeLabel":"enum\u003cstring>"},"detail":{"description":"A sentence that explains the error, for a person to read. Its wording can change: do not parse it.","type":"string","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"request_id":{"description":"The id of the request, the same as the `X-Request-Id` header.","type":"string","isRequired":true,"uniqueKey":"request_id","typeLabel":"string"},"candidates":{"description":"With `422 ambiguous_person` only: every person the id matched.","type":"array","items":{"type":"object","properties":{"key":{"description":"The person’s key: the public identifier percent-decoded and lower-cased. Two people in the answers are the same person when their keys are equal.","type":"string","isRequired":true,"uniqueKey":"candidates.items.[INDEX].key","typeLabel":"string"},"publicId":{"description":"The person’s current LinkedIn public identifier, the part after `/in/` of the profile URL. It is a valid `id`, `a`, `b` or `target` in any call. For a person with no known profile, the identifier as the call gave it, in the form of `key`.","type":"string","isRequired":true,"uniqueKey":"candidates.items.[INDEX].publicId","typeLabel":"string"},"full_name":{"description":"The person’s name. Absent when no known profile carries one.","type":"string","uniqueKey":"candidates.items.[INDEX].full_name","typeLabel":"string"},"role":{"description":"The title of the person’s current position; without one, the profile’s headline. Absent when the profile has neither, or no profile is known.","type":"string","uniqueKey":"candidates.items.[INDEX].role","typeLabel":"string"},"company":{"description":"The name of the company of the current position shown. Absent when unknown.","type":"string","uniqueKey":"candidates.items.[INDEX].company","typeLabel":"string"},"companyPublicId":{"description":"The LinkedIn page of that company, as `company/\u003cslug>`, or `showcase/\u003cslug>` for a showcase page. Absent when unknown.","type":"string","uniqueKey":"candidates.items.[INDEX].companyPublicId","typeLabel":"string"}},"required":["key","publicId"],"uniqueKey":"candidates.items.[INDEX]","typeLabel":"object"},"uniqueKey":"candidates","typeLabel":"object[]"}},"required":["error","detail","request_id"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"invalid_body","detail":"\u003cstring>","request_id":"\u003cstring>","candidates":[{"key":"\u003cstring>","publicId":"\u003cstring>","full_name":"\u003cstring>","role":"\u003cstring>","company":"\u003cstring>","companyPublicId":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"aa4a4297-cc38-4ed0-ae09-10951bf25fb9":{"description":"Service Unavailable.\n\n- `unavailable`: The API could not complete the call, or could not check the token or the rate limits. Repeat the same request, backing off.","headers":{"X-Request-Id":{"description":"The id of the request. Every answer carries it; an error body repeats it as `request_id`. See Request ids.","schema":{"type":"string"}},"RateLimit-Limit":{"description":"The calls the account may make per minute. On every answer past authentication: not on a `401`, nor on a `400 invalid_body` for a body that could not be parsed. See Rate limits.","schema":{"type":"integer"}},"X-Orbb-Reserved":{"description":"The tokens the call reserved. On the answers of a call that reserved, a `202` included; not on a refusal before the reservation, nor on a `503` whose reservation was returned. `/v1/job` answers do not carry it. See Billing.","schema":{"type":"number"}},"X-Orbb-Balance":{"description":"The tokens available after the reservation. On the same answers as `X-Orbb-Reserved`.","schema":{"type":"number"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"The error code. Stable: branch on it.","type":"string","enum":["invalid_body","invalid_session","invalid_api_key","invalid_limit","invalid_types","invalid_min_strength","invalid_cursor","same_person","person_not_found","ambiguous_person","result_unavailable","not_found","too_many_keys","unavailable","rate_limited","too_many_concurrent","research_busy","insufficient_balance","invalid_max_tokens","billing_account_missing"],"isRequired":true,"uniqueKey":"error","typeLabel":"enum\u003cstring>"},"detail":{"description":"A sentence that explains the error, for a person to read. Its wording can change: do not parse it.","type":"string","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"request_id":{"description":"The id of the request, the same as the `X-Request-Id` header.","type":"string","isRequired":true,"uniqueKey":"request_id","typeLabel":"string"},"candidates":{"description":"With `422 ambiguous_person` only: every person the id matched.","type":"array","items":{"type":"object","properties":{"key":{"description":"The person’s key: the public identifier percent-decoded and lower-cased. Two people in the answers are the same person when their keys are equal.","type":"string","isRequired":true,"uniqueKey":"candidates.items.[INDEX].key","typeLabel":"string"},"publicId":{"description":"The person’s current LinkedIn public identifier, the part after `/in/` of the profile URL. It is a valid `id`, `a`, `b` or `target` in any call. For a person with no known profile, the identifier as the call gave it, in the form of `key`.","type":"string","isRequired":true,"uniqueKey":"candidates.items.[INDEX].publicId","typeLabel":"string"},"full_name":{"description":"The person’s name. Absent when no known profile carries one.","type":"string","uniqueKey":"candidates.items.[INDEX].full_name","typeLabel":"string"},"role":{"description":"The title of the person’s current position; without one, the profile’s headline. Absent when the profile has neither, or no profile is known.","type":"string","uniqueKey":"candidates.items.[INDEX].role","typeLabel":"string"},"company":{"description":"The name of the company of the current position shown. Absent when unknown.","type":"string","uniqueKey":"candidates.items.[INDEX].company","typeLabel":"string"},"companyPublicId":{"description":"The LinkedIn page of that company, as `company/\u003cslug>`, or `showcase/\u003cslug>` for a showcase page. Absent when unknown.","type":"string","uniqueKey":"candidates.items.[INDEX].companyPublicId","typeLabel":"string"}},"required":["key","publicId"],"uniqueKey":"candidates.items.[INDEX]","typeLabel":"object"},"uniqueKey":"candidates","typeLabel":"object[]"}},"required":["error","detail","request_id"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"invalid_body","detail":"\u003cstring>","request_id":"\u003cstring>","candidates":[{"key":"\u003cstring>","publicId":"\u003cstring>","full_name":"\u003cstring>","role":"\u003cstring>","company":"\u003cstring>","companyPublicId":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"bfc1b1af-45ac-4d66-806e-96d74a0cc685":{"bearer":{"type":"http","scheme":"bearer","description":"An API key, `orbb_sk_…`, created in the console; or the console’s session token. See Authentication.","scopes":[],"schemeName":"bearer"}}},"servers":{"0727b844-8410-4aec-84c5-b31bc2f7b788":{"url":"https://api.orbb.com","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"An API key, `orbb_sk_…`, created in the console; or the console’s session token. See Authentication.","scopes":[],"schemeName":"bearer"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"An API key, `orbb_sk_…`, created in the console; or the console’s session token. See Authentication.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearer","name":"Authorization"}],"title":"bearer"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"orbb","siteName":"Orbb","title":"List the people connected to a person - Orbb","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-16T14:06:56.990Z","originalFileLocation":"api-reference/circle.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Body: { \u0026quot;id\u0026quot;: … }, plus the optional fields below. Lists the people connected to one person, strongest first, a page at a time. Each entry carries the other person, the verdict and strength of the connection, and its evidence; the answer also says what research has been done for the person. Checked in order: the body (400 invalid_body), limit, min_strength, cursor, types, max_tokens; with on_miss: RESEARCH only, the research and resolve jobs still running (429 research_busy); then, for every call, the balance (402). See also /v1/paths, /v1/resolve, Jobs, Billing, Rate limits.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Orbb\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/orbb/oli3zzhz8Otcly25/_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/orbb/oli3zzhz8Otcly25/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/orbb/oli3zzhz8Otcly25/_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/orbb/oli3zzhz8Otcly25/_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/orbb/oli3zzhz8Otcly25/_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/orbb/oli3zzhz8Otcly25/_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/orbb/oli3zzhz8Otcly25/_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/orbb/oli3zzhz8Otcly25/_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/orbb/oli3zzhz8Otcly25/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"List the people connected to a person - Orbb\">\u003cmeta data-mint-head property=\"og:description\" content=\"Body: { \u0026quot;id\u0026quot;: … }, plus the optional fields below. Lists the people connected to one person, strongest first, a page at a time. Each entry carries the other person, the verdict and strength of the connection, and its evidence; the answer also says what research has been done for the person. Checked in order: the body (400 invalid_body), limit, min_strength, cursor, types, max_tokens; with on_miss: RESEARCH only, the research and resolve jobs still running (429 research_busy); then, for every call, the balance (402). See also /v1/paths, /v1/resolve, Jobs, Billing, Rate limits.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Orbb Developers\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.orbb.com/api-reference/circle\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://orbb.mintlify.site/_mintlify/api/og/v2?division=API+reference\u0026amp;title=List+the+people+connected+to+a+person\u0026amp;description=Body%3A+%60%7B+%22id%22%3A+%E2%80%A6+%7D%60%2C+plus+the+optional+fields+below.%0A%0ALists+the+people+connected+to+one+person%2C+strongest+first%2C+a+page+at+a+time.+Each+entry+carries+the+other+\u0026amp;theme=1411a67f12460a05d49d9a5a\u0026amp;signature=8187d9c3de40a1f0f6609fb30604dda78d61aa238b82682cdd27ce33787e1fab\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"List the people connected to a person - Orbb\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Body: { \u0026quot;id\u0026quot;: … }, plus the optional fields below. Lists the people connected to one person, strongest first, a page at a time. Each entry carries the other person, the verdict and strength of the connection, and its evidence; the answer also says what research has been done for the person. Checked in order: the body (400 invalid_body), limit, min_strength, cursor, types, max_tokens; with on_miss: RESEARCH only, the research and resolve jobs still running (429 research_busy); then, for every call, the balance (402). See also /v1/paths, /v1/resolve, Jobs, Billing, Rate limits.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://orbb.mintlify.site/_mintlify/api/og/v2?division=API+reference\u0026amp;title=List+the+people+connected+to+a+person\u0026amp;description=Body%3A+%60%7B+%22id%22%3A+%E2%80%A6+%7D%60%2C+plus+the+optional+fields+below.%0A%0ALists+the+people+connected+to+one+person%2C+strongest+first%2C+a+page+at+a+time.+Each+entry+carries+the+other+\u0026amp;theme=1411a67f12460a05d49d9a5a\u0026amp;signature=8187d9c3de40a1f0f6609fb30604dda78d61aa238b82682cdd27ce33787e1fab\">\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/orbb/oli3zzhz8Otcly25/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Orbb\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0F4A52\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.orbb.com/api-reference/circle\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/circle.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.orbb.com/#organization\",\"name\":\"Orbb\",\"url\":\"https://docs.orbb.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/orbb/fWzU-Pd1c801Da8W/logo/light.svg?fit=max\u0026auto=format\u0026n=fWzU-Pd1c801Da8W\u0026q=85\u0026s=a78a0e2c9c47cbbdc833ef9c7505b822\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.orbb.com#website\",\"name\":\"Orbb\",\"url\":\"https://docs.orbb.com\",\"publisher\":{\"@id\":\"https://docs.orbb.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.orbb.com/api-reference/circle#webpage\",\"url\":\"https://docs.orbb.com/api-reference/circle\",\"name\":\"List the people connected to a person\",\"description\":\"Body: { \\\"id\\\": … }, plus the optional fields below. Lists the people connected to one person, strongest first, a page at a time. Each entry carries the other person, the verdict and strength of the connection, and its evidence; the answer also says what research has been done for the person. Checked in order: the body (400 invalid_body), limit, min_strength, cursor, types, max_tokens; with on_miss: RESEARCH only, the research and resolve jobs still running (429 research_busy); then, for every call, the balance (402). See also /v1/paths, /v1/resolve, Jobs, Billing, Rate limits.\",\"dateModified\":\"2026-11-16T14:06:56.990Z\",\"isPartOf\":{\"@id\":\"https://docs.orbb.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.orbb.com/api-reference/circle#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.orbb.com/api-reference/circle#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API reference\",\"item\":\"https://docs.orbb.com/api-reference/resolve\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"List the people connected to a person\",\"item\":\"https://docs.orbb.com/api-reference/circle\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.orbb.com/api-reference/circle#apireference\",\"headline\":\"List the people connected to a person\",\"name\":\"List the people connected to a person\",\"description\":\"Body: { \\\"id\\\": … }, plus the optional fields below. Lists the people connected to one person, strongest first, a page at a time. Each entry carries the other person, the verdict and strength of the connection, and its evidence; the answer also says what research has been done for the person. Checked in order: the body (400 invalid_body), limit, min_strength, cursor, types, max_tokens; with on_miss: RESEARCH only, the research and resolve jobs still running (429 research_busy); then, for every call, the balance (402). See also /v1/paths, /v1/resolve, Jobs, Billing, Rate limits.\",\"url\":\"https://docs.orbb.com/api-reference/circle\",\"mainEntityOfPage\":{\"@id\":\"https://docs.orbb.com/api-reference/circle#webpage\"},\"dateModified\":\"2026-11-16T14:06:56.990Z\",\"publisher\":{\"@id\":\"https://docs.orbb.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.orbb.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Orbb\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Orbb\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/circle.md","siteName":"Orbb","nav":{"global":null,"groups":[{"group":"Get started","icon":"rocket","pages":[{"title":"Orbb developer docs","sidebarTitle":"Introduction","mode":"wide","href":"/index"},{"title":"Quickstart","href":"/quickstart"},{"title":"Building with an agent","href":"/agents"}]},{"group":"Concepts","icon":"lightbulb","pages":[{"title":"People and ids","href":"/concepts/people"},{"title":"Relationships","href":"/concepts/relationships"},{"title":"Unknown is not no","href":"/concepts/unknowns"}]},{"group":"Using the API","icon":"book-open","pages":[{"title":"Authentication","href":"/api/authentication"},{"title":"Jobs","href":"/api/jobs"},{"title":"Errors","href":"/api/errors"},{"title":"Billing","href":"/api/billing"},{"title":"Rate limits","href":"/api/rate-limits"},{"title":"Request ids","href":"/api/request-ids"}]},{"group":"API reference","icon":"square-terminal","pages":[{"openapi":"POST /v1/resolve","sidebarTitle":"Resolve","title":"Find a person by LinkedIn profile, email, or name and company","description":"Body: one of `{ \"id\": … }`, `{ \"email\": … }` or `{ \u003cname>, \u003ccompany field> }`, where the name is `full_name`, or `first_name` with `last_name`, and the company field is any of `company`, `company_domain`, `company_linkedin_url`; `email` also takes the name and company fields, and `on_miss` goes with any form but `id`.\n\nFinds the person behind an email address, a name with a company, or a LinkedIn profile. An `email` or name resolve searches; a resolve by `id` looks the profile up with no search.\n\n> A person that cannot be identified is answered `200` with `resolution.status` `UNRESOLVED`, not an error, an `id` with no known profile included. `404 person_not_found` answers only an `id` that is neither a profile URL nor a public identifier.\n\nChecked in order: the body (`400 invalid_body`), the research and resolve jobs still running (`429 research_busy`), then the balance (`402`).\n\nSee also [`/v1/circle`](/api-reference/circle), [Jobs](/api/jobs), [Billing](/api/billing), [Rate limits](/api/rate-limits).","href":"/api-reference/resolve"},{"openapi":"POST /v1/circle","sidebarTitle":"Circle","title":"List the people connected to a person","href":"/api-reference/circle"},{"openapi":"POST /v1/edge","sidebarTitle":"Edge","title":"Tell whether two people know each other","description":"Body: `{ \"a\": …, \"b\": … }`, plus the optional fields below.\n\nTells whether two people likely know each other, and why: the verdict, the strength of the connection, the evidence for each requested type found, and what was checked.\n\nChecked in order: the body (`400 invalid_body`), `a` equal to `b` (`400 same_person`), `types`, `max_tokens`; with `on_miss: RESEARCH` only, the research and resolve jobs still running (`429 research_busy`); then, for every call, the balance (`402`).\n\n> Two different values that name the same person are answered `400 same_person` only once the job has matched them: after a `202`, that answer comes from `/v1/job`.\n\nSee also [`/v1/circle`](/api-reference/circle), [Jobs](/api/jobs), [Billing](/api/billing), [Rate limits](/api/rate-limits).","href":"/api-reference/edge"},{"openapi":"POST /v1/paths","sidebarTitle":"Paths","title":"List the people who could introduce someone to a person","href":"/api-reference/paths"},{"openapi":"POST /v1/job","sidebarTitle":"Job","title":"Read the answer of a job","href":"/api-reference/job"},{"openapi":"POST /v1/balance","sidebarTitle":"Balance","title":"Read the account’s balance","href":"/api-reference/balance"},{"openapi":"GET /v1/openapi.json","sidebarTitle":"OpenAPI document","title":"Read this reference","href":"/api-reference/openapi"}]},{"group":"MCP","icon":"plug","pages":[{"title":"MCP servers","href":"/mcp/overview"},{"title":"Connect a client","href":"/mcp/connect"},{"title":"Research runs","href":"/mcp/runs"},{"title":"Orbb Research tools","href":"/mcp/research-tools"},{"title":"Workspace tools","href":"/mcp/workspace-tools"},{"title":"Workspace server security","sidebarTitle":"Workspace security","icon":"shield-check","href":"/mcp/security"}]},{"group":"Integrations","icon":"blocks","pages":[{"title":"Integrations","icon":"blocks","href":"/integrations/overview"},{"group":"CRM","pages":[{"title":"Salesforce","icon":"cloud","href":"/integrations/salesforce"},{"title":"HubSpot","icon":"circle-dot","href":"/integrations/hubspot"}]},{"group":"Mail and calendar","pages":[{"title":"Google Workspace","icon":"mail","href":"/integrations/google-workspace"},{"title":"Google Workspace App","icon":"store","href":"/integrations/google-workspace-app"},{"title":"Office 365","icon":"mail","href":"/integrations/office-365"}]},{"group":"Calls, messaging and outreach","pages":[{"title":"Gong","icon":"phone","href":"/integrations/gong"},{"title":"Slack","icon":"message-square","href":"/integrations/slack"},{"title":"Microsoft Teams","icon":"users","href":"/integrations/teams"},{"title":"Outreach","icon":"send","href":"/integrations/outreach"}]}]}]},"basePath":"","title":"List the people connected to a person - Orbb","buildId":"dpl_4D8r1dHg6bQcRuBgQyL3z9waJJtn","deploymentId":"dpl_4D8r1dHg6bQcRuBgQyL3z9waJJtn","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-dD8DedlW.js","utils-BgJ6PauS.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-m4sNRkou.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Dg97LVEU.js","snippetPresets-C6CxWGOo.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","Page-DOwQSAHT.js","ApiExamples-CKiRf67B.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CDY0tBIx.js","shallow-BHHaYlmm.js","getApiPlaygroundDisplay-D6K3-cVX.js","CodeSnippet-BrS3fDep.js","CodeSnippets-Dkf1llUu.js","getPastedJson-3JcMsaes.js","icon-CWSTKRsN.js","MethodPill-t_TXGK5I.js","DuplicateIcon-DcjhdAbh.js","createIcon-2JHmGxKn.js","DynamicMarkdown-DMUWO-az.js","SectionHeading-DxvGHAss.js","axios-vUo_bRtp.js","Markdown-cyvaulBW.js","clsx-DzViKcUj.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CU0Gjyt0.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-CuigkklY.js"]}