Skip to main content
GET
List every record that names one person of the lean set
This route serves the lean set under /v3/people/{id}/timeline. See The lean dataset for the tier rules. A row is one record under one role, with the date, the amount, the parcel and the other side.

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

The person id, as a search hit, an organization or a listing carries it.

Query Parameters

record_kind
enum<string>

Keep the records of one kind.

Available options:
deal,
loan,
listing,
marketplace_listing
role
enum<string>

Keep the records where the subject has this role.

Available options:
buyer,
seller,
lender,
borrower,
holder,
listing_agent,
wholesaler,
closing_buyer
from
string<date>

Keep records observed on or after this date, YYYY-MM-DD. An undated record leaves the page.

to
string<date>

Keep records observed on or before this date, YYYY-MM-DD. An undated record leaves the page.

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 records of the person. meta.resolved_from lists the ids that redirected here.

The records of the person. meta.resolved_from lists the ids that redirected here.

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.