API reference / People reads

Read a page's followers with their profiles (live)

Written and maintained by The ProspectAPIs team

GET/v1/pages/followers/enriched

GET /v1/pages/followers/enriched is the ProspectAPIs operation getPageFollowersEnriched, in the People reads group of the REST API. Read the followers of a page your connected account administers, each joined to their full profile (headline, location, current company and title, experience, education, skills), fetched fresh at request time. $0.003 per follower returned with its profile (enrichment.status ok); the list itself, a follower with no public profile (no_reference), a profile that cannot be read (not_found) and a follower that was not read (skipped, with a reason: not_held, pool_busy, time_budget or unavailable) are free. Up to 20 followers a page; page on with cursor for more (no volume cap). Give page, or the cursor of the previous page. One hold is taken for the page size and settled at the number enriched. Its own go-live switch: GET /pricing reports follower_enrichment.available; while it is off the call answers 503 and nothing is charged. Cost: Launching soon. 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 page's followers, each with an `enrichment` object, a page cursor and the call's enrichment counts. The body is a EnrichedFollowersResult.

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 https://api.prospectapis.com/v1/pages/followers/enriched \
  -H "Authorization: Bearer $PROSPECTAPIS_KEY"

const res = await fetch("https://api.prospectapis.com/v1/pages/followers/enriched", {
  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/pages/followers/enriched",
    headers={"Authorization": f"Bearer {os.environ['PROSPECTAPIS_KEY']}"},
    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 page's followers (live). Next operation: Read a company page (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.