Skip to main content
All CollectionsAPI
Wiza's API: Everything you need to know!
Wiza's API: Everything you need to know!
Prospero avatar
Written by Prospero
Updated over 4 months ago

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.

In this article:

* For usage details and more info, please visit the API docs: https://wiza.co/api-docs

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:

  1. To enable API access on your account, reach out to our customer support team at hello@wiza.co or via our online live chat

  2. Once enabled, click Settings (under profile icon in top right corner)

  3. Click API

  4. Select and API User, this where all lists created using the the API will be saved

  5. Click Generate

  6. Copy your API key

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

    OR

  • Various available filters (job title, location, school, company size, company industry, etc)

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.

Key Functionalities

1. Create and Manage Lists:

  • Endpoint: POST /api/lists

  • Description: Create a list of contacts for enrichment, adding LinkedIn profiles, emails, phone numbers, and more.

  • Payload Fields:

    • name: Descriptive name of the list.

    • enrichment_level: Choose between partial (email only) and full (email + phone number).

    • email_options: Filter email types (work, personal, or generic).

    • items: Add up to 2500 profiles (LinkedIn URL, name, or company details).

  • Use Case: Build lists for specific roles or industries, like “VPs of Sales in New York.”

2. List Status and Management:

  • Endpoints:

    • GET /api/lists/{id}: Check status of list by ID.

    • GET /api/lists/{id}/contacts: Retrieve list of contacts by ID.

  • Response Fields:

    • List details, enrichment levels, valid or risky contact filters, status updates.

    • Ability to export results in JSON or CSV format.

  • Use Case: Track ongoing list creation or retrieve enriched data for sales, marketing, or recruiting.

3. Data Enrichment:

  • Enrichment Options:

    • Partial enrichment for emails only.

    • Full enrichment with phone numbers, company details, job titles, and more.

  • Supported Data Types:

    • Name, job title, email (professional, personal), phone numbers, LinkedIn profiles, location, and more.

  • Advanced Enrichment:

    • Enrich profiles with deep LinkedIn insights, including Sales Navigator and Recruiter URLs.

    • Enrich company data: domain, industry, size, revenue, funding, social media profiles (LinkedIn, Twitter, Facebook), and company description.

4. Batch Processing:

  • Add up to 2500 contacts per request.

  • Enrichment for large datasets, ideal for teams working with significant lead volume.

5. Custom Segmentation:

  • Segment Contacts:

    • valid: Return only valid, verified contacts.

  • risky: Identify contacts with potential data issues (e.g., invalid emails).

  • people: Retrieve all enriched contacts from the list.

  • Use Case: Filter leads based on verified data for more efficient marketing or outreach.

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: Success – Data retrieved successfully.

400: Bad request (e.g., invalid parameters).

401: Unauthorized – Ensure correct API key or access level.

  • Detailed Error Messages: For all unsuccessful requests, helpful error messages guide users to correct the issue.

  • Use Case: Ensure smooth and predictable integration into your system with robust handling of API errors.

OpenAPI Specifications

The key components of this specification include:

  1. 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.

  2. 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.

  3. RequestBodies and Responses: These sections describe the expected requests and responses for the API operations. They include status codes, content types, and example values.

  4. Servers: Provides the base URL (https://wiza.co) for the API, which is the root address where the API is accessible.

Related Articles
Everything you need to know about Wiza Prospect
Do I need to download the Wiza extension?
Can I upload a list of Emails to Wiza?
How to integrate Wiza with Creatio
Duplicates in Wiza: Everything You Need to Know
Did this answer your question?