Skip to main content

Use the API to list activity types

Updated over 3 weeks ago

Overview

The GET <https://api.lemlist.com/api/activities> endpoint retrieves various activity types related to your campaigns.

This reference documents each activity type that can be queried using the type query parameter, including JSON response examples and data field explanations.

๐Ÿ’ก For complete API documentation: Visit developer.lemlist.com

Common Data Fields

All activity types include the following common fields:

_id (string) Unique identifier of the activity

type (string) Activity type (e.g., "emailsSent", "linkedinReplied")

createdAt (datetime) Date and time the activity was created

bot (boolean) Whether the activity was initiated by a bot

teamId (string) Unique identifier of the team

leadId (string) Unique identifier of the lead

campaignId (string) Unique identifier of the campaign

metaData (object) Metadata containing teamId, campaignId, leadId, type, createdBy

Plus all custom variables from your lead.

Additional System Fields

These fields may appear in activity responses when relevant data is available:

createdBy (string) User ID who created the activity

emailId (string) lemlist email ID (starts with eml_)

emailTemplateId (string) Template ID for email content

errorMessage (string) Error message (only present if activity failed)

isFirst (boolean) Whether this is the first activity of this type for the related step

leadCompanyName (string) Company name of the lead

leadEmail (string) Email address of the lead

leadFirstName (string) First name of the lead

leadLastName (string) Last name of the lead

leadPhone (string) Phone number of the lead

leadPicture (string) URL to lead's picture

messageId (string) Email provider message ID (e.g., <[email protected]>) or WhatsApp message ID

name (string) Campaign name

relatedSentAt (datetime) Creation date of the related "sent" activity (not present on "sent" activities themselves)

sendUserEmail (string) Email of the user who sent

sendUserId (string) User ID who sent

sendUserMailboxId (string) Mailbox ID used to send

sendUserMailboxProviderId (string) Mailbox provider ID

sendUserName (string) Name of the user who sent

sequenceId (string) Sequence ID

sequenceStep (number) Step number (โš ๏ธ first step is 0)

stopped (boolean) Whether the activity stopped the sequence for the lead

totalSequenceStep (number) Total number of steps in the sequence

Email Activities

emailsSent

Email successfully sent to lead.

Example:

Id
act_XXXXXXXXXXXXXXXXXType
emailsSentBot
NoCampaign Id
cam_XXXXXXXXXXXXXXXXXCreated At
2024-09-16T08:30:00.000ZCreated By
usr_XXXXXXXXXXXXXXXXXEmail Id
eml_XXXXXXXXXXXXXXXXXLead Email
[email protected] First Name
JohnLead Last Name
DoeSend User Email
[email protected] User Id
usr_XXXXXXXXXXXXXXXXXSequence Step
0Stopped
NoTeam Id
tea_XXXXXXXXXXXXXXXXX

emailsOpened

Lead opened the email.

emailsClicked

Lead clicked a link in the email.

Additional field:

location (string) URL that was clicked by the lead

emailsReplied

Lead replied to the email.

emailsDone

Email step completed in sequence.

emailsBounced

Email bounced (hard bounce).

emailsFailed

Email failed to send.

Additional field:

errorMessage (string) Details about why the email failed

emailsUnsubscribed

Lead unsubscribed from emails.

emailsNotInterested

Lead marked as not interested (via email).

emailsInterested

Lead marked as interested (via email).

LinkedIn Activities

linkedinVisitDone

LinkedIn profile visit completed.

linkedinVisitFailed

LinkedIn profile visit failed.

Additional field:

errorMessage (string) Details about why the visit failed

linkedinSent

LinkedIn message sent to lead.

Additional field:

message (string) Content of the LinkedIn message sent

linkedinOpened

Lead opened LinkedIn message.

linkedinInviteAccepted

Lead accepted LinkedIn connection invite.

Additional field:

message (string) Content of the LinkedIn invite sent

linkedinInviteDone

LinkedIn invite sent successfully.

linkedinInviteFailed

LinkedIn invite failed to send.

Additional field:

errorMessage (string) Details about why the invite failed

linkedinSendFailed

LinkedIn message failed to send.

Additional field:

errorMessage (string) Details about why the message failed

linkedinReplied

Lead replied to LinkedIn message.

Additional field:

text (string) Content of the lead's LinkedIn reply

linkedinInterested

Lead marked as interested (via LinkedIn).

linkedinNotInterested

Lead marked as not interested (via LinkedIn).

linkedinDone

LinkedIn step completed in sequence.

linkedinVoiceNoteDone

LinkedIn voice note sent successfully.

linkedinVoiceNoteFailed

LinkedIn voice note failed to send.

Additional field:

errorMessage (string) Details about why the voice note failed

WhatsApp Activities

whatsappMessageSent

WhatsApp message sent to lead.

Additional fields:

message (string) Content of the WhatsApp message

sentOutSideOfLemlist (boolean) Whether the message was sent outside lemlist

sendUserWhatsappAccountId (string) WhatsApp account ID used to send

whatsappMessageDelivered

WhatsApp message delivered to lead.

whatsappMessageOpened

Lead opened WhatsApp message.

Additional field:

sendUserWhatsappAccountId (string) WhatsApp account ID

whatsappMessageFailed

WhatsApp message failed to send.

Additional fields:

errorMessage (string) Details about why the message failed

sendUserWhatsappAccountId (string) WhatsApp account ID

whatsappReplied

Lead replied to WhatsApp message.

Additional fields:

message (string) Content of the lead's reply

sendUserWhatsappAccountId (string) WhatsApp account ID

whatsappIgnored

WhatsApp message marked as ignored.

Additional field:

sendUserWhatsappAccountId (string) WhatsApp account ID

manualWhatsappMessageQueued

Manual WhatsApp message queued for sending.

Additional field:

sendUserWhatsappAccountId (string) WhatsApp account ID

AirCall Activities

aircallDone

AirCall call step completed.

aircallCreated

AirCall call created/initiated.

Additional fields:

aircallPhone (string) AirCall phone number that was called

aircallPhoneName (string) Name associated with the phone number

direction (string) Call direction: "inbound" or "outbound"

duration (number) Call duration in seconds

endedAt (datetime) Call end time

recording (string or null) URL of the call recording (null if not available)

startedAt (datetime) Call start time

aircallEnded

AirCall call ended.

Additional fields: Same as aircallCreated

aircallInterested

Lead marked as interested (via AirCall).

aircallNotInterested

Lead marked as not interested (via AirCall).

API Activities

apiDone

API call step completed.

Additional field:

url (string) URL of the API call that was executed

apiInterested

Lead marked as interested (via API).

apiNotInterested

Lead marked as not interested (via API).

apiFailed

API call failed.

Additional field:

errorMessage (string) Details about why the API call failed

apiUnsubscribed

Lead unsubscribed (via API).

Manual Task Activities

manualDone

Manual task completed.

manualInterested

Lead manually marked as interested.

manualNotInterested

Lead manually marked as not interested.

snoozed

Lead snoozed for a delay period.

Additional field:

delay (number) Snooze delay in seconds

annotated

Note added to lead.

Additional field:

note (string) Content of the note that was added

lemcal Activity

meetingBooked

Meeting booked via lemcal.

Additional fields:

meetingDate (datetime) Date and time of the booked meeting

meetingType (string) Type or title of the meeting

Other Activities

conditionChosen

Conditional step evaluated in sequence.

Additional fields:

conditionLabel (string) Description of the condition that was evaluated

conditionValue (boolean) Whether the condition was met (true) or not (false)

paused

Lead paused in campaign.

resumed

Lead resumed in campaign.

skipped

Step skipped in sequence.

Additional field:

errorMessage (string) Details about why the step was skipped

sendToAnotherCampaign

Lead sent to another campaign.

Grouped Activity Types

These grouped types can be used to query multiple related activity types at once:

contacted

All "sent" activities:

  • emailsSent

  • linkedinSent

hooked

All "open" activities:

  • emailsOpened

  • linkedinOpened

attracted

All "click/accept" activities:

  • emailsClicked

  • linkedinInviteAccepted

warmed

All "reply" activities:

  • emailsReplied

  • linkedinReplied

interested

All "interested" activities:

  • emailsInterested

  • aircallInterested

  • apiInterested

  • manualInterested

  • linkedinInterested

notInterested

All "not interested" activities:

  • emailsNotInterested

  • aircallNotInterested

  • apiNotInterested

  • manualNotInterested

  • linkedinNotInterested

Did this answer your question?