Skip to main content
GET
/
watchlist
List Signal Agents
curl --request GET \
  --url https://api.lemlist.com/api/watchlist \
  --header 'Authorization: Basic <encoded-value>'
import requests

url = "https://api.lemlist.com/api/watchlist"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://api.lemlist.com/api/watchlist', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
require 'uri'
require 'net/http'

url = URI("https://api.lemlist.com/api/watchlist")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'

response = http.request(request)
puts response.read_body
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.lemlist.com/api/watchlist",
  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: Basic <encoded-value>"
  ],
]);

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

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
{
  "data": [
    {
      "_id": "<string>",
      "name": "<string>",
      "signalOpportunityTemplate": {
        "ownerId": "<string>",
        "data": {
          "title": "<string>",
          "subject": "<string>",
          "emailTemplateId": "<string>",
          "message": "<string>"
        }
      },
      "filters": [
        {
          "in": [
            "<string>"
          ],
          "out": [
            "<string>"
          ]
        }
      ],
      "emoji": "<string>"
    }
  ],
  "meta": {
    "pagination": {
      "page": 123,
      "limit": 123,
      "totalRecords": 123,
      "totalPages": 123
    }
  }
}
"Invalid type values"
"Unauthorized"
"Internal server error"
Results are paginated. Use type and status to narrow the list — both accept a comma-separated list of values. By default every status except delete is returned.

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Query Parameters

​
page
integer

Page number to retrieve

Required range: x >= 1
​
limit
integer

Number of records to retrieve. Maximum value: 100

Required range: 1 <= x <= 100
​
type
string

Filter by signal type(s). Comma-separated list of signal types.

​
status
string

Filter by lifecycle status(es). Comma-separated list. Defaults to every status except delete.

Response

Success

​
data
object[]
​
meta
object