Skip to main content
GET
Search the agents of the lean set
This route serves the lean set under /v3/agents/search. See The lean dataset for the tier rules.

Authorizations

Authorization
string
header
required

API key from the developer console (starts with zpka_). Create one at https://developers.investorlift.com/get-a-key. The same key works on POST /mcp.

Query Parameters

q
string
required

The text to search.

Required string length: 2 - 120
by
enum<string>
default:name

What q is. name: a name of an agent, a prefix of the folded name or of a word of it. licence: the digits of a licence number. brokerage: a brokerage name, folded. phone: a phone, the digits alone. The default is name. A deals-only key runs a brokerage search alone: this host serves none of a name, a licence or a phone.

Available options:
name,
licence,
brokerage,
phone
state
string

One state alone. Default: every served state.

Pattern: ^[A-Z]{2}$
limit
integer
default:10

Agents to return, 1 to 50 (default 10).

Required range: 1 <= x <= 50

Response

The agents the search found, the most listings first, one page with no cursor.

The agents the search found, the most listings first, one page with no cursor.

data
object[]
required

The hits, best match first.

page
object
required

The page block of a name search: no cursor, the limit applied, the hits returned and if the API cut the page at the limit.

meta
object
required

Response metadata of the lean family: when the API produced it, and the publishes behind the rows.