Developers
Open Swarmhit
DocumentationAPI Reference
Database
POST
/database/people/find-email

A person's verified work email, from their LinkedIn URL or from a first name, last name and company (name or domain); send all of them when known. Nothing is saved, except on a workspace lead with that LinkedIn URL, whose email is returned free when it has one and kept when one is found (to look up leads, see POST /leads/{id}/enrich). 8 credits when an email is found; email: null when none is, free. A miss can take up to a minute. Out of credits is a 400 with code: warning-no-credits.

Authorization

bearerAuth
AuthorizationBearer <token>

An API key created on the Access tokens page.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/database/people/find-email" \  -H "Content-Type: application/json" \  -d '{    "firstName": "Jane",    "lastName": "Doe",    "domain": "stripe.com"  }'
{  "data": {    "email": "jane.doe@stripe.com"  }}

Enrich a person POST

Full database profile for one person, from their LinkedIn URL: experience, education, skills, follower counts, and with `includeEmail` their verified work email. Consumes workspace AI credits on a match (65), plus 8 when `includeEmail` finds an email; a 404 (no match) is not charged. When the person is already a workspace lead with an email, `includeEmail` returns that email without a new lookup, and a newly found email is stored on the lead. Without `includeEmail` the response omits the `contact` availability flags. For the email alone, `POST /database/people/find-email` is cheaper. Out of credits is a 400 with `code: warning-no-credits`.

Find a person's phone POST

A person's mobile phone numbers, primary first, from their LinkedIn URL. Nothing is saved, except on a workspace lead with that LinkedIn URL, whose phone is returned free when it has one and kept when one is found. 100 credits when a number is found; an empty `phones` array when none is, free. Out of credits is a 400 with `code: warning-no-credits`.