Wiza's API: Everything you need to know!

Welcome to the Wiza API guide. Our API empowers users to seamlessly integrate and enrich their business workflows with valuable contact and company data from the vast universe of LinkedIn. Whether you aim to build targeted lists, get detailed insights on prospects, or stay updated with the latest professional emails and profiles, Wiza has got you covered.

Overview:

Create Custom Lists: Define and create lists tailored to your needs, such as "VP of Sales in San Francisco."
Deep Enrichment Levels: Choose from partial to full enrichment levels, extracting emails to even phone numbers.
Multiple Email Options: Decide on the types of emails you want - from professional to personal or even generic ones.
LinkedIn Profile Insights: Add LinkedIn, Sales Navigator, or Recruiter profile URLs and retrieve enriched details.
Robust Error Handling: We provide insightful error messages to guide you through any hiccups, ensuring a smooth experience.

Ensure you have your bearer token handy to authenticate and dive into the capabilities offered by our API endpoints. Whether you're a developer looking to build on top of the Wiza platform or a business aiming to automate contact management, this documentation will guide you every step of the way.

How to access your API key:

To enable API access on your account, reach out to our customer support team at hello@wiza.co or via our online live chat
Once enabled, click Settings (under profile icon in top right corner)
Click API
Select and API User, this where all lists created using the the API will be saved
Click Generate
Copy your API key

What counts as an API request:

One API call is used per one unique result that Wiza is able to return. Email credits and phone credits are used based on the information that is selected.

For more info on how credits work, check out this article.

What can it do?

With Wiza's API, you can enrich lead lists that verify emails, and phone numbers as well as job titles, contact locations, company information, etc. For a detailed list of the data available, please see here.

The data fields needed to access the API are as follows:

first and last name OR full name

AND
company name OR company domain

OR
LinkedIn URL
- we support URLs from all LinkedIn profiles, Sales Navigator profiles, and Recruiter profiles

To gain a better understanding of the Wiza API, please refer to this link, as we will provide a detailed description of each stage involved in the process.

💡 The header of the API KEY is mandatory in every request to our service.

Endpoints

1. Create List (`POST /api/lists`)

This endpoint lets you create a list of people to enrich.

Request Payload:

Name: A descriptive name for the list, such as "VP of Sales in San Francisco".
Enrichment Level: Choose between partial (find emails only) and full (find emails and phone numbers).
Email Options: Specify the types of emails to return:
- accept_work: Professional email addresses.
- accept_personal: Personal email addresses.
- accept_generic: Generic email addresses.
Items: List of items to be enriched, which can be either contact details or a LinkedIn profile URL. A maximum of 2500 items is allowed per list.

Response:

On success, you'll receive a response with the list's details, its status, and other relevant information.

2. Get List (`GET /api/lists/{id}`)

Fetch the status of a specific list by its ID.

Response:

The returned data includes details of the list, its status, and other related information.

3. Get List Contacts (`GET /api/lists/{id}/contacts`)

Retrieve contacts from a specific list by its ID.

Parameters:

Segment: Specify which contacts to return:
- people: All contacts
- valid: Only valid contacts
- risky: Only risky contacts

By default, the response will be in JSON. If you need the response in CSV, append .csv to the URL path.

Response:

A list of contacts with various details like full name, email, LinkedIn profile, and more, based on the segment you choose.

What data fields are provided?

Depending on the enrichment level selected, partial or full, the number of data fields provided will vary.

Sometimes not all data fields are available for each person. A number of factors can influence the amount of data provided.

User Provides:	Full Name/ First Name, Last Name AND Company/ Domain	Full Name/ First Name, Last Name AND Company/ Domain	LinkedIn OR Sales Nav OR Recruiter (URL)	LinkedIn OR Sales Nav OR Recruiter (URL)
Enrichment Level:	EMAIL ONLY (Partial)	EMAIL + PHONE (Full)	EMAIL ONLY (Partial)	EMAIL + PHONE (Full)
list_name	Yes	Yes	Yes	Yes
email_type	Yes	Yes	Yes	Yes
email_status	Yes	Yes	Yes	Yes
email	Yes	Yes	Yes	Yes
full_name	Yes	Yes	Yes	Yes
first_name	Yes	Yes	Yes	Yes
last_name	Yes	Yes	Yes	Yes
title	No	Yes	Yes	Yes
location	No	Yes	Yes	Yes
linkedin	No	Yes	Yes	Yes
domain	Yes	Yes	Yes	Yes
phone_number1	No	Yes	No	Yes
phone_number2	No	Yes	No	Yes
phone_number3	No	Yes	No	Yes
mobile_phone1	No	Yes	No	Yes
other_phone1	No	Yes	No	Yes
personal_email1	No	Yes	No	Yes
company	Yes	Yes	Yes	Yes
company_domain	Yes	Yes	Yes	Yes
company_industry	Yes	Yes	Yes	Yes
company_subindustry	Yes	Yes	Yes	Yes
company_size	Yes	Yes	Yes	Yes
company_size_range	Yes	Yes	Yes	Yes
company_founded	Yes	Yes	Yes	Yes
company_revenue	Yes	Yes	Yes	Yes
company_funding	Yes	Yes	Yes	Yes
company_type	Yes	Yes	Yes	Yes
company_linkedin	Yes	Yes	Yes	Yes
company_twitter	Yes	Yes	Yes	Yes
company_facebook	Yes	Yes	Yes	Yes
company_description	Yes	Yes	Yes	Yes
company_last_funding_round	Yes	Yes	Yes	Yes
company_last_funding_amount	Yes	Yes	Yes	Yes
company_last_funding_at	Yes	Yes	Yes	Yes
company_location	Yes	Yes	Yes	Yes
company_street	Yes	Yes	Yes	Yes
company_locality	Yes	Yes	Yes	Yes
company_region	Yes	Yes	Yes	Yes
company_country	Yes	Yes	Yes	Yes

Response Status Codes

200: Successful operation.
400: Bad request, reasons can vary (e.g., "Segment is not valid").
401: Unauthorized access.

OpenAPI Specifications

The key components of this specification include:

Components:
- SecuritySchemes: Defines security mechanisms for the API. In this case, it uses bearer_auth, a common method for handling authentication using bearer tokens.
- Schemas: Describes data models used in the API. For example, ContactDetails and LinkedinProfile are defined with their respective properties and types.
Paths: Defines individual endpoints (URLs) and HTTP methods (like GET, POST) that clients can use to access the API. Each path has its own operations (like post for creating a list) and responses. For instance, the /api/lists path allows for creating a list of people to enrich, and the /api/lists/{id} path is for retrieving a list with a given ID.
RequestBodies and Responses: These sections describe the expected requests and responses for the API operations. They include status codes, content types, and example values.
Servers: Provides the base URL (https://wiza.co) for the API, which is the root address where the API is accessible.