Developers
Open Swarmhit
Smart APIRaw API
API referenceDatabase
POST
/database/people/enrich

JavaScript SDK: swarmhit.database.people.enrich(params)

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, at the Person enrichment price, plus the Email finder price when includeEmail finds an email (Settings → Credits usage, for owners and admins); 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.

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/enrich" \  -H "Content-Type: application/json" \  -d '{    "linkedinUrl": "string"  }'
{  "data": {    "id": 0,    "name": "string",    "firstName": "string",    "lastName": "string",    "headline": "string",    "title": "string",    "location": "string",    "country": "string",    "picture": "string",    "linkedinUrl": "string",    "company": {      "name": "string",      "title": "string",      "domain": "string",      "linkedinUrl": "string",      "companyId": 0,      "headcount": 0,      "headcountRange": "string",      "industries": [        "string"      ],      "startDate": "string",      "endDate": "string"    },    "pastCompanies": [      "string"    ],    "education": [      {        "school": "string",        "degree": "string",        "field": "string"      }    ],    "contact": {      "hasBusinessEmail": true,      "hasPersonalEmail": true,      "hasPhone": true    },    "yearsOfExperience": 0,    "saved": true,    "phones": [      "string"    ],    "summary": "string",    "connections": 0,    "followers": 0,    "skills": [      "string"    ],    "businessEmails": [      "string"    ],    "emailLookupPending": true,    "websites": [      "string"    ]  }}

Enrich a company POST

**JavaScript SDK:** [`swarmhit.database.companies.enrich(params)`](/smart-api/sdk/methods#database.companies) Full database record for one company (headcount and growth, funding, revenue estimate, the number of open job listings) from its website domain (preferred), LinkedIn URL or name; when several are sent, the first in that order is used. Consumes workspace AI credits on a match, at the Company enrichment price (Settings → Credits usage, for owners and admins); a 404 (no match) is not charged. Out of credits is a 400 with `code: warning-no-credits`.

Find a person's email POST

**JavaScript SDK:** [`swarmhit.database.people.findEmail(params)`](/smart-api/sdk/methods#database.people) 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`). Charged at the Email finder price (Settings → Credits usage, for owners and admins) 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`.