API reference / People reads

Read a person's light profile (live)

Written and maintained by The ProspectAPIs team

GET/v1/people/profile/lite

GET /v1/people/profile/lite is the ProspectAPIs operation getPeopleProfileLite, in the People reads group of the REST API. Read the light version of one person's public profile: name, location, current company name, profile_ref and the public about (often cut short). Fetched fresh at request time. $0.0005, charged only for a filled answer (a name plus a location or a company name); a profile that is not found or shows too little is a free 404, and a read that cannot be done right now is a free 503 with Retry-After. Not on sale yet: while GET /pricing does not list it in people_profile_lite.available_routes it answers 503 and nothing is charged. For titles, experience and person_ref use GET /v1/people/profile. Cost: Not available yet. Send your API key as a Bearer token in the Authorization header.

The quickstart shows this call in context, next to the first requests most integrations make.

Parameters

An unknown query parameter is refused with a 400 rather than ignored, so a typo never widens a search you pay for.

Responses

Every error answers with the same JSON body, an error string and sometimes a code; the errors page lists each status and when it happens. A per-key 429 carries Retry-After; see rate limits.

200 response fields

The light profile, read fresh, with coverage. The body is a PeopleReadResult.

Code samples

Each sample sends the same request. Set PROSPECTAPIS_KEY in your environment first. Values come from the spec's examples; replace them with your own.

curl -G https://api.prospectapis.com/v1/people/profile/lite \
  -H "Authorization: Bearer $PROSPECTAPIS_KEY" \
  --data-urlencode "profile_ref=profile ref"

const params = new URLSearchParams({ profile_ref: "profile ref" });
const res = await fetch(`https://api.prospectapis.com/v1/people/profile/lite?${params}`, {
  headers: { Authorization: `Bearer ${process.env.PROSPECTAPIS_KEY}` },
});
if (!res.ok) throw new Error(`${res.status}: ${(await res.json().catch(() => ({}))).error ?? res.statusText}`);
const data = await res.json();
console.log(data);

import os, requests

res = requests.get(
    "https://api.prospectapis.com/v1/people/profile/lite",
    headers={"Authorization": f"Bearer {os.environ['PROSPECTAPIS_KEY']}"},
    params={"profile_ref": "profile ref"},
    timeout=30,
)
res.raise_for_status()
data = res.json()
print(data)

Billing

Billing reserves before it serves: the call holds what it may cost, serves at most what that hold covers, and refunds the rest when the response closes. Any non-2xx answer refunds the whole hold, so a failed call costs nothing. The response reports your balance in X-Credits-Remaining.

Related

Previous operation: Read a person's profile (live). Next operation: Search people (live). Every operation, grouped by area, is on the API reference index.

Create a free account to get a key, then run the samples above with your own values.