List campaign leads

curl --request GET \
  --url https://api.mailbeast.ai/v1/campaigns/{cid}/leads \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.mailbeast.ai/v1/campaigns/{cid}/leads', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.mailbeast.ai/v1/campaigns/{cid}/leads",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.mailbeast.ai/v1/campaigns/{cid}/leads"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.mailbeast.ai/v1/campaigns/{cid}/leads")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "id": "c9e5b1a3-7f24-4d80-a6b9-2e4f8c0d1a37",
      "email": "[email protected]",
      "tags": [
        "vip",
        "q4"
      ],
      "customFields": {
        "industry": "SaaS"
      },
      "status": "not_contacted",
      "verification": {
        "status": "valid",
        "subStatus": "email_ok"
      },
      "metrics": {
        "sent": 2,
        "opened": 1,
        "clicked": 0,
        "replied": 0
      },
      "createdAt": "2023-11-07T05:31:56Z",
      "firstName": "Jane",
      "lastName": "Doe",
      "companyName": "Acme Inc",
      "jobTitle": "VP Sales",
      "website": "https://acme.com",
      "linkedinProfile": "https://www.linkedin.com/in/janedoe",
      "location": "New York, US",
      "provider": "google",
      "sequenceProgress": {
        "totalSteps": 3,
        "sentCount": 1,
        "plannedCount": 1,
        "failedCount": 0,
        "nextPlannedAt": "2023-11-07T05:31:56Z"
      },
      "lastContactedAt": "2023-11-07T05:31:56Z",
      "lastRepliedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "meta": {
    "hasMore": true,
    "nextCursor": "eyJ0cyI6IjIwMjYtMDctMDJUMDA6MDA6MDAuMDAwWiIsImlkIjoiM2YxYzJiN2UtOWE0ZC00ZTE4LWIyYzEtNmQ4ZjVhMGU3YzkzIn0"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "validation_failed",
    "message": "One or more fields are invalid.",
    "status": 400,
    "requestId": "e4f1c0b2-6a3d-4b8e-9f21-0a1b2c3d4e5f",
    "details": [
      "name should not be empty"
    ]
  }
}

{
  "error": {
    "type": "authentication_error",
    "code": "unauthenticated",
    "message": "Missing or invalid API key.",
    "status": 401,
    "requestId": "e4f1c0b2-6a3d-4b8e-9f21-0a1b2c3d4e5f"
  }
}

{
  "error": {
    "type": "authorization_error",
    "code": "permission_denied",
    "message": "This API key is missing the required scope.",
    "status": 403,
    "requestId": "e4f1c0b2-6a3d-4b8e-9f21-0a1b2c3d4e5f"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "not_found",
    "message": "Resource not found.",
    "status": 404,
    "requestId": "e4f1c0b2-6a3d-4b8e-9f21-0a1b2c3d4e5f"
  }
}

{
  "error": {
    "type": "rate_limit_error",
    "code": "rate_limited",
    "message": "Too many requests. Retry after the interval in the Retry-After header.",
    "status": 429,
    "requestId": "e4f1c0b2-6a3d-4b8e-9f21-0a1b2c3d4e5f",
    "retryAfter": 30
  }
}

GET

campaigns

{cid}

leads

List campaign leads

curl --request GET \
  --url https://api.mailbeast.ai/v1/campaigns/{cid}/leads \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.mailbeast.ai/v1/campaigns/{cid}/leads', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.mailbeast.ai/v1/campaigns/{cid}/leads",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.mailbeast.ai/v1/campaigns/{cid}/leads"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.mailbeast.ai/v1/campaigns/{cid}/leads")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "id": "c9e5b1a3-7f24-4d80-a6b9-2e4f8c0d1a37",
      "email": "[email protected]",
      "tags": [
        "vip",
        "q4"
      ],
      "customFields": {
        "industry": "SaaS"
      },
      "status": "not_contacted",
      "verification": {
        "status": "valid",
        "subStatus": "email_ok"
      },
      "metrics": {
        "sent": 2,
        "opened": 1,
        "clicked": 0,
        "replied": 0
      },
      "createdAt": "2023-11-07T05:31:56Z",
      "firstName": "Jane",
      "lastName": "Doe",
      "companyName": "Acme Inc",
      "jobTitle": "VP Sales",
      "website": "https://acme.com",
      "linkedinProfile": "https://www.linkedin.com/in/janedoe",
      "location": "New York, US",
      "provider": "google",
      "sequenceProgress": {
        "totalSteps": 3,
        "sentCount": 1,
        "plannedCount": 1,
        "failedCount": 0,
        "nextPlannedAt": "2023-11-07T05:31:56Z"
      },
      "lastContactedAt": "2023-11-07T05:31:56Z",
      "lastRepliedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "meta": {
    "hasMore": true,
    "nextCursor": "eyJ0cyI6IjIwMjYtMDctMDJUMDA6MDA6MDAuMDAwWiIsImlkIjoiM2YxYzJiN2UtOWE0ZC00ZTE4LWIyYzEtNmQ4ZjVhMGU3YzkzIn0"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "validation_failed",
    "message": "One or more fields are invalid.",
    "status": 400,
    "requestId": "e4f1c0b2-6a3d-4b8e-9f21-0a1b2c3d4e5f",
    "details": [
      "name should not be empty"
    ]
  }
}

{
  "error": {
    "type": "authentication_error",
    "code": "unauthenticated",
    "message": "Missing or invalid API key.",
    "status": 401,
    "requestId": "e4f1c0b2-6a3d-4b8e-9f21-0a1b2c3d4e5f"
  }
}

{
  "error": {
    "type": "authorization_error",
    "code": "permission_denied",
    "message": "This API key is missing the required scope.",
    "status": 403,
    "requestId": "e4f1c0b2-6a3d-4b8e-9f21-0a1b2c3d4e5f"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "not_found",
    "message": "Resource not found.",
    "status": 404,
    "requestId": "e4f1c0b2-6a3d-4b8e-9f21-0a1b2c3d4e5f"
  }
}

{
  "error": {
    "type": "rate_limit_error",
    "code": "rate_limited",
    "message": "Too many requests. Retry after the interval in the Retry-After header.",
    "status": 429,
    "requestId": "e4f1c0b2-6a3d-4b8e-9f21-0a1b2c3d4e5f",
    "retryAfter": 30
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

cid

string<uuid>

required

Example:

"a7d4e2f1-08b3-4c65-9e7a-1b2c3d4e5f60"

Query Parameters

cursor

string

Opaque cursor from a previous response’s meta.nextCursor. Omit for the first page. Results are ordered newest-first and stable under concurrent changes.

Example:

"eyJ0cyI6IjIwMjYtMDctMDJUMDA6MDA6MDAuMDAwWiIsImlkIjoiM2YxYzJiN2UtOWE0ZC00ZTE4LWIyYzEtNmQ4ZjVhMGU3YzkzIn0"

limit

number

default:50

Required range: 1 <= x <= 250

Example:

50

string

Match on email / first name / last name / company.

Example:

"acme"

status

enum<string>

Filter by lead status.

Available options:

not_contacted,

scheduled,

email_sent,

failed,

skipped,

lead_replied_interested,

lead_replied_meeting_request,

lead_replied_out_of_office,

lead_replied_bounce,

lead_replied_wrong_person,

lead_replied_not_interested,

lead_replied_unsubscribed,

lead_replied_uncategorized,

lead_converted,

lead_lost,

blacklisted

Response

data

object[]

required

Show child attributes

Lead Finder

Email Accounts

Campaigns

Emails

Leads

API Keys

Workspace

Analytics

List campaign leads

Authorizations

Path Parameters

Query Parameters

Response