Moving from API v1 to v2

Table of content

Move your integration to API v2. API v1 (/public/v1/... and /api/v1/...) reads the old data model, so it does not see people and companies saved in the new GetProspect, including everything saved from Chrome extension 7.1.1 onward. Full reference: API docs.

Before you begin

  • Your existing API keys work with v2. Manage them on the app's API page.
  • Credits: v2 charges the same way as the app. Each endpoint's cost is on its docs page.

Steps

  1. Change the base URL to https://api.getprospect.com/v2/.... It is not /api/v2.
  2. Send the key in the x-api-key header. v1 used an apiKey header.
  3. Send Content-Type: application/json and put the input in a data object. Example: {"data": {"email": ""}}.
  4. Replace each v1 call using the table below.
  5. Check a few calls in API logs on the API page.

Common v1 calls and their v2 replacements

GET /public/v1/email/findPOST /v2/email/findEmail Finder
GET /public/v1/email/verifyPOST /v2/email/verifyEmail Verifier
GET /public/v1/email/lookupPOST /v2/people/enrich with data.emailPeople Enrich
GET /public/v1/insights/contactPOST /v2/people/enrich with data.linkedin_urlPeople Enrich
POST /public/v1/insights/contactsPOST /v2/people/searchPeople Search
POST /public/v1/insights/companiesPOST /v2/companies/search, or POST /v2/companies/enrich for a known domainCompany Search
POST /api/v1/contacts/contact/searchPOST /v2/people/search with filters.lists.saved: "any"People Search
GET /api/v1/contacts/lists/{list}/contacts/searchPOST /v2/people/search with filters.lists.include: ["<list id>"]People Search
POST /api/v1/contacts/lists/{list}/addPOST /v2/people/save with list_idsSave People
GET /api/v1/contacts/contact/{id}GET /v2/people/{id} (v2 person id)Get Person
GET /api/v1/companies/company/search/queryPOST /v2/companies/searchCompany Search
v1 hooksPOST /v2/webhooksCreate Webhook

A list id is the last part of the list's URL in the app (/lists/<list id>).

What you get

v2 sees every save, whatever its source. Search is free unless you ask it to reveal (enrich_email, enrich_phone); People Enrich reveals the email by default. A reveal costs a credit only when something is found that you do not own yet.

FAQ

My v1 call answers 410 Gone. Why?

That v1 endpoint is retired. The error message names its v2 replacement and docs page.

People saved by the extension do not show up in my v1 results.

Since extension 7.1.1, saves go to the v2 model, which v1 does not read. Use POST /v2/people/search.

I get 404 on https://api.getprospect.com/api/v2/....

Drop /api from the path: the correct base is https://api.getprospect.com/v2/.

Can I still create a contact from scratch?

No. v2 saves people who exist in the GetProspect database, by id or LinkedIn URL.

About author

Alona
Alona Shalieieva

Throughout the previous three years, I am occupied as a Customer Support Representative for the email finder platform GetProspect.com. As a tech-savvy, I am keen on assisting our users with solving any challenges. On top of that, I worked on my tech author skills, and I can be straightforward in explaining difficult topics.