Getting Started

Copy page

Welcome to the Waalaxy API

Waalaxy simplifies LinkedIn and Email prospecting for sales and marketing teams. Our solution automates outreach and follow-ups, offering massive time savings and smoother, more rigorous conversation management.

The Waalaxy API allows you to integrate our platform with your favorite tools like n8n, Zapier, Make and many others.

Key Features

Feature	Description
List Management	Retrieve your prospect lists
Prospect Import	Import prospects from your external tools
Campaigns	Automatically add prospects to your campaigns

Use Cases

• Marketing Automation: Connect Waalaxy to your n8n, Zapier or Make workflows
• Data Enrichment: Import enriched prospects from external sources

Authentication

The Waalaxy API uses API key authentication. Every request must include an Authorization header with the Bearer scheme.

Create your API key

1. Sign in to your Waalaxy account.
2. Open the CRM Sync settings page.
3. Click Generate API key and copy the value. It is shown only once.
4. Store the key in a secure secret manager (or your integration tool's credential store).

Build the request headers

Header	Required	Value	Description
Authorization	yes	Bearer YOUR_API_KEY	Authenticates the request. Replace YOUR_API_KEY with your API key.
Content-Type	yes*	application/json	Required for endpoints that accept a JSON request body.

* Only required on requests that send a JSON body (e.g. the prospect import endpoint).

Example:

Code
 
Authorization: Bearer wa_live_XXXXXXXXXXXXXXXXXXXXXXXX
Content-Type: application/json

Quick Start

1. Get your API key from the CRM Sync settings page.

2. Test the connection by calling GET /integrations/test:

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

   A true response confirms the key is valid.

3. List your prospect lists via GET /prospectLists/getProspectLists and pick the _id of the list you want to import into.

4. List your campaigns via GET /campaigns/getAll and pick the _id of the campaign you want to enrol prospects in (optional).

5. Import prospects via POST /prospects/addProspectFromIntegration:

   Code
    
   curl https://api.waalaxy.com/prospects/addProspectFromIntegration \
     -X POST \
     -H "Authorization: Bearer YOUR_API_KEY" \
     -H "Content-Type: application/json" \
     -d '{
       "prospects": [
         { "url": "https://www.linkedin.com/in/john-doe-123456" }
       ],
       "prospectListId": "695b86fe3b6b619338a0e14a",
       "campaignId": "6967ccd7cd1b75dbab178b35",
       "origin": { "name": "make" }
     }'

The origin field

The origin object is required on the import endpoint and identifies the source of the import in the Waalaxy app. It is unrelated to the API key sent in the Authorization header.

• For native integrations, send the canonical name: make, zapier or n8n. The Waalaxy interface displays the integration logo and label as-is.
• For any other custom value (e.g. example), the value is accepted and the Waalaxy interface displays it prefixed with API-. For example, sending { "origin": { "name": "example" } } will appear as API-example in the user's activity feed.

Code
 
{ "origin": { "name": "make" } }       // native integration, displayed as "Make"
{ "origin": { "name": "example" } }     // custom integration, displayed as "API-example"

Errors

Error responses follow the RFC 7807 Problem Details format. Each error body is a JSON object with the following fields:

Field	Description
type	A URI reference identifying the problem category.
title	Short, human-readable summary of the problem.
status	The HTTP status code of the response.
detail	Human-readable explanation specific to this occurrence.
instance	URI reference identifying the specific occurrence (typically the request path that failed).

Example:

Code
 
{
  "type": "https://httpproblems.com/http-status/401",
  "title": "Unauthorized",
  "status": 401,
  "detail": "Invalid API key.",
  "instance": "/prospects/addProspectFromIntegration"
}

Useful Links

• Waalaxy Website
• Terms of Use
• API Reference

Support

For any technical or commercial questions:

Type	Contact
Technical Support	[email protected]
Marketing & Partnerships	[email protected]