---
title: "Create List"
method: POST
path: "/api/lists"
tags: ["Lists"]
---

# Create List

`POST /api/lists`

>
Create a list of people to enrich.

Once the list is completed, an update will be posted to the webhook URL as configured in your [ account settings ]( http://wiza.co/app/settings/api ). The payload will be the same as the response of this endpoint. If you wish to do added authentication, the headers in the webhook request will include `x-auth-key` which will be a SHA256 hash of your api key.

You can get the status of the list by calling the `GET /api/lists/:id` endpoint.
And you can get the contacts by calling the `GET /api/lists/:id/contacts` endpoint.

**Note:** Please check the status of the list as it may fail sometimes due to LinkedIn rate limiting.

## Request body

- object
  - `list` object
    - `name` string, required — Name of the list. e.g. "VP of Sales in San Francisco"
    - `enrichment_level` 'none' | 'partial' | 'full', required — > Enrichment level of the list. | Enrichment Level | Description | |--------|--------------------------------------| | none | Will enrich with contact's data when you provide a Linkedin profile url or email. But will not find emails or phone numbers | | partial| Will find emails. | | full | Will find emails and phone numbers. |
    - `email_options` object, required — Types of emails to return.
      - `accept_work` boolean — Professional email address, i.e. tim.cooke@apple.com
      - `accept_personal` boolean — A personal email address, i.e. tcooke1960@gmail.com
      - `accept_generic` boolean — A generic email address, i.e. hello@apple.com
    - `items` union[], required — List of items to be enriched. Each item can be either contact details or a Linkedin profile URL of any type (Linkedin, Sales Navigator, or Recruiter). There is a limit of 2500 items per list.
      - union
        - union
          - object
            - `full_name` string, required — Full name of the contact. e.g. "Stephen Hakami".
            - `company` string, required — Name of the company. e.g. "Wiza". Either company (company name) or domain is required.
            - `domain` string — Domain of the company. e.g. "wiza.co". Either company (company name) or domain is required.
            - `profile_url` string — URL of the Linkedin profile. e.g. "https://www.linkedin.com/in/stephen-hakami-5babb21b0/".
            - `email` string — Email address of the contact.
          - object
            - `full_name` string, required — Full name of the contact. e.g. "Stephen Hakami".
            - `company` string — Name of the company. e.g. "Wiza". Either company (company name) or domain is required.
            - `domain` string, required — Domain of the company. e.g. "wiza.co". Either company (company name) or domain is required.
            - `profile_url` string — URL of the Linkedin profile. e.g. "https://www.linkedin.com/in/stephen-hakami-5babb21b0/".
            - `email` string — Email address of the contact.
        - LinkedinProfileInput
          - `profile_url` string, required — URL of the Linkedin profile. e.g. "https://www.linkedin.com/in/stephen-hakami-5babb21b0/".
        - EmailInput
          - `email` string, required — Email address of the contact.
    - `callback_url` string — URL to send the list update to. If not provided, the default webhook URL configured in your account settings will be used.
    - `skip_duplicates` boolean — Skip contacts that already exist in recently completed lists in the API folder.

## Response `200`

successful

- ListResponse
  - `status` object
    - `code` integer
    - `message` string
  - `type` 'list'
  - `data` object
    - `id` integer
    - `name` string
    - `status` string
    - `stats` object
      - `people` integer
      - `credits` object
        - `email_credits` integer, nullable
        - `phone_credits` integer, nullable
        - `export_credits` integer, nullable
        - `api_credits` object, nullable
          - `email_credits` integer
          - `phone_credits` integer
          - `scrape_credits` integer
          - `total` integer
    - `finished_at` string, date-time, nullable
    - `created_at` string, date-time
    - `enrichment_level` string
    - `email_options` object
      - `accept_work` boolean
      - `accept_personal` boolean
      - `accept_generic` boolean
    - `report_type` string

## Other responses

- `400` — Error creating list
- `401` — Unauthorized

---

[API](https://skmtc.dev/wiza/apis/wiza-api-documentation.md) · [All operations](https://skmtc.dev/wiza/apis/wiza-api-documentation/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/wiza/wiza-api-documentation/revisions/9773e985f208/schema)