Skip to main content
preview list
The assistant tool is preview_list. Preview a boolean feature-ID expression for people or companies. page_count is the number of IDs on this preview page, not a count of every match. additional_matches reports whether more matches exist than this page. sample_size is how many IDs were on the page. Those IDs are not returned. limit defaults to 10 and cannot exceed 25. The call costs zero credits. dry_run returns an estimate without a lookup. Record IDs come only from a settled build_list. An active credit allowance is required.

Authorizations

Authorization
string
header
required

Send Authorization: Bearer dl_live_<64 lowercase hexadecimal characters>. Signed-in users can create account-scoped, revocable keys in the Datalayer dashboard. A key does not grant credits. Dashboard session cookies are not API credentials.

Headers

Idempotency-Key
string

Recommended for every paid operation. Account-scoped and bound to normalized operation/input. Retry exactly the same key after transport loss: a committed credit result is replayed from persisted normalized bytes without a data lookup or another debit. Changed input, key expiry or paid-anchor expiry returns 409. In-flight requests return request_in_progress. Network delivery and D1 commit are not atomic. If omitted a request ID is created.

Required string length: 1 - 128
Pattern: ^[A-Za-z0-9_-]{1,128}$

Body

application/json
entity
enum<string>
required
Available options:
person,
company
query
string
required
limit
integer
default:10

Advanced: how many sample rows to size, from 1 to 25. Defaults to 10. Record IDs are not returned.

Required range: 1 <= x <= 25
dry_run
boolean

Advanced: return the maximum credit estimate without looking up data.

Response

A settled result or a maximum estimate with no data lookup.

data
object
required
meta
object
required