Skip to main content
GET
List the agents of one brokerage of the lean set
This route serves the lean set under /v3/brokerages/{key}/agents. 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.

Path Parameters

key
string
required

The brokerage name as an agent row or a listing carries it, URL encoded. The API folds it the way the name index folds a name, so the case and the punctuation do not matter.

Required string length: 2 - 200

Query Parameters

state
string

One state alone. Default: every served state.

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

Page size, 1-500 (default 100).

Required range: 1 <= x <= 500
cursor
string

Opaque cursor from page.next_cursor of the previous page. A change of query, sort, weights or data version invalidates it (400 invalid_cursor). Then restart from page 1.

Required string length: 1 - 4096

Response

The agents whose newest listing is under the brokerage, the most listings first, then the newest listing, then the id, one page.

The agents whose newest listing is under the brokerage, the most listings first, then the newest listing, then the id, one page.

data
object[]
required

The rows of this page.

page
object
required

Pagination: the page size, the rows returned and the cursor for the next page. Paged lists carry no total. The summary block does.

meta
object
required

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