List leads
Note: Only lead-gen partners can read leads. If you are a full reservation partner, this endpoint answers with 403 unsupported_organization_type. Read your reservations with GET /public/v1/reservations instead. See Partner types under Getting started.
Returns the leads that Neighbor sent to the locations of the credential's organization. Results are ordered by updated_at, then by an internal tiebreaker, ascending. Pass next_cursor as cursor to read the next page.
A lead holds the same data as its row on your lead reconciliation report. Each status matches a status on that report:
| status | Report status |
|---|---|
| future_move_in | Future move-in |
| moved_in | Moved in |
| did_not_move_in | Did not move in |
Billing uses Denver time. Times in this response are in UTC. Neighbor bills leads by the calendar day and month in US Mountain time (America/Denver), and the report shows dates in that time zone. To match a lead to a billing period, convert start_date to America/Denver first. For example, a start_date of 2026-03-01T03:00:00Z is February 28 in Denver, so the move-in bills in February.
The updated_at rule. updated_at changes when the status, the start date, or the monthly rate of a lead changes. A change of the customer details or the facility details does not.
updated_since is inclusive. The response holds leads whose updated_at equals updated_since.
Overlap. To poll for changes, send updated_since as the last time you read minus 5 minutes. The 5-minute overlap prevents a missed change. Expect to receive some leads twice, and treat each lead by id.
Request
- Base URL: https://api-staging.neiybor.com
- URL: https://api-staging.neiybor.com/public/v1/leads
- Auth: HTTP bearer
Query parameters
ISO 8601 timestamp. Inclusive.
A comma-separated list of future_move_in, moved_in, and did_not_move_in. Default: every status.
The next_cursor of the previous page. Opaque.
Page size.
Response
One page of leads.
Changes
No recorded changes to this operation across all 1 revision of this API.