v1

latestOpenAPI 3.0.12026-07-26131186.5 KB
Prospect Lists

Create prospect list

Create a list of prospects that match your filters

post/api/prospects/create_prospect_list

Request body

Example request

{
  "list": {
    "name": "VP of Sales in San Francisco",
    "max_profiles": 10,
    "enrichment_level": "partial",
    "email_options": {
      "accept_work": true,
      "accept_personal": true,
      "accept_generic": true
    }
  },
  "filters": {
    "first_name": [
      "John",
      "Jane"
    ],
    "last_name": [
      "Smith"
    ],
    "job_title": [
      {
        "v": "CEO"
      }
    ],
    "location": [
      {
        "v": "Toronto, Ontario, Canada"
      }
    ],
    "linkedin_slug": [
      "stephen-hakami-5babb21b0",
      "https://linkedin.com/in/stephen-hakami-5babb21b0"
    ],
    "job_company": [
      {
        "v": "Wiza",
        "s": "i"
      }
    ],
    "past_company": [
      {
        "v": "Wiza",
        "s": "i"
      }
    ],
    "company_location": [
      {
        "v": "Toronto, Ontario, Canada",
        "b": "city",
        "s": "e"
      }
    ],
    "company_industry": [
      {
        "v": "building materials"
      },
      {
        "v": "capital markets",
        "s": "e"
      }
    ],
    "technologies": [
      {
        "v": "amazon-web-services"
      },
      {
        "v": "salesforce",
        "s": "e"
      }
    ],
    "department_size": [
      "sales:10-50"
    ],
    "company_summary": [
      {
        "v": "cutting-edge"
      }
    ],
    "year_founded_start": "2020",
    "year_founded_end": "2024"
  }
}

Response

successful

type'list'

Example response

{
  "status": {
    "code": 200,
    "message": "🧙 Wiza is working on it!"
  },
  "type": "list",
  "data": {
    "id": 15,
    "name": "VP of Sales in San Francisco",
    "status": "queued",
    "stats": {
      "people": 2,
      "credits": {
        "email_credits": 1,
        "phone_credits": 1,
        "export_credits": 1,
        "api_credits": {
          "email_credits": 2,
          "phone_credits": 5,
          "scrape_credits": 1,
          "total": 8
        }
      }
    },
    "enrichment_level": "partial",
    "email_options": {
      "accept_work": true,
      "accept_personal": true,
      "accept_generic": true
    },
    "report_type": "people"
  }
}