List a person's campaigns

curl --request GET \
  --url https://api.b2bsignals.ai/api/v1/leads/{lead_id}/campaigns \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.b2bsignals.ai/api/v1/leads/{lead_id}/campaigns', 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.b2bsignals.ai/api/v1/leads/{lead_id}/campaigns",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$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.b2bsignals.ai/api/v1/leads/{lead_id}/campaigns"

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

	req.Header.Add("X-API-Key", "<api-key>")

	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.b2bsignals.ai/api/v1/leads/{lead_id}/campaigns")

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

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

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

[
  {
    "source": "workflow",
    "campaign_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "campaign_name": "<string>",
    "campaign_status": "<string>",
    "run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "run_status": "in_progress",
    "last_action": {
      "at": "<string>",
      "text": "<string>",
      "outcome": "<string>"
    },
    "sender": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>"
    },
    "campaign_ref": "<string>",
    "pushed_at": "2023-11-07T05:31:56Z"
  }
]

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

GET

leads

{lead_id}

campaigns

List a person's campaigns

curl --request GET \
  --url https://api.b2bsignals.ai/api/v1/leads/{lead_id}/campaigns \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.b2bsignals.ai/api/v1/leads/{lead_id}/campaigns', 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.b2bsignals.ai/api/v1/leads/{lead_id}/campaigns",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$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.b2bsignals.ai/api/v1/leads/{lead_id}/campaigns"

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

	req.Header.Add("X-API-Key", "<api-key>")

	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.b2bsignals.ai/api/v1/leads/{lead_id}/campaigns")

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

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

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

[
  {
    "source": "workflow",
    "campaign_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "campaign_name": "<string>",
    "campaign_status": "<string>",
    "run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "run_status": "in_progress",
    "last_action": {
      "at": "<string>",
      "text": "<string>",
      "outcome": "<string>"
    },
    "sender": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>"
    },
    "campaign_ref": "<string>",
    "pushed_at": "2023-11-07T05:31:56Z"
  }
]

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

X-API-Key

string

header

required

Your workspace's API key. It starts with b2b_sk_.

Path Parameters

lead_id

string<uuid>

required

Response

Success

source

string

default:workflow

campaign_id

string<uuid> | null

campaign_name

string | null

campaign_status

string | null

run_id

string<uuid> | null

run_status

enum<string> | null

Available options:

in_progress,

finished,

paused,

failed,

excluded

last_action

object | null

Show child attributes

sender

object | null

Show child attributes

campaign_ref

string | null

pushed_at

string<date-time> | null

Build on B2B Signals

API reference

List a person's campaigns

Authorizations

Path Parameters

Response