Skip to main content
GET
/
watchlist
/
signals
Get Watchlist Signals
curl --request GET \
  --url https://api.lemlist.com/api/watchlist/signals
{
  "signals": [
    {
      "_id": "<string>",
      "teamId": "<string>",
      "watchListId": "<string>",
      "type": "companyIsHiring",
      "status": "new",
      "receivedAt": "2023-11-07T05:31:56Z",
      "createdAt": "2023-11-07T05:31:56Z",
      "signalData": {
        "jobTitle": "<string>",
        "jobDescription": "<string>",
        "jobLocation": "<string>",
        "jobUrl": "<string>",
        "jobStatus": "<string>",
        "websiteVisited": "<string>",
        "visitorWebsite": "<string>",
        "linkedinPostUrl": "<string>",
        "linkedinPostText": "<string>",
        "linkedinReactionType": "<string>",
        "linkedinReactedAt": "2023-11-07T05:31:56Z",
        "linkedinCommentText": "<string>"
      },
      "watchListName": "<string>",
      "contact": {
        "_id": "<string>",
        "firstName": "<string>",
        "lastName": "<string>",
        "email": "<string>",
        "jobTitle": "<string>",
        "phone": "<string>",
        "linkedinUrl": "<string>",
        "picture": "<string>"
      },
      "company": {
        "_id": "<string>",
        "name": "<string>",
        "domain": "<string>",
        "linkedinUrl": "<string>",
        "industry": "<string>",
        "picture": "<string>"
      }
    }
  ],
  "total": 123,
  "page": 123,
  "offset": 123,
  "limit": 123
}
This endpoint uses the Signal object.
This endpoint allows you to fetch signals detected by your watchlists with support for filtering by type, status, date range, and watchlist ID.

Query Parameters

​
page
integer

Page number to retrieve (cannot be used with offset)

Required range: x >= 1
​
offset
integer

Number of records to skip (cannot be used with page)

Required range: x >= 0
​
limit
integer

Number of signals to retrieve. Maximum value: 100

Required range: 1 <= x <= 100
​
sortBy
enum<string>

The field by which to sort signals

Available options:
receivedAt,
createdAt
​
sortOrder
enum<string>

The sort direction

Available options:
asc,
desc
​
type

Filter by signal type(s). Can be a single value or array using type[] notation. Valid values from WATCH_LIST_SIGNAL_CONFIGURATIONS_TYPES_STANDARD_KEYS

​
status

Filter by signal status(es). Can be a single value or array using status[] notation. Valid values from WATCH_LIST_SIGNAL_COMPUTED_STATUSES

​
receivedAtFrom
string<date-time>

Filter signals received on or after this date (ISO date string)

​
receivedAtTo
string<date-time>

Filter signals received on or before this date (ISO date string). Must be greater than receivedAtFrom if both are provided

​
watchListId
string

Filter signals by specific watchlist ID

Minimum string length: 1

Response

Success

Paginated response containing watchlist signals

​
signals
object[]

Array of signals matching the query parameters

​
total
integer

Total number of signals matching the filter criteria

​
page
integer

Current page number (if using page-based pagination)

​
offset
integer

Current offset (if using offset-based pagination)

​
limit
integer

Number of signals returned in this response