Migration Guides
Move to the current version of each API with field-level mappings and call translations.
Each API moves forward on its own schedule. Property is on V3; Person and Phone are on V2. These guides map every input and output change between versions so you can plan a clean migration.
Property
V3 is the current version. Search returns the property, its owners and its residents rather than a summary, and V3 adds a dedicated owners endpoint, parcel-number lookups, and no charge for a response that carries no property.
- Property V2 → V3 —
GET /v2/property/maps toGET /v3/property/(now a paginated list), joined byGET /v3/property/ownersand parcel-number lookups onGET /v3/property/{identifier}.
Person
- Person V1 → V2 —
GET /v1/person/andGET /v1/person/{id}map toGET /v2/person/andGET /v2/person/{id}.
When to migrate
Older versions keep working during their deprecation window. Migrate as soon as practical to pick up the newer features and to avoid the eventual removal.
For Property specifically, V3 lowers what you spend: a search that matches nothing is no longer billed, and a result already carries the detail that needed a second request in V2.
See Breaking Changes Policy for our deprecation timeline guarantees, and the Changelog for the latest notable changes.
Reading these guides
Each guide is organized the same way:
- TL;DR — the minimum diff to swap one version's calls for the next.
- Endpoint URLs — what changed at the URL level.
- Request parameters — what's the same, what's new, what's gone.
- Response shape — the top-level structural changes, including pagination wrappers and per-result metadata where applicable.
- Field-by-field mapping — every field's new location, with notes on shape or nullability changes.
- Version-only features — fields and behaviors with no analog in the older version.
- Behavioral differences — sort orders, error semantics, billing, and anything else that would surprise a caller on the older version.
If you spot a gap or want clarification on a specific field's behavior, let us know via support.
Related
Property V2 → V3
Field mapping and behavior changes when moving from /v2/property to /v3/property.
Person V1 → V2
Field mapping and behavior changes when moving from /v1/person to /v2/person.
Breaking Changes Policy
How we define, announce, and version breaking changes across the REST API and the MCP server.
Changelog
Notable changes to the Whitepages Pro API, newest first.