v1

latestOpenAPI 3.0.12026-07-26131186.5 KB

Lists

Create List

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

post/api/lists

Request body

Example request

{
  "list": {
    "name": "VP of Sales in San Francisco",
    "enrichment_level": "partial",
    "email_options": {
      "accept_work": true,
      "accept_personal": true,
      "accept_generic": true
    },
    "items": [
      {
        "full_name": "Stephen Hakami",
        "company": "Wiza",
        "domain": "wiza.co"
      },
      {
        "profile_url": "https://www.linkedin.com/in/stephen-hakami-5babb21b0/"
      },
      {
        "email": "stephen@wiza.co"
      }
    ]
  }
}

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"
  }
}