Skip to main content
GET
Search the lean set by name

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 name to find, 2 to 200 characters. The API folds it the way the build keyed each name, and a prefix of the text, or of any word of it, finds the name.

Required string length: 2 - 200
kind
enum<string>[]

Keep only hits of these kinds (comma list or repeated key): entity, former_name, person, agent_name. Another word answers 400. Default: every kind the key reads.

Minimum array length: 1

What the hit is. entity: an entity of a business registry under its filed name. former_name: an entity under a name it filed before. person: a person, whatever the roles. agent_name: a second spelling of the name of an agent, which points at the same person. A deals-only key gets entity and former_name hits alone.

Available options:
entity,
former_name,
person,
agent_name
state
string

Keep only hits of one served state. Default: every served state.

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

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

Required range: 1 <= x <= 50

Response

The hits of the name search, best match first, one page with no cursor.

The hits of the name search, best match 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.