Getting Started

Copy page

Usage Guide

This guide walks you through using the Waalaxy API to automate your prospecting.

Typical Workflow

Code
 
graph LR
    A[Get lists] --> B[Get campaigns]
    B --> C[Import prospects]
    C --> D[Prospects added to campaign]

1. Get Your Prospect Lists

Before importing prospects, retrieve your existing lists:

Code
 
curl -X GET "https://api.waalaxy.com/prospectLists/getProspectLists" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response:

Code
 
[
    {
        "_id": "695b86fe3b6b619338a0e14a",
        "name": "My prospect list",
        "totalProspects": 150
    }
]

Note the _id of the list where you want to import your prospects.

2. Get Your Campaigns

If you want to add prospects to a campaign, first retrieve the list of campaigns:

Code
 
curl -X GET "https://api.waalaxy.com/campaigns/getAll" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response:

Code
 
{
    "total": 3,
    "campaigns": [
        {
            "_id": "6967ccd7cd1b75dbab178b35",
            "name": "Email Finder Campaign"
        }
    ]
}

3. Import Prospects

Use the import endpoint to add prospects to a list and optionally to a campaign:

Code
 
curl -X POST "https://api.waalaxy.com/prospects/addProspectFromIntegration" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "prospects": [
      {
        "url": "https://www.linkedin.com/in/johndoe",
        "customProfile": {
          "firstName": "John",
          "lastName": "Doe",
          "email": "[email protected]",
          "company": {
            "name": "Acme Corp"
          }
        }
      }
    ],
    "prospectListId": "695b86fe3b6b619338a0e14a",
    "campaignId": "6967ccd7cd1b75dbab178b35",
    "origin": {
      "name": "zapier"
    }
  }'

Custom Profile Fields

You can enrich your prospects with the following information:

Field	Type	Description
firstName	string	First name
lastName	string	Last name
email	string	Email address
gender	enum	male, female, undetermined
headline	string	LinkedIn headline
occupation	string	Job title
company	object	Company information
phoneNumbers	array	List of phone numbers
region	string	Region / Location
birthday	object	Birthday date

Company Object Structure

Code
 
{
    "name": "Acme Corp",
    "linkedinUrl": "https://www.linkedin.com/company/acme",
    "website": "https://acme.com"
}

Phone Numbers Structure

Code
 
{
    "phoneNumbers": [
        {
            "type": "mobile",
            "number": "+33612345678"
        }
    ]
}

Import Options

The import endpoint accepts a few optional flags to control how prospects are handled when they already exist in the user's account, and a required origin field to tag the source of the import.

Option	Type	Description
canCreateDuplicates	boolean	Allow duplicates (default: false)
moveDuplicatesToOtherList	boolean	Move duplicates to another list
origin	object	Integration source (n8n, zapier, make)

Supported Origins

The API supports the following integrations:

• n8n - Open-source automation platform
• Zapier - No-code application connector
• Make (formerly Integromat) - Visual automation

Test the Connection

Before starting, verify that your API key works:

Code
 
curl -X GET "https://api.waalaxy.com/integrations/test" \
  -H "Authorization: Bearer YOUR_API_KEY"

A true response confirms that authentication is correct.