API reference / People reads

Search company pages (live)

Written and maintained by The ProspectAPIs team

POST/v1/pages/search

POST /v1/pages/search is the ProspectAPIs operation searchPages, in the People reads group of the REST API. Search company pages by keywords and filters, read fresh. Each result names the page (name, slug, page_url) with two short lines from its card (summary, typically industry and place, and detail, typically the follower count). Returns the first 1,000 results per query; page with start. $0.012 per live read. Pass a result's slug to GET /v1/pages/profile or GET /v1/pages/employees. Billed per call once the reads are live; while they are not yet on sale the call is free (GET /pricing reports people_reads.available). Cost: $0.012 per live read, up to 1,000 results a query. 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

Request body

JSON. Give keywords or at least one filter.

{}

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 matching company pages and the page envelope, read fresh. 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 -X POST https://api.prospectapis.com/v1/pages/search \
  -H "Authorization: Bearer $PROSPECTAPIS_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

const res = await fetch("https://api.prospectapis.com/v1/pages/search", {
  method: "POST",
  headers: { Authorization: `Bearer ${process.env.PROSPECTAPIS_KEY}`, "Content-Type": "application/json" },
  body: JSON.stringify({}),
});
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.post(
    "https://api.prospectapis.com/v1/pages/search",
    headers={"Authorization": f"Bearer {os.environ['PROSPECTAPIS_KEY']}"},
    json={},
    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 one post (live). Next operation: Search posts (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 (this call acts for real, so use real inputs).