Skip to main content
POST
View

Credits and plans

PAYG is Pay-as-you-go. AYCE is All-you-can-eat. AYCE includes unlimited contact retrieval. This endpoint’s masked-sample limits still apply; use Preview or Export to retrieve full records on that plan. Use View to check whether your filter finds the right people before you retrieve contact details. Names, roles, and company fields let you assess relevance. Email and mobile values are replaced by availability booleans.

When to use View

Call Count first to size the audience, then reuse its filter here. You can refine and inspect the sample without paying for contact details.

Example: inspect two matching contacts

Set your API key as REVENUEBASE_API_KEY. This uses the same audience as the Count example and requests availability for email and mobile.
Response captured from the local test API on October 13, 2026. Results can change as the dataset or account changes.

Limits and errors

  • Up to 100 rows per call. Higher limits are clamped to 100; omit limit to use that cap.
  • A 100,000-row daily budget per API key, resetting at UTC midnight. Read X-FreePreview-Remaining to track it. Repeated samples count toward this row budget even though they cost no credits.
  • 429 FREE_PREVIEW_CAP_REACHED means the daily budget is exhausted. Wait for the reset. Other 429 responses use the ordinary request rate limit.
  • 422 means the filter or requested column needs correction.
An empty audience returns an empty sample. View has no pagination cursor; repeating it does not fetch the next page. Use includeScores when you want similarity information for a SmartSearch sample.

Next: choose records and estimate the cost

To retrieve selected rows, pass their RBID_PAO values as personIds to Enrich, with an explicit reveal choice. To download a filtered list, reuse the filter with Estimate, set maxRows, and choose whether to buy email, mobile, both, or neither.

Authorizations

X-Key
string
header
required

Body

application/json

Free masked contact sample. Requested email/mobile fields become hasEmail/hasMobile booleans. Use paid retrieval to reveal values.

filter
GroupNode · object | null

Reuse the audience filter from Count. Omitted/null selects the entire dataset.

columns
string[] | null

Fields to inspect. Email/mobile fields are masked. RBID_PAO is always included as the stable row identifier.

limit
integer | null

Maximum sample rows. Clamped to 1–100; omitted/null uses 100. This is a sample size, not an audience total or pagination size.

includeScores
boolean
default:false

Include similarity scores when using semantic/lookalike filters.

Response

Successful Response