Skip to main content
1

Create an API key

Open API keys in the console and create one. It starts orbb_sk_ and is shown once — copy it somewhere safe.
Your first key also opens your billing account. Every key on the account shares one balance, one set of jobs and one set of rate limits.
2

Find the person

Most of what you hold about a person is an email or a name and a company. /v1/resolve turns that into the id every other call takes.
person.publicId is the id. Check resolution.status before using it — a person who cannot be identified is a 200 with UNRESOLVED, and several matches is AMBIGUOUS with candidates. Neither is an error. See People and ids.
Keep Content-Type: application/json. Without it, curl sends the body as a form field and the API answers 400 invalid_body.
3

List who they know

Each entry in data is a person, a verdict (LIKELY_KNOW, POSSIBLE, …), a strength from 0 to 1, and the evidence: the employer they shared and when, the comment one left on the other’s post. The top-level coverage says which kinds of evidence were examined and which were not. See Relationships.More people than limit? Pass next_cursor back as cursor with the same body.
4

Handle a 202

Resolve, circle, edge and paths start a job. If the answer is ready within 30 seconds you get it straight back; otherwise you get 202 and a job id:
Poll /v1/job with that id — every 3 seconds for the first 10 polls, then every 10 — until it answers with what the original call would have. Set your client timeout to at least 60 seconds: a client that gives up first never sees the id, and sending the call again starts, and pays for, a new job.
The full rules, including what 410 and 503 on a poll mean, are in Jobs.

Next

Find an introduction

/v1/paths lists who could introduce you to a person, strongest first.

Unknown is not no

What coverage and on_miss mean, and how to ask Orbb to research what it has not examined.
Examples on this site use fictional people and companies.