{
"seq_rH5RD3fMkkt2gM3YC": {
"_id": "seq_rH5RD3fMkkt2gM3YC",
"steps": [
{
"_id": "stp_sFUj6keaSz9wr049M",
"delay": 0,
"emailTemplateId": "etp_ahlbc2yafFyu728H8",
"type": "linkedinSend",
"index": 1,
"sequenceId": "seq_rH5RD3fMkkt2gM3YC",
"sequenceStep": 0,
"message": "Hey {{firstName}}, \n\nwe're launching an event, a place where people can regularly meet, network, and learn from each other. We would love it if you could join us for a drink & chat next week. What do you say? 😊"
},
{
"_id": "stp_qsTl0LO6zkQQJQqsP",
"delay": 1,
"emailTemplateId": "etp_HFjUGtyDxIOxgZYcG",
"index": 2,
"sequenceId": "seq_rH5RD3fMkkt2gM3YC",
"sequenceStep": 1,
"subject": "{{firstName}}, do we count on you for the event?",
"message": "<p style=\"margin: 0px; box-sizing: border-box;\">Hey {{firstName}},<br style=\"box-sizing: border-box;\"><br style=\"box-sizing: border-box;\"></p>\n<p style=\"margin: 0px; box-sizing: border-box;\">Do you have any plans for Thursday, 7pm?<br style=\"box-sizing: border-box;\"><br style=\"box-sizing: border-box;\"></p>\n<p style=\"margin: 0px; box-sizing: border-box;\">What about spending the evening with cool people by our office?<br style=\"box-sizing: border-box;\"><br style=\"box-sizing: border-box;\"></p>\n<p style=\"margin: 0px; box-sizing: border-box;\">We're launching an event, a place where people can regularly meet, network, and build connections that help them grow further 😊<br style=\"box-sizing: border-box;\"><br style=\"box-sizing: border-box;\"></p>\n<p style=\"margin: 0px; box-sizing: border-box;\">It would be really nice if we could count on you for the event- <a target=\"_blank\" style=\"color: rgb(0, 123, 255); text-decoration: none; background-color: transparent; user-select: auto; box-sizing: border-box;\" rel=\"noopener noreferrer\" href=\"{{event_link_to_send}}\">here's your invite</a> 🔥</p><p style=\"margin: 0px; box-sizing: border-box;\"><br style=\"box-sizing: border-box;\"></p>\n<p style=\"margin: 0px; box-sizing: border-box;\">Can you make it?<br style=\"box-sizing: border-box;\"><br style=\"box-sizing: border-box;\"></p>\n<p style=\"margin: 0px; box-sizing: border-box;\">Sarah,</p><p style=\"margin: 0px; box-sizing: border-box;\">Head of Marketing</p>",
"type": "email"
},
{
"_id": "stp_pRcXzJDmOrBkFtNc3",
"delay": 1,
"emailTemplateId": "etp_3tjFTgdOMS6JL8U1g",
"index": 3,
"sequenceId": "seq_rH5RD3fMkkt2gM3YC",
"sequenceStep": 2,
"subject": "{{firstName}}, do we count on you for the event?",
"message": "<p style=\"margin: 0px; box-sizing: border-box;\">So, should I add you to the list of attendees?<br style=\"box-sizing: border-box;\"><br style=\"box-sizing: border-box;\"></p>\n<p style=\"margin: 0px; box-sizing: border-box;\">We'll meet around 7pm, have a drink and exchange with entrepreneurs, marketers, and salespeople.<br style=\"box-sizing: border-box;\"><br style=\"box-sizing: border-box;\"></p>\n<p style=\"margin: 0px; box-sizing: border-box;\"><a target=\"_blank\" style=\"color: rgb(0, 123, 255); text-decoration: none; background-color: transparent; user-select: auto; box-sizing: border-box;\" rel=\"noopener noreferrer\" href=\"{{event_link_to_send}}\">Here's the link</a> if you want to join!<br style=\"box-sizing: border-box;\"><br style=\"box-sizing: border-box;\"></p>\n<p style=\"margin: 0px; box-sizing: border-box;\">We would love to have you with us for this event!<br style=\"box-sizing: border-box;\"><br style=\"box-sizing: border-box;\">Sarah</p><p style=\"margin: 0px; box-sizing: border-box;\">Head of Marketing</p>",
"type": "email"
},
{
"_id": "stp_Ae93hiemDkypHLys2",
"delay": 2,
"index": 4,
"sequenceId": "seq_rH5RD3fMkkt2gM3YC",
"sequenceStep": 3,
"type": "conditional",
"conditions": [
{
"sequenceId": "seq_jacL5GNH3YpNnuNQ2",
"key": "customLeadInfo",
"name": "Decision makers",
"label": "If lead variable \"jobTitle\" contains \"CEO, Founder\"",
"selector": "{\"$or\":[{\"variables.jobTitle\":{\"$regex\":\"CEO\",\"$options\":\"i\"}},{\"variables.jobTitle\":{\"$regex\":\"Founder\",\"$options\":\"i\"}}]}"
},
{
"sequenceId": "seq_xzrGLxhZwoo5oxukc",
"key": "customLeadInfo",
"label": "If lead variable \"jobTitle\" contains \"CTO\"",
"selector": "{\"variables.jobTitle\":{\"$regex\":\"CTO\",\"$options\":\"i\"}}"
},
{
"sequenceId": "seq_Kd8pQrLm3Nv6Tz0Wy",
"fallback": true
}
]
}
],
"level": 0
},
"seq_jacL5GNH3YpNnuNQ2": {
"_id": "seq_jacL5GNH3YpNnuNQ2",
"steps": [
{
"_id": "stp_Tq5mWx8Rn2Kd7Yz3B",
"delay": 0,
"index": 1,
"sequenceId": "seq_jacL5GNH3YpNnuNQ2",
"sequenceStep": 0,
"type": "linkedinInvite",
"message": "Hi {{firstName}}, would love to connect ahead of the event!"
}
],
"level": 1,
"parentId": "seq_rH5RD3fMkkt2gM3YC",
"conditionalStepIndex": 4
}
}
Bad team
The authentication you supplied is incorrect
Campaign not found
Sequences
Get Campaign Sequences
Retrieves all sequences and their steps for a specific campaign.
{
"seq_rH5RD3fMkkt2gM3YC": {
"_id": "seq_rH5RD3fMkkt2gM3YC",
"steps": [
{
"_id": "stp_sFUj6keaSz9wr049M",
"delay": 0,
"emailTemplateId": "etp_ahlbc2yafFyu728H8",
"type": "linkedinSend",
"index": 1,
"sequenceId": "seq_rH5RD3fMkkt2gM3YC",
"sequenceStep": 0,
"message": "Hey {{firstName}}, \n\nwe're launching an event, a place where people can regularly meet, network, and learn from each other. We would love it if you could join us for a drink & chat next week. What do you say? 😊"
},
{
"_id": "stp_qsTl0LO6zkQQJQqsP",
"delay": 1,
"emailTemplateId": "etp_HFjUGtyDxIOxgZYcG",
"index": 2,
"sequenceId": "seq_rH5RD3fMkkt2gM3YC",
"sequenceStep": 1,
"subject": "{{firstName}}, do we count on you for the event?",
"message": "<p style=\"margin: 0px; box-sizing: border-box;\">Hey {{firstName}},<br style=\"box-sizing: border-box;\"><br style=\"box-sizing: border-box;\"></p>\n<p style=\"margin: 0px; box-sizing: border-box;\">Do you have any plans for Thursday, 7pm?<br style=\"box-sizing: border-box;\"><br style=\"box-sizing: border-box;\"></p>\n<p style=\"margin: 0px; box-sizing: border-box;\">What about spending the evening with cool people by our office?<br style=\"box-sizing: border-box;\"><br style=\"box-sizing: border-box;\"></p>\n<p style=\"margin: 0px; box-sizing: border-box;\">We're launching an event, a place where people can regularly meet, network, and build connections that help them grow further 😊<br style=\"box-sizing: border-box;\"><br style=\"box-sizing: border-box;\"></p>\n<p style=\"margin: 0px; box-sizing: border-box;\">It would be really nice if we could count on you for the event- <a target=\"_blank\" style=\"color: rgb(0, 123, 255); text-decoration: none; background-color: transparent; user-select: auto; box-sizing: border-box;\" rel=\"noopener noreferrer\" href=\"{{event_link_to_send}}\">here's your invite</a> 🔥</p><p style=\"margin: 0px; box-sizing: border-box;\"><br style=\"box-sizing: border-box;\"></p>\n<p style=\"margin: 0px; box-sizing: border-box;\">Can you make it?<br style=\"box-sizing: border-box;\"><br style=\"box-sizing: border-box;\"></p>\n<p style=\"margin: 0px; box-sizing: border-box;\">Sarah,</p><p style=\"margin: 0px; box-sizing: border-box;\">Head of Marketing</p>",
"type": "email"
},
{
"_id": "stp_pRcXzJDmOrBkFtNc3",
"delay": 1,
"emailTemplateId": "etp_3tjFTgdOMS6JL8U1g",
"index": 3,
"sequenceId": "seq_rH5RD3fMkkt2gM3YC",
"sequenceStep": 2,
"subject": "{{firstName}}, do we count on you for the event?",
"message": "<p style=\"margin: 0px; box-sizing: border-box;\">So, should I add you to the list of attendees?<br style=\"box-sizing: border-box;\"><br style=\"box-sizing: border-box;\"></p>\n<p style=\"margin: 0px; box-sizing: border-box;\">We'll meet around 7pm, have a drink and exchange with entrepreneurs, marketers, and salespeople.<br style=\"box-sizing: border-box;\"><br style=\"box-sizing: border-box;\"></p>\n<p style=\"margin: 0px; box-sizing: border-box;\"><a target=\"_blank\" style=\"color: rgb(0, 123, 255); text-decoration: none; background-color: transparent; user-select: auto; box-sizing: border-box;\" rel=\"noopener noreferrer\" href=\"{{event_link_to_send}}\">Here's the link</a> if you want to join!<br style=\"box-sizing: border-box;\"><br style=\"box-sizing: border-box;\"></p>\n<p style=\"margin: 0px; box-sizing: border-box;\">We would love to have you with us for this event!<br style=\"box-sizing: border-box;\"><br style=\"box-sizing: border-box;\">Sarah</p><p style=\"margin: 0px; box-sizing: border-box;\">Head of Marketing</p>",
"type": "email"
},
{
"_id": "stp_Ae93hiemDkypHLys2",
"delay": 2,
"index": 4,
"sequenceId": "seq_rH5RD3fMkkt2gM3YC",
"sequenceStep": 3,
"type": "conditional",
"conditions": [
{
"sequenceId": "seq_jacL5GNH3YpNnuNQ2",
"key": "customLeadInfo",
"name": "Decision makers",
"label": "If lead variable \"jobTitle\" contains \"CEO, Founder\"",
"selector": "{\"$or\":[{\"variables.jobTitle\":{\"$regex\":\"CEO\",\"$options\":\"i\"}},{\"variables.jobTitle\":{\"$regex\":\"Founder\",\"$options\":\"i\"}}]}"
},
{
"sequenceId": "seq_xzrGLxhZwoo5oxukc",
"key": "customLeadInfo",
"label": "If lead variable \"jobTitle\" contains \"CTO\"",
"selector": "{\"variables.jobTitle\":{\"$regex\":\"CTO\",\"$options\":\"i\"}}"
},
{
"sequenceId": "seq_Kd8pQrLm3Nv6Tz0Wy",
"fallback": true
}
]
}
],
"level": 0
},
"seq_jacL5GNH3YpNnuNQ2": {
"_id": "seq_jacL5GNH3YpNnuNQ2",
"steps": [
{
"_id": "stp_Tq5mWx8Rn2Kd7Yz3B",
"delay": 0,
"index": 1,
"sequenceId": "seq_jacL5GNH3YpNnuNQ2",
"sequenceStep": 0,
"type": "linkedinInvite",
"message": "Hi {{firstName}}, would love to connect ahead of the event!"
}
],
"level": 1,
"parentId": "seq_rH5RD3fMkkt2gM3YC",
"conditionalStepIndex": 4
}
}
Bad team
The authentication you supplied is incorrect
Campaign not found
For example, if the main sequence includes a condition that contains two sequences, you will receive both the sequence tree and all condition sequences in the main sequences array.On a step running an A/B test, abTest and emailTemplateBId are set, but the
step’s subject and message are always variant A’s — read variant B with
Get A/B Test Variant.
A step of type conditional carries its branches in conditions, in execution order with the Else
branch last. Each entry names the sub-sequence its leads walk — look that sequenceId up as a key of
this same response to read the branch’s own steps.
Field
Description
sequenceId
The branch’s sub-sequence id: the key to look up here, and the branch’s address on the branch endpoints
key
The condition the step tests. Every branch shares it; absent on the Else branch
label
The server-stamped description of what is tested, e.g. If lead variable "jobTitle" contains "CEO". On a step with several branches it doubles as the branch’s name when name is unset
name
The name someone gave the branch, when they gave one. The “Branch 1”, “Branch 2”, … and “Else” labels lemlist displays are not stored
fallback
true on the Else branch, which catches every lead no other branch matched and always comes last
delay, delayType
The time window a lead-action condition waits on, in days. Present instead of selector once hydrated
selector
The raw stored selector, as JSON. customLeadInfo and hasEmailAddress keep it, since they carry no time window
A branch whose delay was hydrated has noselector left, so what it actually tests is not in
this response at all — a hasScore branch shows its window but not its score band, an aircallDone
branch not its call statuses.GET /sequences/{sequenceId}/steps/{stepId}/branches
returns the same branches with everything decoded into parameters (customField, customOperator,
customValues, scoreComparator, scoreThreshold, emailStatusFilter, callStatusFilter,
delay, delayType) instead of a raw Mongo fragment. Use it whenever you need to read or edit what
a branch tests.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"lemlist Developer Docs","description":"lemlist API documentation to help you integrate and automate your email outreach.","colors":{"primary":"#316bff","light":"#316bff","dark":"#316bff"},"logo":{"light":"https://mintcdn.com/lemlist/2iZ5pwNAqbuSITlr/logo/light.svg?fit=max\u0026auto=format\u0026n=2iZ5pwNAqbuSITlr\u0026q=85\u0026s=788986080ad8b8885e095b71df22a88c","dark":"https://mintcdn.com/lemlist/2iZ5pwNAqbuSITlr/logo/dark.svg?fit=max\u0026auto=format\u0026n=2iZ5pwNAqbuSITlr\u0026q=85\u0026s=e35c628bd52e1f84bda9094bf3daffab"},"favicon":{"light":"https://mintcdn.com/lemlist/h9afJCVUSdV-WX4K/favicon.ico?fit=max\u0026auto=format\u0026n=h9afJCVUSdV-WX4K\u0026q=85\u0026s=1d6a5fac00a4a5a670d3d8c0bbc7593d","dark":"https://mintcdn.com/lemlist/h9afJCVUSdV-WX4K/favicon.ico?fit=max\u0026auto=format\u0026n=h9afJCVUSdV-WX4K\u0026q=85\u0026s=1d6a5fac00a4a5a670d3d8c0bbc7593d"},"api":{"params":{"expanded":"closed"},"playground":{"display":"interactive","proxy":true},"examples":{"defaults":"required","languages":["curl","python","javascript","ruby","php"],"prefill":true},"mdx":{"auth":{"method":"basic","name":"Basic"}}},"appearance":{"default":"system"},"navbar":{"links":[{"href":"https://lemlist.typeform.com/to/mfVlkyGf","label":"Send your feedback"}],"primary":{"type":"button","label":"Open App","href":"https://app.lemlist.com"}},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/lemlist","youtube":"https://www.youtube.com/c/lemlist"}},"search":{"prompt":"Search..."},"seo":{"metatags":{"robots":"index","charset":"UTF-8","viewport":"width=device-width, initial-scale=1.0","description":"lemlist API helps you to automate your outreach, build powerful workflows, subscribe to alerts, enrich your database and much more. It is easy to integrate, try it out!","keywords":"outbound, outreach, sales, automation","googlebot":"index, follow","google-site-verification":"verification_token","generator":"Mintlify","theme-color":"#000000","color-scheme":"light dark","format-detection":"telephone=no","referrer":"origin","refresh":"30","rating":"general","revisit-after":"7 days","language":"en","og:title":"Lemlist Developer Docs","og:type":"website","og:url":"https://developer.lemlist.com","og:image":"https://developer.lemlist.com/thumbnails/dark.jpeg","og:description":"lemlist API helps you to automate your outreach, build powerful workflows, subscribe to alerts, enrich your database and much more. It is easy to integrate, try it out!","og:site_name":"lemlist Developer Docs","og:locale":"en_US"},"indexing":"all"},"fonts":{"heading":{"family":"Inter","weight":700},"body":{"family":"Inter","weight":500}},"icons":{"library":"fontawesome"},"styling":{"eyebrows":"section","codeblocks":{"theme":"dracula"},"latex":false},"integrations":{"ga4":{"measurementId":"G-XRXQRF7W03"},"gtm":{"tagId":"GTM-PRZ945S"}},"errors":{"404":{"redirect":false,"title":"someone took the wrong turn 🌝","description":""}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"thumbnails":{"appearance":"dark","background":"https://mintcdn.com/lemlist/A9DixBwcDG7hidJ9/thumbnails/dark.jpeg?fit=max\u0026auto=format\u0026n=A9DixBwcDG7hidJ9\u0026q=85\u0026s=28c3824c256d42c704eb5a45b60ad8e5"},"interaction":{"drilldown":true},"navigation":{"global":{"versions":[{"version":"v2","default":false,"hidden":false,"href":"https://developer.lemlist.com/"}],"anchors":[{"anchor":"Start lemlist free trial","icon":"play","href":"https://app.lemlist.com/create-account"},{"anchor":"Talk to a human","icon":"headphones","href":"https://www.lemlist.com/contact-sales?r=0"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"lemlist","hasAudioNarration":false,"actualSubdomain":"lemlist","customDomains":["developer.lemlist.com"],"gitSource":{"type":"github","owner":"l3mpire","repo":"mintlify","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6af6e79de90c1f4f013e9490","clientVersion":"0.0.4124","searchFilterCounts":[{"language":"default","tag":"API Reference","count":280},{"language":"default","tag":"Endpoints","count":232},{"language":"default","tag":"Objects \u0026 Definitions","count":44},{"language":"default","tag":"Campaigns","count":25},{"language":"default","tag":"Leads","count":22},{"language":"default","tag":"Contacts","count":17},{"language":"default","tag":"Sequences","count":17},{"language":"default","tag":"Inbox","count":16},{"language":"default","tag":"People database","count":14},{"language":"default","tag":"Signal Agents","count":13}]},"assistantConfig":{"enableStarterQuestions":true},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"starterQuestions":[{"_id":"6920211ae3c0df65ab8a60e2","deploymentId":"68e934a81f764bc8b225533c","questionText":"How do I automatically add leads to campaign with auto launch?","status":"active","generatedBy":"manual","createdAt":"2025-11-21T08:21:46.035Z","updatedAt":"2025-11-21T08:22:06.570Z","__v":0}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/endpoints/sequences/get-campaign-sequences","slug":"/api-reference/endpoints/sequences/get-campaign-sequences","pageMetadata":{"openapi":"get /campaigns/{campaignId}/sequences","description":"Retrieves all sequences and their steps for a specific campaign.","title":"Get Campaign Sequences","href":"/api-reference/endpoints/sequences/get-campaign-sequences"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Retrieves all sequences and their steps for a specific campaign.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];const SnippetObjectReference=({objectName,objectPath=null})=>{const _components={a:`a`,..._provideComponents()},{Note}=_components;if(!Note)_missingMdxReference(`Note`,true);const lowerCaseObjectName=objectName.toLowerCase();if(lowerCaseObjectName===`lead`||lowerCaseObjectName===`leads`){return _jsxs(Note,{children:[`This endpoint uses the `,_jsxs(_components.a,{href:`/api-reference/objects-definitions/${objectPath}`,children:[objectName,` object`]}),`. Make sure to also check the `,_jsxs(_components.a,{href:`/api-reference/objects-definitions/${lowerCaseObjectName===`lead`?`contact`:`lead`}`,children:[lowerCaseObjectName===`lead`?`Contact`:`Lead`,` object`]}),` to understand the distinction between the two.`]})}return _jsxs(Note,{children:[`This endpoint uses the `,_jsxs(_components.a,{href:`/api-reference/objects-definitions/${objectPath}`,children:[objectName,` object`]}),`.`]})};function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,..._provideComponents(),...props.components},{Heading,Table,Warning,_MdxComponentBoundary}=_components;if(!Heading)_missingMdxReference(`Heading`,true);if(!Table)_missingMdxReference(`Table`,true);if(!Warning)_missingMdxReference(`Warning`,true);if(!_MdxComponentBoundary)_missingMdxReference(`_MdxComponentBoundary`,true);return _jsxs(_Fragment,{children:[_jsx(_MdxComponentBoundary,{name:`SnippetObjectReference`,children:_jsx(SnippetObjectReference,{objectName:`Sequence`,objectPath:`sequence`})}),`\n`,_jsx(_components.p,{children:`For example, if the main sequence includes a condition that contains two sequences, you will receive both the sequence tree and all condition sequences in the main sequences array.`}),`\n`,_jsxs(_components.p,{children:[`On a step running an A/B test, `,_jsx(_components.code,{children:`abTest`}),` and `,_jsx(_components.code,{children:`emailTemplateBId`}),` are set, but the\nstep’s `,_jsx(_components.code,{children:`subject`}),` and `,_jsx(_components.code,{children:`message`}),` are always `,_jsx(_components.strong,{children:`variant A’s`}),` — read variant B with\n`,_jsx(_components.a,{href:`/api-reference/endpoints/sequences/get-ab-test-variant`,children:`Get A/B Test Variant`}),`.`]}),`\n`,_jsx(Heading,{level:`2`,id:`condition-steps`,children:`Condition steps`}),`\n`,_jsxs(_components.p,{children:[`A step of type `,_jsx(_components.code,{children:`conditional`}),` carries its branches in `,_jsx(_components.code,{children:`conditions`}),`, in execution order with the Else\nbranch last. Each entry names the sub-sequence its leads walk — look that `,_jsx(_components.code,{children:`sequenceId`}),` up as a key of\nthis same response to read the branch’s own steps.`]}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Field`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`sequenceId`})}),_jsx(_components.td,{children:`The branch’s sub-sequence id: the key to look up here, and the branch’s address on the branch endpoints`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`key`})}),_jsx(_components.td,{children:`The condition the step tests. Every branch shares it; absent on the Else branch`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`label`})}),_jsxs(_components.td,{children:[`The server-stamped description of what is tested, e.g. `,_jsx(_components.code,{children:`If lead variable \"jobTitle\" contains \"CEO\"`}),`. On a step with several branches it doubles as the branch’s name when `,_jsx(_components.code,{children:`name`}),` is unset`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`name`})}),_jsx(_components.td,{children:`The name someone gave the branch, when they gave one. The “Branch 1”, “Branch 2”, … and “Else” labels lemlist displays are not stored`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`fallback`})}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`true`}),` on the Else branch, which catches every lead no other branch matched and always comes last`]})]}),_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[_jsx(_components.code,{children:`delay`}),`, `,_jsx(_components.code,{children:`delayType`})]}),_jsxs(_components.td,{children:[`The time window a lead-action condition waits on, in days. Present instead of `,_jsx(_components.code,{children:`selector`}),` once hydrated`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`selector`})}),_jsxs(_components.td,{children:[`The raw stored selector, as JSON. `,_jsx(_components.code,{children:`customLeadInfo`}),` and `,_jsx(_components.code,{children:`hasEmailAddress`}),` keep it, since they carry no time window`]})]})]})]}),`\n`,_jsxs(Warning,{children:[_jsxs(_components.p,{children:[`A branch whose `,_jsx(_components.code,{children:`delay`}),` was hydrated has `,_jsx(_components.strong,{children:`no`}),` `,_jsx(_components.code,{children:`selector`}),` left, so what it actually tests is not in\nthis response at all — a `,_jsx(_components.code,{children:`hasScore`}),` branch shows its window but not its score band, an `,_jsx(_components.code,{children:`aircallDone`}),`\nbranch not its call statuses.`]}),_jsxs(_components.p,{children:[_jsx(_components.a,{href:`/api-reference/endpoints/sequences/list-condition-branches`,children:_jsx(_components.code,{children:`GET /sequences/{sequenceId}/steps/{stepId}/branches`})}),`\nreturns the same branches with everything decoded into parameters (`,_jsx(_components.code,{children:`customField`}),`, `,_jsx(_components.code,{children:`customOperator`}),`,\n`,_jsx(_components.code,{children:`customValues`}),`, `,_jsx(_components.code,{children:`scoreComparator`}),`, `,_jsx(_components.code,{children:`scoreThreshold`}),`, `,_jsx(_components.code,{children:`emailStatusFilter`}),`, `,_jsx(_components.code,{children:`callStatusFilter`}),`,\n`,_jsx(_components.code,{children:`delay`}),`, `,_jsx(_components.code,{children:`delayType`}),`) instead of a raw Mongo fragment. Use it whenever you need to read or edit what\na branch tests.`]})]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{SnippetObjectReference,default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"codeStyling":{"theme":"dracula"},"config":{},"pageMetadata":{"openapi":"get /campaigns/{campaignId}/sequences","description":"Retrieves all sequences and their steps for a specific campaign.","title":"Get Campaign Sequences","href":"/api-reference/endpoints/sequences/get-campaign-sequences"}}},"mdxSourceWithNoJs":null,"noJsSplices":[[158,1036,")=>null;function _cr"]]},"mdxExtracts":{"tableOfContents":[{"title":"Condition steps","slug":"condition-steps","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":["/_mintlify/custom/lemlist/a773d8a119273e17/scripts/playground-captions.js","/_mintlify/custom/lemlist/7d1b4a0d04d1528d/scripts/copy-page-url.js"],"openApiReferenceData":{"operation":{"summary":"Get Campaign Sequences","tags":["Sequences"],"parameters":[],"responses":{"200":"a0173424-56de-4d50-88d5-5bc414bae4a5","400":"6c8cf928-0956-4a11-b584-18eabc1adfc5","401":"9ef90a3b-9104-4dd0-bde0-bf4c4386bc27","404":"e12d9bdf-a2a4-4048-b7fd-4ec68db2586a","405":"2d091bb5-8ea2-4c21-a204-c16b4a51fd6d"},"method":"get","type":"path","servers":["5969d41f-50b3-41fa-8f39-603bdbc6ec8a"],"security":["8b93b46b-b040-4616-8914-d3b3b875c68a"],"path":"/campaigns/{campaignId}/sequences","baseUrlOptions":["https://api.lemlist.com/api"],"title":"Get Campaign Sequences","description":"Retrieves all sequences and their steps for a specific campaign.","codeSamples":[],"requestExampleLanguages":["bash","python","javascript","ruby","php"],"requiredOnlyExamples":true,"requestExampleType":"generated","responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[]},"dependencies":{"parameters":{"702bb410-f8c5-4ae4-8780-7ff0272a24c1":{"name":"campaignId","in":"path","required":true,"description":"The unique identifier of the campaign","example":"cam_A1B2C3D4E5F6G7H8I9","schema":{"type":"string","isRequired":true,"description":"The unique identifier of the campaign","uniqueKey":"","typeLabel":"string"}}},"responses":{"a0173424-56de-4d50-88d5-5bc414bae4a5":{"headers":{"Content-Type":{"schema":{"type":"string"},"example":"application/json"}},"description":"Success","content":{"application/json":{"schema":{"type":"object","description":"Object where each key is a sequence ID and each value is a sequence object","additionalProperties":{"type":"object","properties":{"_id":{"type":"string","description":"The unique identifier of the sequence","uniqueKey":"additionalProperties._id","typeLabel":"string"},"steps":{"type":"array","description":"Array of steps in the sequence","items":{"type":"object","properties":{"_id":{"type":"string","description":"The unique identifier of the step","uniqueKey":"additionalProperties.steps.items.[INDEX]._id","typeLabel":"string"},"delay":{"type":"integer","description":"The delay in days before executing this step","uniqueKey":"additionalProperties.steps.items.[INDEX].delay","typeLabel":"integer"},"emailTemplateId":{"type":"string","description":"The unique identifier of the email template used for this step","uniqueKey":"additionalProperties.steps.items.[INDEX].emailTemplateId","typeLabel":"string"},"type":{"type":"string","description":"The type of step (e.g., email, linkedinSend, linkedinInMail, linkedinInvite, conditional)","uniqueKey":"additionalProperties.steps.items.[INDEX].type","typeLabel":"string"},"customName":{"type":"string","description":"The step's own name, shown instead of its type label (\"Email\", \"Call\") wherever the app names the step. Absent when the step has none","uniqueKey":"additionalProperties.steps.items.[INDEX].customName","typeLabel":"string"},"index":{"type":"integer","description":"The position of the step in the sequence","uniqueKey":"additionalProperties.steps.items.[INDEX].index","typeLabel":"integer"},"sequenceId":{"type":"string","description":"The unique identifier of the parent sequence","uniqueKey":"additionalProperties.steps.items.[INDEX].sequenceId","typeLabel":"string"},"sequenceStep":{"type":"integer","description":"The step number in the sequence","uniqueKey":"additionalProperties.steps.items.[INDEX].sequenceStep","typeLabel":"integer"},"message":{"type":"string","description":"The message content for the step (plain text for LinkedIn, HTML for email)","uniqueKey":"additionalProperties.steps.items.[INDEX].message","typeLabel":"string"},"subject":{"type":"string","description":"The email subject line (only for email steps)","uniqueKey":"additionalProperties.steps.items.[INDEX].subject","typeLabel":"string"},"altMessage":{"type":"string","description":"The LinkedIn note sent instead of `message` in specific cases. On a `linkedinInvite` step it is the premium invitation note, used when the sending account has LinkedIn Premium. On a `linkedinSend` or `linkedinVoiceNote` step it is the out-of-network note, sent as a connection request when the lead is not a 1st-degree connection. Returned only when the step carries one and it is not empty","uniqueKey":"additionalProperties.steps.items.[INDEX].altMessage","typeLabel":"string"},"altMessagePremium":{"type":"string","description":"The premium variant of the out-of-network note, sent instead of `altMessage` when the sending LinkedIn account is Premium or Sales Navigator. Only on `linkedinSend` steps, and returned only when it is not empty","uniqueKey":"additionalProperties.steps.items.[INDEX].altMessagePremium","typeLabel":"string"},"abTest":{"oneOf":[{"type":"boolean","description":"A/B test state for this step. `true` while the test runs (leads are split between variant A and B); `\"A\"` or `\"B\"` once a winner is selected; absent or `false` when there is no A/B test. `subject` and `message` are always variant A's — read variant B via Get A/B Test Variant","uniqueKey":"additionalProperties.steps.items.[INDEX].abTest.oneOf.0","typeLabel":"boolean"},{"type":"string","description":"A/B test state for this step. `true` while the test runs (leads are split between variant A and B); `\"A\"` or `\"B\"` once a winner is selected; absent or `false` when there is no A/B test. `subject` and `message` are always variant A's — read variant B via Get A/B Test Variant","enum":["A","B"],"uniqueKey":"additionalProperties.steps.items.[INDEX].abTest.oneOf.1","typeLabel":"enum\u003cstring>"}],"uniqueKey":"additionalProperties.steps.items.[INDEX].abTest","typeLabel":"boolean | enum\u003cstring>"},"title":{"type":"string","description":"Title of the task the step creates. On `manual` and `phone` steps, and on a channel step when one was set","uniqueKey":"additionalProperties.steps.items.[INDEX].title","typeLabel":"string"},"manual":{"type":"boolean","description":"`true` on a channel step held behind a task: the campaign sends the step once the task is marked done. `manual` and `phone` steps are always tasks, whatever this field says","uniqueKey":"additionalProperties.steps.items.[INDEX].manual","typeLabel":"boolean"},"priority":{"type":"integer","enum":[0,1,2],"description":"Priority of the task the step creates: `0` low, `1` medium, `2` high. Absent when none was set","uniqueKey":"additionalProperties.steps.items.[INDEX].priority","typeLabel":"enum\u003cinteger>"},"workflowIds":{"type":"array","items":{"type":"string","enum":["find_email_01","find_phone_01","verify_01","linkedin_01"],"uniqueKey":"additionalProperties.steps.items.[INDEX].workflowIds.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"On `enrichment` steps only. What the step looks up for each lead that reaches it","uniqueKey":"additionalProperties.steps.items.[INDEX].workflowIds","typeLabel":"enum\u003cstring>[]"},"emailTemplateBId":{"type":"string","description":"Email template ID of variant B (present when an A/B test exists on the step)","uniqueKey":"additionalProperties.steps.items.[INDEX].emailTemplateBId","typeLabel":"string"},"conditions":{"type":"array","description":"The branches of a condition step, in execution order with the Else branch last (only on steps of type `conditional`). Each entry owns the sub-sequence its leads walk; look that `sequenceId` up in this same response to read the branch's own steps. Use `GET /sequences/{sequenceId}/steps/{stepId}/branches` to read the same branches as structured parameters instead of raw selectors.","items":{"type":"object","properties":{"sequenceId":{"type":"string","description":"The branch's sub-sequence id - the key to look up in this response, and the branch's address on the branch endpoints","uniqueKey":"additionalProperties.steps.items.[INDEX].conditions.items.[INDEX].sequenceId","typeLabel":"string"},"key":{"type":"string","description":"The condition the step tests. Every branch of a step shares it; absent on the Else branch","uniqueKey":"additionalProperties.steps.items.[INDEX].conditions.items.[INDEX].key","typeLabel":"string"},"label":{"type":"string","description":"The server-stamped description of what is tested (\"If lead variable \\\"jobTitle\\\" contains \\\"CEO\\\"\"). On a step with several branches it doubles as the branch's name when `name` is unset","uniqueKey":"additionalProperties.steps.items.[INDEX].conditions.items.[INDEX].label","typeLabel":"string"},"name":{"type":"string","description":"The branch's display name, present only when someone has set one. The \"Branch 1\", \"Branch 2\", … and \"Else\" defaults lemlist shows are not stored","uniqueKey":"additionalProperties.steps.items.[INDEX].conditions.items.[INDEX].name","typeLabel":"string"},"fallback":{"type":"boolean","description":"`true` on the Else branch, which catches every lead no other branch matched and always comes last","uniqueKey":"additionalProperties.steps.items.[INDEX].conditions.items.[INDEX].fallback","typeLabel":"boolean"},"delay":{"type":"integer","description":"Length of the time window the condition waits on the lead's action, in days. Only on lead-action conditions","uniqueKey":"additionalProperties.steps.items.[INDEX].conditions.items.[INDEX].delay","typeLabel":"integer"},"delayType":{"type":"string","description":"How the condition waits: `within` branches once the window is over, `waitUntil` parks the lead until the action happens","enum":["within","waitUntil"],"uniqueKey":"additionalProperties.steps.items.[INDEX].conditions.items.[INDEX].delayType","typeLabel":"enum\u003cstring>"},"selector":{"type":"string","description":"The raw stored condition selector, as JSON. Present when the condition carries no time window to hydrate - `customLeadInfo` and `hasEmailAddress` always keep it","uniqueKey":"additionalProperties.steps.items.[INDEX].conditions.items.[INDEX].selector","typeLabel":"string"}},"uniqueKey":"additionalProperties.steps.items.[INDEX].conditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"additionalProperties.steps.items.[INDEX].conditions","typeLabel":"object[]"}},"uniqueKey":"additionalProperties.steps.items.[INDEX]","typeLabel":"object"},"uniqueKey":"additionalProperties.steps","typeLabel":"object[]"},"level":{"type":"integer","description":"The nesting level of the sequence (0 for main sequence, 1+ for nested conditional sequences)","uniqueKey":"additionalProperties.level","typeLabel":"integer"},"parentId":{"type":"string","description":"The unique identifier of the parent sequence (only for conditional sequences)","uniqueKey":"additionalProperties.parentId","typeLabel":"string"},"conditionalStepIndex":{"type":"integer","description":"The index of the conditional step that triggers this sequence (only for conditional sequences)","uniqueKey":"additionalProperties.conditionalStepIndex","typeLabel":"integer"}},"uniqueKey":"additionalProperties","typeLabel":"object"},"uniqueKey":"","typeLabel":"object"},"example":{"seq_rH5RD3fMkkt2gM3YC":{"_id":"seq_rH5RD3fMkkt2gM3YC","steps":[{"_id":"stp_sFUj6keaSz9wr049M","delay":0,"emailTemplateId":"etp_ahlbc2yafFyu728H8","type":"linkedinSend","index":1,"sequenceId":"seq_rH5RD3fMkkt2gM3YC","sequenceStep":0,"message":"Hey {{firstName}}, \n\nwe're launching an event, a place where people can regularly meet, network, and learn from each other. We would love it if you could join us for a drink \u0026 chat next week. What do you say? 😊"},{"_id":"stp_qsTl0LO6zkQQJQqsP","delay":1,"emailTemplateId":"etp_HFjUGtyDxIOxgZYcG","index":2,"sequenceId":"seq_rH5RD3fMkkt2gM3YC","sequenceStep":1,"subject":"{{firstName}}, do we count on you for the event?","message":"\u003cp style=\"margin: 0px; box-sizing: border-box;\">Hey {{firstName}},\u003cbr style=\"box-sizing: border-box;\">\u003cbr style=\"box-sizing: border-box;\">\u003c/p>\n\u003cp style=\"margin: 0px; box-sizing: border-box;\">Do you have any plans for Thursday, 7pm?\u003cbr style=\"box-sizing: border-box;\">\u003cbr style=\"box-sizing: border-box;\">\u003c/p>\n\u003cp style=\"margin: 0px; box-sizing: border-box;\">What about spending the evening with cool people by our office?\u003cbr style=\"box-sizing: border-box;\">\u003cbr style=\"box-sizing: border-box;\">\u003c/p>\n\u003cp style=\"margin: 0px; box-sizing: border-box;\">We're launching an event, a place where people can regularly meet, network, and build connections that help them grow further 😊\u003cbr style=\"box-sizing: border-box;\">\u003cbr style=\"box-sizing: border-box;\">\u003c/p>\n\u003cp style=\"margin: 0px; box-sizing: border-box;\">It would be really nice if we could count on you for the event-\u0026nbsp;\u003ca target=\"_blank\" style=\"color: rgb(0, 123, 255); text-decoration: none; background-color: transparent; user-select: auto; box-sizing: border-box;\" rel=\"noopener noreferrer\" href=\"{{event_link_to_send}}\">here's your invite\u003c/a>\u0026nbsp;🔥\u003c/p>\u003cp style=\"margin: 0px; box-sizing: border-box;\">\u003cbr style=\"box-sizing: border-box;\">\u003c/p>\n\u003cp style=\"margin: 0px; box-sizing: border-box;\">Can you make it?\u003cbr style=\"box-sizing: border-box;\">\u003cbr style=\"box-sizing: border-box;\">\u003c/p>\n\u003cp style=\"margin: 0px; box-sizing: border-box;\">Sarah,\u003c/p>\u003cp style=\"margin: 0px; box-sizing: border-box;\">Head of Marketing\u003c/p>","type":"email"},{"_id":"stp_pRcXzJDmOrBkFtNc3","delay":1,"emailTemplateId":"etp_3tjFTgdOMS6JL8U1g","index":3,"sequenceId":"seq_rH5RD3fMkkt2gM3YC","sequenceStep":2,"subject":"{{firstName}}, do we count on you for the event?","message":"\u003cp style=\"margin: 0px; box-sizing: border-box;\">So, should I add you to the list of attendees?\u003cbr style=\"box-sizing: border-box;\">\u003cbr style=\"box-sizing: border-box;\">\u003c/p>\n\u003cp style=\"margin: 0px; box-sizing: border-box;\">We'll meet around 7pm, have a drink and exchange with entrepreneurs, marketers, and salespeople.\u003cbr style=\"box-sizing: border-box;\">\u003cbr style=\"box-sizing: border-box;\">\u003c/p>\n\u003cp style=\"margin: 0px; box-sizing: border-box;\">\u003ca target=\"_blank\" style=\"color: rgb(0, 123, 255); text-decoration: none; background-color: transparent; user-select: auto; box-sizing: border-box;\" rel=\"noopener noreferrer\" href=\"{{event_link_to_send}}\">Here's the link\u003c/a> if you want to join!\u003cbr style=\"box-sizing: border-box;\">\u003cbr style=\"box-sizing: border-box;\">\u003c/p>\n\u003cp style=\"margin: 0px; box-sizing: border-box;\">We would love to have you with us for this event!\u003cbr style=\"box-sizing: border-box;\">\u003cbr style=\"box-sizing: border-box;\">Sarah\u003c/p>\u003cp style=\"margin: 0px; box-sizing: border-box;\">Head of Marketing\u003c/p>","type":"email"},{"_id":"stp_Ae93hiemDkypHLys2","delay":2,"index":4,"sequenceId":"seq_rH5RD3fMkkt2gM3YC","sequenceStep":3,"type":"conditional","conditions":[{"sequenceId":"seq_jacL5GNH3YpNnuNQ2","key":"customLeadInfo","name":"Decision makers","label":"If lead variable \"jobTitle\" contains \"CEO, Founder\"","selector":"{\"$or\":[{\"variables.jobTitle\":{\"$regex\":\"CEO\",\"$options\":\"i\"}},{\"variables.jobTitle\":{\"$regex\":\"Founder\",\"$options\":\"i\"}}]}"},{"sequenceId":"seq_xzrGLxhZwoo5oxukc","key":"customLeadInfo","label":"If lead variable \"jobTitle\" contains \"CTO\"","selector":"{\"variables.jobTitle\":{\"$regex\":\"CTO\",\"$options\":\"i\"}}"},{"sequenceId":"seq_Kd8pQrLm3Nv6Tz0Wy","fallback":true}]}],"level":0},"seq_jacL5GNH3YpNnuNQ2":{"_id":"seq_jacL5GNH3YpNnuNQ2","steps":[{"_id":"stp_Tq5mWx8Rn2Kd7Yz3B","delay":0,"index":1,"sequenceId":"seq_jacL5GNH3YpNnuNQ2","sequenceStep":0,"type":"linkedinInvite","message":"Hi {{firstName}}, would love to connect ahead of the event!"}],"level":1,"parentId":"seq_rH5RD3fMkkt2gM3YC","conditionalStepIndex":4}},"examples":{"Example":{"title":"Example","value":{"seq_rH5RD3fMkkt2gM3YC":{"_id":"seq_rH5RD3fMkkt2gM3YC","steps":[{"_id":"stp_sFUj6keaSz9wr049M","delay":0,"emailTemplateId":"etp_ahlbc2yafFyu728H8","type":"linkedinSend","index":1,"sequenceId":"seq_rH5RD3fMkkt2gM3YC","sequenceStep":0,"message":"Hey {{firstName}}, \n\nwe're launching an event, a place where people can regularly meet, network, and learn from each other. We would love it if you could join us for a drink \u0026 chat next week. What do you say? 😊"},{"_id":"stp_qsTl0LO6zkQQJQqsP","delay":1,"emailTemplateId":"etp_HFjUGtyDxIOxgZYcG","index":2,"sequenceId":"seq_rH5RD3fMkkt2gM3YC","sequenceStep":1,"subject":"{{firstName}}, do we count on you for the event?","message":"\u003cp style=\"margin: 0px; box-sizing: border-box;\">Hey {{firstName}},\u003cbr style=\"box-sizing: border-box;\">\u003cbr style=\"box-sizing: border-box;\">\u003c/p>\n\u003cp style=\"margin: 0px; box-sizing: border-box;\">Do you have any plans for Thursday, 7pm?\u003cbr style=\"box-sizing: border-box;\">\u003cbr style=\"box-sizing: border-box;\">\u003c/p>\n\u003cp style=\"margin: 0px; box-sizing: border-box;\">What about spending the evening with cool people by our office?\u003cbr style=\"box-sizing: border-box;\">\u003cbr style=\"box-sizing: border-box;\">\u003c/p>\n\u003cp style=\"margin: 0px; box-sizing: border-box;\">We're launching an event, a place where people can regularly meet, network, and build connections that help them grow further 😊\u003cbr style=\"box-sizing: border-box;\">\u003cbr style=\"box-sizing: border-box;\">\u003c/p>\n\u003cp style=\"margin: 0px; box-sizing: border-box;\">It would be really nice if we could count on you for the event-\u0026nbsp;\u003ca target=\"_blank\" style=\"color: rgb(0, 123, 255); text-decoration: none; background-color: transparent; user-select: auto; box-sizing: border-box;\" rel=\"noopener noreferrer\" href=\"{{event_link_to_send}}\">here's your invite\u003c/a>\u0026nbsp;🔥\u003c/p>\u003cp style=\"margin: 0px; box-sizing: border-box;\">\u003cbr style=\"box-sizing: border-box;\">\u003c/p>\n\u003cp style=\"margin: 0px; box-sizing: border-box;\">Can you make it?\u003cbr style=\"box-sizing: border-box;\">\u003cbr style=\"box-sizing: border-box;\">\u003c/p>\n\u003cp style=\"margin: 0px; box-sizing: border-box;\">Sarah,\u003c/p>\u003cp style=\"margin: 0px; box-sizing: border-box;\">Head of Marketing\u003c/p>","type":"email"},{"_id":"stp_pRcXzJDmOrBkFtNc3","delay":1,"emailTemplateId":"etp_3tjFTgdOMS6JL8U1g","index":3,"sequenceId":"seq_rH5RD3fMkkt2gM3YC","sequenceStep":2,"subject":"{{firstName}}, do we count on you for the event?","message":"\u003cp style=\"margin: 0px; box-sizing: border-box;\">So, should I add you to the list of attendees?\u003cbr style=\"box-sizing: border-box;\">\u003cbr style=\"box-sizing: border-box;\">\u003c/p>\n\u003cp style=\"margin: 0px; box-sizing: border-box;\">We'll meet around 7pm, have a drink and exchange with entrepreneurs, marketers, and salespeople.\u003cbr style=\"box-sizing: border-box;\">\u003cbr style=\"box-sizing: border-box;\">\u003c/p>\n\u003cp style=\"margin: 0px; box-sizing: border-box;\">\u003ca target=\"_blank\" style=\"color: rgb(0, 123, 255); text-decoration: none; background-color: transparent; user-select: auto; box-sizing: border-box;\" rel=\"noopener noreferrer\" href=\"{{event_link_to_send}}\">Here's the link\u003c/a> if you want to join!\u003cbr style=\"box-sizing: border-box;\">\u003cbr style=\"box-sizing: border-box;\">\u003c/p>\n\u003cp style=\"margin: 0px; box-sizing: border-box;\">We would love to have you with us for this event!\u003cbr style=\"box-sizing: border-box;\">\u003cbr style=\"box-sizing: border-box;\">Sarah\u003c/p>\u003cp style=\"margin: 0px; box-sizing: border-box;\">Head of Marketing\u003c/p>","type":"email"},{"_id":"stp_Ae93hiemDkypHLys2","delay":2,"index":4,"sequenceId":"seq_rH5RD3fMkkt2gM3YC","sequenceStep":3,"type":"conditional","conditions":[{"sequenceId":"seq_jacL5GNH3YpNnuNQ2","key":"customLeadInfo","name":"Decision makers","label":"If lead variable \"jobTitle\" contains \"CEO, Founder\"","selector":"{\"$or\":[{\"variables.jobTitle\":{\"$regex\":\"CEO\",\"$options\":\"i\"}},{\"variables.jobTitle\":{\"$regex\":\"Founder\",\"$options\":\"i\"}}]}"},{"sequenceId":"seq_xzrGLxhZwoo5oxukc","key":"customLeadInfo","label":"If lead variable \"jobTitle\" contains \"CTO\"","selector":"{\"variables.jobTitle\":{\"$regex\":\"CTO\",\"$options\":\"i\"}}"},{"sequenceId":"seq_Kd8pQrLm3Nv6Tz0Wy","fallback":true}]}],"level":0},"seq_jacL5GNH3YpNnuNQ2":{"_id":"seq_jacL5GNH3YpNnuNQ2","steps":[{"_id":"stp_Tq5mWx8Rn2Kd7Yz3B","delay":0,"index":1,"sequenceId":"seq_jacL5GNH3YpNnuNQ2","sequenceStep":0,"type":"linkedinInvite","message":"Hi {{firstName}}, would love to connect ahead of the event!"}],"level":1,"parentId":"seq_rH5RD3fMkkt2gM3YC","conditionalStepIndex":4}}}},"exampleType":"examples"}},"exampleType":"examples"},"6c8cf928-0956-4a11-b584-18eabc1adfc5":{"description":"Possible errors: Bad team / Campaign has no sequence","content":{"text/plain":{"example":"Bad team","examples":{"Example":{"title":"Example","value":"Bad team"}},"exampleType":"examples"}},"exampleType":"examples"},"9ef90a3b-9104-4dd0-bde0-bf4c4386bc27":{"description":"The authentication you supplied is incorrect","content":{"text/plain":{"example":"The authentication you supplied is incorrect","examples":{"Example":{"title":"Example","value":"The authentication you supplied is incorrect"}},"exampleType":"examples"}},"exampleType":"examples"},"e12d9bdf-a2a4-4048-b7fd-4ec68db2586a":{"description":"Campaign not found","content":{"text/plain":{"example":"Campaign not found","examples":{"Example":{"title":"Example","value":"Campaign not found"}},"exampleType":"examples"}},"exampleType":"examples"},"2d091bb5-8ea2-4c21-a204-c16b4a51fd6d":{"description":"Method not allowed","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{"8b93b46b-b040-4616-8914-d3b3b875c68a":{"basicAuth":{"type":"http","scheme":"basic","scopes":[],"schemeName":"basicAuth"}}},"servers":{"5969d41f-50b3-41fa-8f39-603bdbc6ec8a":{"url":"https://api.lemlist.com/api"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"basic","scopes":[],"schemeName":"basicAuth"},"schema":{"title":"Basic Auth","type":"object","description":"Basic authentication header of the form `Basic \u003cencoded-value>`, where `\u003cencoded-value>` is the base64-encoded string `username:password`.","isRequired":true,"properties":{"username":{"type":"string","uniqueKey":"username","isRequired":true,"typeLabel":"string","deprecated":false},"password":{"type":"string","uniqueKey":"password","isRequired":true,"typeLabel":"string","deprecated":false}},"additionalProperties":false,"deprecated":false},"schemeName":"basicAuth","name":"Authorization"}],"title":"basicAuth"}]},"originalFileLocation":"api-reference/openapi/v2.json"},"subdomain":"lemlist","siteName":"lemlist Developer Docs","title":"Lemlist Developer Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-12T08:24:14.632Z","originalFileLocation":"api-reference/endpoints/sequences/get-campaign-sequences.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Retrieves all sequences and their steps for a specific campaign.\">\u003cmeta data-mint-head name=\"keywords\" content=\"outbound, outreach, sales, automation\">\u003cmeta data-mint-head name=\"application-name\" content=\"lemlist Developer Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003cmeta data-mint-head name=\"robots\" content=\"index\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/lemlist/me0cPoV7UJ7b682L/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/lemlist/me0cPoV7UJ7b682L/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/lemlist/me0cPoV7UJ7b682L/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/lemlist/me0cPoV7UJ7b682L/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/lemlist/me0cPoV7UJ7b682L/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/lemlist/me0cPoV7UJ7b682L/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/lemlist/me0cPoV7UJ7b682L/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/lemlist/me0cPoV7UJ7b682L/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/lemlist/me0cPoV7UJ7b682L/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Lemlist Developer Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"lemlist API helps you to automate your outreach, build powerful workflows, subscribe to alerts, enrich your database and much more. It is easy to integrate, try it out!\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"lemlist Developer Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developer.lemlist.com/api-reference/endpoints/sequences/get-campaign-sequences\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://developer.lemlist.com/thumbnails/dark.jpeg\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Lemlist Developer Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"lemlist API helps you to automate your outreach, build powerful workflows, subscribe to alerts, enrich your database and much more. It is easy to integrate, try it out!\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://developer.lemlist.com/thumbnails/dark.jpeg\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/lemlist/me0cPoV7UJ7b682L/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"lemlist Developer Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#316bff\">\u003cmeta data-mint-head name=\"og:locale\" content=\"en_US\">\u003cmeta data-mint-head name=\"charset\" content=\"UTF-8\">\u003cmeta data-mint-head name=\"viewport\" content=\"width=device-width, initial-scale=1.0\">\u003cmeta data-mint-head name=\"googlebot\" content=\"index, follow\">\u003cmeta data-mint-head name=\"google-site-verification\" content=\"verification_token\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003cmeta data-mint-head name=\"theme-color\" content=\"#000000\">\u003cmeta data-mint-head name=\"color-scheme\" content=\"light dark\">\u003cmeta data-mint-head name=\"format-detection\" content=\"telephone=no\">\u003cmeta data-mint-head name=\"referrer\" content=\"origin\">\u003cmeta data-mint-head name=\"refresh\" content=\"30\">\u003cmeta data-mint-head name=\"rating\" content=\"general\">\u003cmeta data-mint-head name=\"revisit-after\" content=\"7 days\">\u003cmeta data-mint-head name=\"language\" content=\"en\">\u003clink data-mint-head rel=\"canonical\" href=\"https://developer.lemlist.com/api-reference/endpoints/sequences/get-campaign-sequences\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/endpoints/sequences/get-campaign-sequences.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://developer.lemlist.com/#organization\",\"name\":\"lemlist Developer Docs\",\"url\":\"https://developer.lemlist.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/lemlist/2iZ5pwNAqbuSITlr/logo/light.svg?fit=max\u0026auto=format\u0026n=2iZ5pwNAqbuSITlr\u0026q=85\u0026s=788986080ad8b8885e095b71df22a88c\"}},{\"@type\":\"WebSite\",\"@id\":\"https://developer.lemlist.com#website\",\"name\":\"lemlist Developer Docs\",\"url\":\"https://developer.lemlist.com\",\"publisher\":{\"@id\":\"https://developer.lemlist.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://developer.lemlist.com/api-reference/endpoints/sequences/get-campaign-sequences#webpage\",\"url\":\"https://developer.lemlist.com/api-reference/endpoints/sequences/get-campaign-sequences\",\"name\":\"Get Campaign Sequences\",\"description\":\"Retrieves all sequences and their steps for a specific campaign.\",\"dateModified\":\"2026-11-12T08:24:14.632Z\",\"isPartOf\":{\"@id\":\"https://developer.lemlist.com#website\"},\"breadcrumb\":{\"@id\":\"https://developer.lemlist.com/api-reference/endpoints/sequences/get-campaign-sequences#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developer.lemlist.com/api-reference/endpoints/sequences/get-campaign-sequences#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Endpoints\",\"item\":\"https://developer.lemlist.com/api-reference/endpoints/team/get-team\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get Campaign Sequences\",\"item\":\"https://developer.lemlist.com/api-reference/endpoints/sequences/get-campaign-sequences\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developer.lemlist.com/api-reference/endpoints/sequences/get-campaign-sequences#apireference\",\"headline\":\"Get Campaign Sequences\",\"name\":\"Get Campaign Sequences\",\"description\":\"Retrieves all sequences and their steps for a specific campaign.\",\"url\":\"https://developer.lemlist.com/api-reference/endpoints/sequences/get-campaign-sequences\",\"mainEntityOfPage\":{\"@id\":\"https://developer.lemlist.com/api-reference/endpoints/sequences/get-campaign-sequences#webpage\"},\"image\":\"https://developer.lemlist.com/thumbnails/dark.jpeg\",\"dateModified\":\"2026-11-12T08:24:14.632Z\",\"publisher\":{\"@id\":\"https://developer.lemlist.com/#organization\"},\"isPartOf\":{\"@id\":\"https://developer.lemlist.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"lemlist Developer Docs\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"lemlist Developer Docs\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/endpoints/sequences/get-campaign-sequences.md","siteName":"lemlist Developer Docs","nav":{"global":{"versions":[{"version":"v2","default":false,"hidden":false,"href":"https://developer.lemlist.com/"}],"anchors":[{"anchor":"Start lemlist free trial","icon":"play","href":"https://app.lemlist.com/create-account"},{"anchor":"Talk to a human","icon":"headphones","href":"https://www.lemlist.com/contact-sales?r=0"}]},"tabs":[{"tab":"API Reference","groups":[{"group":"Getting started","pages":[{"title":"Overview","href":"/api-reference/getting-started/overview"},{"title":"Authentication","href":"/api-reference/getting-started/authentication"},{"title":"Managing multiple accounts","href":"/api-reference/getting-started/multiple-accounts"},{"title":"Rate Limits","href":"/api-reference/getting-started/rate-limits"}]},{"group":"Popular Resources","pages":[{"title":"Create Lead in Campaign","openapi":"post /campaigns/{campaignId}/leads/","href":"/api-reference/endpoints/leads/create-lead-in-campaign"},{"title":"Enrich Data","openapi":"post /enrich","href":"/api-reference/endpoints/enrich/enrich-data"},{"openapi":"post /database/people","title":"Search People database","href":"/api-reference/endpoints/people-database/search-people-database"},{"openapi":"post /hooks","title":"Add Webhook","href":"/api-reference/endpoints/webhooks/add-webhook"},{"openapi":"get /leads/{email}","title":"Get Lead by Email","href":"/api-reference/endpoints/leads/get-lead-by-email"}]},{"group":"Endpoints","pages":[{"group":"Team","expanded":false,"pages":[{"openapi":"get /team","title":"Get Team","href":"/api-reference/endpoints/team/get-team"},{"openapi":"get /team/senders","title":"Get Team Senders","href":"/api-reference/endpoints/team/get-team-senders"},{"openapi":"get /team/credits","title":"Get Team Credits","href":"/api-reference/endpoints/team/get-team-credits"}]},{"group":"Users","expanded":false,"pages":[{"openapi":"get /users/{userId}","title":"Get User","href":"/api-reference/endpoints/users/get-user"},{"openapi":"get /user/channels","title":"Get User Channels","href":"/api-reference/endpoints/users/get-user-channels"},{"openapi":"patch /users/{userId}/linkedin-limits","title":"Update User LinkedIn Limits","href":"/api-reference/endpoints/users/update-user-linkedin-limits"},{"openapi":"get /users/{userId}/signature","title":"Get User Signature","href":"/api-reference/endpoints/users/get-user-signature"},{"openapi":"patch /users/{userId}/signature","title":"Update User Signature","href":"/api-reference/endpoints/users/update-user-signature"}]},{"group":"Email Accounts","expanded":false,"pages":[{"openapi":"post /user/email-accounts","title":"Connect Email Account","href":"/api-reference/endpoints/email-accounts/connect-email-account"},{"openapi":"delete /user/email-accounts/{emailAccountId}","title":"Disconnect Email Account","href":"/api-reference/endpoints/email-accounts/disconnect-email-account"},{"openapi":"post /user/email-accounts/{emailAccountId}/test","title":"Test Email Account","href":"/api-reference/endpoints/email-accounts/test-email-account"}]},{"group":"Campaigns","expanded":false,"pages":[{"openapi":"post /campaigns","title":"Create Campaign","href":"/api-reference/endpoints/campaigns/create-campaign"},{"openapi":"get /campaigns/{campaignId}","title":"Get Campaign","href":"/api-reference/endpoints/campaigns/get-campaign"},{"openapi":"get /campaigns","title":"Get Many Campaigns","href":"/api-reference/endpoints/campaigns/get-many-campaigns"},{"openapi":"patch /campaigns/{campaignId}","title":"Update Campaign","href":"/api-reference/endpoints/campaigns/update-campaign"},{"openapi":"get /campaigns/{campaignId}/settings","title":"Get Campaign Settings","href":"/api-reference/endpoints/campaigns/get-campaign-settings"},{"openapi":"patch /campaigns/{campaignId}/settings","title":"Update Campaign Settings","href":"/api-reference/endpoints/campaigns/update-campaign-settings"},{"openapi":"get /campaigns/{campaignId}/statutes","title":"Get Campaign Statutes","href":"/api-reference/endpoints/campaigns/get-campaign-statutes"},{"openapi":"post /campaigns/{campaignId}/start","title":"Start Campaign","href":"/api-reference/endpoints/campaigns/start-campaign"},{"openapi":"post /campaigns/{campaignId}/pause","title":"Pause Campaign","href":"/api-reference/endpoints/campaigns/pause-campaign"},{"openapi":"post /campaigns/{campaignId}/archive","title":"Archive Campaign","href":"/api-reference/endpoints/campaigns/archive-campaign"},{"openapi":"post /campaigns/{campaignId}/unarchive","title":"Unarchive Campaign","href":"/api-reference/endpoints/campaigns/unarchive-campaign"},{"openapi":"post /campaigns/{campaignId}/steps/{stepId}/skip","title":"Skip Step for Everyone","href":"/api-reference/endpoints/campaigns/skip-step-for-everyone"},{"openapi":"post /campaigns/{campaignId}/steps/{stepId}/skip-for-leads","title":"Skip Step for Leads","href":"/api-reference/endpoints/campaigns/skip-step-for-leads"},{"openapi":"post /campaigns/{campaignId}/abm-leads","title":"Add ABM Campaign Leads","href":"/api-reference/endpoints/campaigns/add-abm-campaign-leads"},{"openapi":"post /campaigns/{campaignId}/triggers/watch-lists","title":"Add Signal Agent Trigger","href":"/api-reference/endpoints/campaigns/add-watch-list-trigger"},{"openapi":"delete /campaigns/{campaignId}/triggers/watch-lists/{watchListId}","title":"Remove Signal Agent Trigger","href":"/api-reference/endpoints/campaigns/remove-watch-list-trigger"},{"openapi":"post /campaigns/{campaignId}/duplicate","title":"Duplicate Campaign","href":"/api-reference/endpoints/campaigns/duplicate-campaign"},{"openapi":"get /v2/campaigns/{campaignId}/stats","title":"Get Campaign Stats","href":"/api-reference/endpoints/campaigns/get-campaign-stats"},{"openapi":"post /v2/campaigns/stats/batch","title":"Get Batch Campaign Stats","href":"/api-reference/endpoints/campaigns/get-batch-campaign-stats"},{"openapi":"get /campaigns/{campaignId}/export/start","title":"Start Campaign Stats Export","href":"/api-reference/endpoints/campaigns/start-campaign-export"},{"openapi":"get /campaigns/{campaignId}/export/{exportId}/status","title":"Get Campaign Export Status","href":"/api-reference/endpoints/campaigns/get-campaign-export-status"},{"openapi":"put /campaigns/{campaignId}/export/{exportId}/email/{email}","title":"Set Email for Campaign Export Notification","href":"/api-reference/endpoints/campaigns/set-export-email-notification"},{"openapi":"get /v2/campaigns/{campaignId}/export/leads","title":"Export Campaign Leads","href":"/api-reference/endpoints/campaigns/export-campaign-leads-v2"},{"openapi":"get /campaigns/{campaignId}/export/leads","title":"Export Campaign Leads (legacy)","href":"/api-reference/endpoints/campaigns/export-campaign-leads"},{"openapi":"get /campaigns/reports","title":"Get Campaign Reports","href":"/api-reference/endpoints/campaigns/get-campaign-reports"}]},{"group":"Senders","expanded":false,"pages":[{"openapi":"get /senders","title":"List Senders","href":"/api-reference/endpoints/senders/list-senders"},{"openapi":"get /campaigns/{campaignId}/senders","title":"Get Campaign Senders","href":"/api-reference/endpoints/senders/get-campaign-senders"},{"openapi":"post /campaigns/{campaignId}/senders","title":"Add Campaign Senders","href":"/api-reference/endpoints/senders/add-campaign-senders"},{"openapi":"put /campaigns/{campaignId}/senders","title":"Replace Campaign Senders","href":"/api-reference/endpoints/senders/replace-campaign-senders"},{"openapi":"patch /campaigns/{campaignId}/senders/{userId}","title":"Update Campaign Sender Channels","href":"/api-reference/endpoints/senders/update-campaign-sender-channels"},{"openapi":"delete /campaigns/{campaignId}/senders/{userId}","title":"Remove Campaign Sender","href":"/api-reference/endpoints/senders/remove-campaign-sender"},{"openapi":"get /team/dynamic-sender-exclusions","title":"Get Team Sender Exclusions","href":"/api-reference/endpoints/senders/get-team-sender-exclusions"},{"openapi":"put /team/dynamic-sender-exclusions","title":"Replace Team Sender Exclusions","href":"/api-reference/endpoints/senders/replace-team-sender-exclusions"},{"openapi":"get /campaigns/{campaignId}/dynamic-sender-exclusions","title":"Get Campaign Sender Exclusions","href":"/api-reference/endpoints/senders/get-campaign-sender-exclusions"},{"openapi":"put /campaigns/{campaignId}/dynamic-sender-exclusions","description":"Replaces the senders that the leads of a campaign cannot select.","title":"Replace Campaign Sender Exclusions","href":"/api-reference/endpoints/senders/replace-campaign-sender-exclusions"}]},{"group":"Sequences","expanded":false,"pages":[{"openapi":"get /campaigns/{campaignId}/sequences","title":"Get Campaign Sequences","href":"/api-reference/endpoints/sequences/get-campaign-sequences"},{"openapi":"post /sequences/{sequenceId}/steps","description":"Creates a step or condition within a campaign sequence.","title":"Add Step to Sequence","href":"/api-reference/endpoints/sequences/add-step-to-sequence"},{"openapi":"patch /sequences/{sequenceId}/steps/{stepId}","title":"Update Sequence Step","href":"/api-reference/endpoints/sequences/update-sequence-step"},{"openapi":"delete /sequences/{sequenceId}/steps/{stepId}","title":"Delete Sequence Step","href":"/api-reference/endpoints/sequences/delete-sequence-step"},{"openapi":"get /sequences/{sequenceId}/steps/{stepId}/sender","title":"Get Step Sender","href":"/api-reference/endpoints/sequences/get-step-sender"},{"openapi":"put /sequences/{sequenceId}/steps/{stepId}/sender","title":"Set Step Sender","href":"/api-reference/endpoints/sequences/set-step-sender"},{"openapi":"delete /sequences/{sequenceId}/steps/{stepId}/sender","title":"Remove Step Sender","href":"/api-reference/endpoints/sequences/remove-step-sender"},{"openapi":"get /sequences/{sequenceId}/steps/{stepId}/branches","title":"List Condition Branches","href":"/api-reference/endpoints/sequences/list-condition-branches"},{"openapi":"post /sequences/{sequenceId}/steps/{stepId}/branches","title":"Add Condition Branch","href":"/api-reference/endpoints/sequences/add-condition-branch"},{"openapi":"patch /sequences/{sequenceId}/steps/{stepId}/branches","title":"Reorder Condition Branches","href":"/api-reference/endpoints/sequences/reorder-condition-branches"},{"openapi":"patch /sequences/{sequenceId}/steps/{stepId}/branches/{branchSequenceId}","title":"Update Condition Branch","href":"/api-reference/endpoints/sequences/update-condition-branch"},{"openapi":"delete /sequences/{sequenceId}/steps/{stepId}/branches/{branchSequenceId}","title":"Delete Condition Branch","href":"/api-reference/endpoints/sequences/delete-condition-branch"},{"openapi":"post /sequences/{sequenceId}/steps/{stepId}/ab-test","title":"Create A/B Test Variant","href":"/api-reference/endpoints/sequences/create-ab-test-variant"},{"openapi":"get /sequences/{sequenceId}/steps/{stepId}/ab-test","title":"Get A/B Test Variant","href":"/api-reference/endpoints/sequences/get-ab-test-variant"},{"openapi":"patch /sequences/{sequenceId}/steps/{stepId}/ab-test","title":"Update A/B Test Variant","href":"/api-reference/endpoints/sequences/update-ab-test-variant"},{"openapi":"delete /sequences/{sequenceId}/steps/{stepId}/ab-test","title":"Delete A/B Test Variant","href":"/api-reference/endpoints/sequences/delete-ab-test-variant"},{"openapi":"post /sequences/{sequenceId}/steps/{stepId}/ab-test/winner","title":"Select A/B Test Winner","href":"/api-reference/endpoints/sequences/select-ab-test-winner"}]},{"group":"Message templates","expanded":false,"pages":[{"openapi":"get /message-templates","title":"List Message Templates","href":"/api-reference/endpoints/message-templates/list-message-templates"},{"openapi":"get /message-templates/tags","title":"List Message Template Tags","href":"/api-reference/endpoints/message-templates/list-message-template-tags"},{"openapi":"get /message-templates/{templateId}","title":"Get Message Template","href":"/api-reference/endpoints/message-templates/get-message-template"}]},{"group":"Snippets","expanded":false,"pages":[{"openapi":"get /snippets","title":"List Snippets","href":"/api-reference/endpoints/snippets/list-snippets"},{"openapi":"get /snippets/{snippetId}","title":"Get Snippet","href":"/api-reference/endpoints/snippets/get-snippet"}]},{"group":"Schedules","expanded":false,"pages":[{"openapi":"post /schedules","title":"Create Schedule","href":"/api-reference/endpoints/schedules/create-schedule"},{"openapi":"get /schedules/{scheduleId}","title":"Get Schedule","href":"/api-reference/endpoints/schedules/get-schedule"},{"openapi":"get /schedules","title":"Get Many Schedules","href":"/api-reference/endpoints/schedules/get-many-schedules"},{"openapi":"patch /schedules/{scheduleId}","title":"Update Schedule","href":"/api-reference/endpoints/schedules/update-schedule"},{"openapi":"delete /schedules/{scheduleId}","title":"Delete Schedule","href":"/api-reference/endpoints/schedules/delete-schedule"},{"openapi":"get /campaigns/{campaignId}/schedules/","title":"Get Campaign Schedules","href":"/api-reference/endpoints/schedules/get-campaign-schedules"},{"openapi":"post /campaigns/{campaignId}/schedules/{scheduleId}","title":"Associate Schedule with Campaign","href":"/api-reference/endpoints/schedules/associate-schedule-with-campaign"}]},{"group":"Leads","expanded":false,"pages":[{"title":"Create Lead in Campaign","openapi":"post /campaigns/{campaignId}/leads/","href":"/api-reference/endpoints/leads/create-lead-in-campaign"},{"openapi":"get /campaigns/{campaignId}/leads/","title":"Get Campaign Leads","href":"/api-reference/endpoints/leads/get-campaign-leads"},{"openapi":"get /leads","title":"Get Lead by Email or ID","href":"/api-reference/endpoints/leads/get-lead-by-email-or-id"},{"openapi":"get /leads/{email}","title":"Get Lead by Email","href":"/api-reference/endpoints/leads/get-lead-by-email"},{"openapi":"patch /campaigns/{campaignId}/leads/{leadId}","title":"Update Lead in a Campaign","href":"/api-reference/endpoints/leads/update-lead"},{"openapi":"delete /campaigns/{campaignId}/leads/{leadId}","title":"Delete or Unsubscribe Lead","href":"/api-reference/endpoints/leads/delete-lead"},{"openapi":"post /leads/{leadId}/variables","title":"Add Custom Variables on Leads","href":"/api-reference/endpoints/leads/add-lead-variables"},{"openapi":"patch /leads/{leadId}/variables","title":"Update Values of Custom Variables of a Lead","href":"/api-reference/endpoints/leads/update-lead-variables"},{"openapi":"delete /leads/{leadId}/variables","title":"Erase Values of Custom Variables on a Lead","href":"/api-reference/endpoints/leads/delete-lead-variables"},{"openapi":"delete /campaigns/{campaignId}/leads/{email}","title":"Unsubscribe Lead from Campaign","href":"/api-reference/endpoints/leads/unsubscribe-lead-from-campaign"},{"openapi":"post /leads/pause/{leadId}","title":"Pause Lead","href":"/api-reference/endpoints/leads/pause-lead"},{"openapi":"post /leads/start/{leadId}","title":"Resume Paused Lead","href":"/api-reference/endpoints/leads/resume-paused-lead"},{"openapi":"post /leads/review/{leadId}","title":"Launch Lead","href":"/api-reference/endpoints/leads/launch-lead"},{"openapi":"post /leads/interested/{leadIdOrEmail}","title":"Mark Lead as Interested","href":"/api-reference/endpoints/leads/mark-lead-as-interested"},{"openapi":"post /leads/notinterested/{leadIdOrEmail}","title":"Mark Lead as Not Interested","href":"/api-reference/endpoints/leads/mark-lead-as-not-interested"},{"openapi":"post /campaigns/{campaignId}/leads/{leadIdOrEmail}/interested","title":"Mark Lead as Interested in Campaign","href":"/api-reference/endpoints/leads/mark-lead-as-interested-in-campaign"},{"openapi":"post /campaigns/{campaignId}/leads/{leadIdOrEmail}/notinterested","title":"Mark Lead as Not Interested in Campaign","href":"/api-reference/endpoints/leads/mark-lead-as-not-interested-in-campaign"},{"openapi":"post /campaigns/{campaignId}/leads/{leadIdOrEmail}/steps/{stepId}/skip","title":"Skip Step for Lead","href":"/api-reference/endpoints/leads/skip-step-for-lead"},{"openapi":"put /campaigns/{campaignId}/leads/{leadIdOrEmail}/steps/{stepId}/personalization","title":"Personalize Step for Lead","href":"/api-reference/endpoints/leads/personalize-step-for-lead"},{"openapi":"delete /campaigns/{campaignId}/leads/{leadIdOrEmail}/steps/{stepId}/personalization","title":"Reset Step Personalization for Lead","href":"/api-reference/endpoints/leads/reset-step-personalization-for-lead"},{"openapi":"post /campaigns/{campaignId}/leads/import","title":"Import Leads from CRM","href":"/api-reference/endpoints/leads/import-leads-from-crm"},{"openapi":"post /leads/audio","title":"Upload Audio for Voice Message Step","href":"/api-reference/endpoints/leads/upload-audio-for-voice-message-step"}]},{"group":"Companies","expanded":false,"pages":[{"openapi":"post /companies","title":"Add and update company","href":"/api-reference/endpoints/companies/upsert-company"},{"openapi":"get /companies/{companyId}","title":"Get Company","href":"/api-reference/endpoints/companies/get-company"},{"openapi":"get /companies","title":"Get Many Companies","href":"/api-reference/endpoints/companies/get-many-companies"},{"openapi":"delete /companies/{companyId}","title":"Delete Company","href":"/api-reference/endpoints/companies/delete-company"},{"openapi":"post /companies/merge","title":"Merge Companies","href":"/api-reference/endpoints/companies/merge-companies"},{"openapi":"post /companies/crm/search-and-connect","title":"Search \u0026 Connect Companies in the CRM","href":"/api-reference/endpoints/companies/search-and-connect-companies"},{"openapi":"post /companies/crm/create","title":"Create Companies in the CRM","href":"/api-reference/endpoints/companies/create-companies-in-crm"},{"openapi":"get /companies/lists","title":"Get Company Lists","href":"/api-reference/endpoints/companies/get-company-lists"},{"openapi":"post /companies/lists","title":"Create Company List","href":"/api-reference/endpoints/companies/create-company-list"},{"openapi":"post /companies/lists/{listId}/entities","title":"Add or Remove Companies in a List","href":"/api-reference/endpoints/companies/manage-company-list-entities"},{"openapi":"post /companies/{companyId}/notes","title":"Create Company Note","href":"/api-reference/endpoints/companies/create-company-note"},{"openapi":"get /companies/{companyId}/notes","title":"Get Company Notes","href":"/api-reference/endpoints/companies/get-company-notes"}]},{"group":"Contacts","expanded":false,"pages":[{"openapi":"post /contacts","title":"Add and update contact","href":"/api-reference/endpoints/contacts/upsert-contact"},{"openapi":"get /contacts/{idOrEmail}","title":"Get Contact","href":"/api-reference/endpoints/contacts/get-contact"},{"openapi":"get /contacts","title":"Get Many Contacts","href":"/api-reference/endpoints/contacts/get-many-contacts"},{"openapi":"delete /contacts/{idOrEmail}","title":"Delete Contact","href":"/api-reference/endpoints/contacts/delete-contact"},{"openapi":"post /contacts/merge","title":"Merge Contacts","href":"/api-reference/endpoints/contacts/merge-contacts"},{"openapi":"post /contacts/crm/search-and-connect","title":"Search \u0026 Connect Contacts in the CRM","href":"/api-reference/endpoints/contacts/search-and-connect-contacts"},{"openapi":"post /contacts/crm/create","title":"Create Contacts in the CRM","href":"/api-reference/endpoints/contacts/create-contacts-in-crm"},{"openapi":"get /contacts/lists","title":"Get Contact Lists","href":"/api-reference/endpoints/contacts/get-contact-lists"},{"openapi":"post /contacts/lists","title":"Create Contact List","href":"/api-reference/endpoints/contacts/create-contact-list"},{"openapi":"post /contacts/lists/{listId}/entities","title":"Add or Remove Contacts in a List","href":"/api-reference/endpoints/contacts/manage-contact-list-entities"},{"openapi":"get /contacts/export","title":"Export Contact List","href":"/api-reference/endpoints/contacts/export-contact-list"},{"openapi":"post /contacts/{idOrEmail}/notes","title":"Create Contact Note","href":"/api-reference/endpoints/contacts/create-contact-note"},{"openapi":"get /contacts/{idOrEmail}/notes","title":"Get Contact Notes","href":"/api-reference/endpoints/contacts/get-contact-notes"}]},{"group":"Inbox","expanded":false,"pages":[{"openapi":"get /inbox","title":"Get Many Inboxes","href":"/api-reference/endpoints/inbox/get-many-inboxes"},{"openapi":"get /inbox/{contactId}","title":"Get Contact Messages","href":"/api-reference/endpoints/inbox/get-contact-messages"},{"openapi":"post /inbox/email","title":"Send Email","href":"/api-reference/endpoints/inbox/send-email"},{"openapi":"post /inbox/linkedin","title":"Send LinkedIn Message","href":"/api-reference/endpoints/inbox/send-linkedin-message"},{"openapi":"post /inbox/whatsapp","title":"Send WhatsApp Message","href":"/api-reference/endpoints/inbox/send-whatsapp-message"},{"openapi":"post /inbox/sms","title":"Send SMS Message","href":"/api-reference/endpoints/inbox/send-sms-message"},{"openapi":"get /inbox/labels","title":"Get Many Labels","href":"/api-reference/endpoints/inbox/get-many-labels"},{"openapi":"get /inbox/labels/{labelId}","title":"Get Label","href":"/api-reference/endpoints/inbox/get-label"},{"openapi":"post /inbox/labels","title":"Create Label","href":"/api-reference/endpoints/inbox/create-label"},{"openapi":"post /inbox/conversations/labels/{contactId}","title":"Attach Labels to Conversations","href":"/api-reference/endpoints/inbox/attach-labels-to-conversations"},{"openapi":"delete /inbox/conversations/labels/{contactId}","title":"Remove Labels from Conversation","href":"/api-reference/endpoints/inbox/remove-labels-from-conversation"},{"openapi":"get /inbox/{contactId}/drafts","title":"List Drafts","href":"/api-reference/endpoints/inbox/list-drafts"},{"openapi":"get /inbox/{contactId}/drafts/{draftId}","title":"Get Draft","href":"/api-reference/endpoints/inbox/get-draft"},{"openapi":"post /inbox/{contactId}/drafts","title":"Create Draft","href":"/api-reference/endpoints/inbox/create-draft"},{"openapi":"patch /inbox/{contactId}/drafts/{draftId}","title":"Update Draft","href":"/api-reference/endpoints/inbox/update-draft"},{"openapi":"delete /inbox/{contactId}/drafts/{draftId}","title":"Delete Draft","href":"/api-reference/endpoints/inbox/delete-draft"}]},{"group":"Tasks","expanded":false,"pages":[{"title":"Create Task","openapi":"post /tasks","href":"/api-reference/endpoints/tasks/create-task"},{"openapi":"get /v2/tasks","title":"Search Tasks","href":"/api-reference/endpoints/tasks/get-many-tasks-v2"},{"openapi":"get /v2/tasks/filters","title":"List Task Filters","href":"/api-reference/endpoints/tasks/get-task-filters"},{"openapi":"get /tasks","title":"Get Many Tasks","href":"/api-reference/endpoints/tasks/get-many-tasks"},{"openapi":"patch /tasks","title":"Update Task","href":"/api-reference/endpoints/tasks/update-task"},{"openapi":"post /tasks/ignore","title":"Ignore Tasks","href":"/api-reference/endpoints/tasks/ignore-tasks"}]},{"group":"Activities","expanded":false,"pages":[{"openapi":"get /activities","title":"Get Many Activities","href":"/api-reference/endpoints/activities/get-many-activities"},{"openapi":"delete /activities/{activityId}/recording-transcript","title":"Delete Activity Recording \u0026 Transcript","href":"/api-reference/endpoints/activities/delete-activity-recording-transcript"}]},{"group":"Calls","expanded":false,"pages":[{"openapi":"post /calls","title":"Log a Call","href":"/api-reference/endpoints/calls/log-call"},{"openapi":"patch /calls/{id}","title":"Update a Call","href":"/api-reference/endpoints/calls/update-call"},{"openapi":"get /calls/{id}","title":"Get a Call","href":"/api-reference/endpoints/calls/get-call"},{"openapi":"get /call-statuses","title":"Get Call Statuses","href":"/api-reference/endpoints/calls/get-call-statuses"}]},{"group":"CRMs","expanded":false,"pages":[{"openapi":"get /team/crmUsers","title":"Get Team CRM Users","href":"/api-reference/endpoints/crm/get-team-crm-users"},{"openapi":"get /crm/filters","title":"Get CRM Filters","href":"/api-reference/endpoints/crm/get-crm-filters"},{"openapi":"get /v2/crm/logs","title":"Get CRM Logs","href":"/api-reference/endpoints/crm/get-crm-logs"}]},{"group":"Unsubscribes","expanded":false,"pages":[{"group":"Variables","pages":[{"openapi":"get /v2/unsubscribes/variables","title":"List Unsubscribed Variables","href":"/api-reference/endpoints/unsubscribes/list-unsubscribed-variables"},{"openapi":"get /v2/unsubscribes/variables/{value}","title":"Get Unsubscribed Variable","href":"/api-reference/endpoints/unsubscribes/get-unsubscribed-variable"},{"openapi":"post /v2/unsubscribes/variables/{value}","title":"Unsubscribe Variable","href":"/api-reference/endpoints/unsubscribes/unsubscribe-variable"},{"openapi":"post /v2/unsubscribes/variables","title":"Bulk Unsubscribe Variables","href":"/api-reference/endpoints/unsubscribes/bulk-unsubscribe-variables"},{"openapi":"delete /v2/unsubscribes/variables/{value}","title":"Re-subscribe Variable","href":"/api-reference/endpoints/unsubscribes/resubscribe-variable"},{"openapi":"get /v2/unsubscribes/exports/variables","title":"Export Unsubscribed Variables","href":"/api-reference/endpoints/unsubscribes/export-unsubscribed-variables"}]},{"group":"Contacts","pages":[{"openapi":"get /v2/unsubscribes/contacts/{contactId}","title":"Get Contact Subscription Status","href":"/api-reference/endpoints/unsubscribes/get-contact-subscription-status"},{"openapi":"post /v2/unsubscribes/contacts/{contactId}","title":"Unsubscribe Contact","href":"/api-reference/endpoints/unsubscribes/unsubscribe-contact"},{"openapi":"delete /v2/unsubscribes/contacts/{contactId}","title":"Re-subscribe Contact","href":"/api-reference/endpoints/unsubscribes/resubscribe-contact"},{"openapi":"get /v2/unsubscribes/exports/contacts","title":"Export Unsubscribed Contacts","href":"/api-reference/endpoints/unsubscribes/export-unsubscribed-contacts"}]}]},{"group":"Webhooks","expanded":false,"pages":[{"openapi":"post /hooks","title":"Add Webhook","href":"/api-reference/endpoints/webhooks/add-webhook"},{"openapi":"delete /hooks/{hookId}","title":"Delete Webhook","href":"/api-reference/endpoints/webhooks/delete-webhook"},{"openapi":"get /hooks","title":"Get Many Webhooks","href":"/api-reference/endpoints/webhooks/get-many-webhooks"}]},{"group":"People database","expanded":false,"pages":[{"openapi":"post /database/people","title":"Search People database","href":"/api-reference/endpoints/people-database/search-people-database"},{"openapi":"post /database/people/linkedin-post-engagement","title":"Search LinkedIn post engagers","href":"/api-reference/endpoints/people-database/search-linkedin-post-engagers"},{"openapi":"post /database/companies","title":"Search Companies Database","href":"/api-reference/endpoints/people-database/search-companies-database"},{"openapi":"get /database/people/export","title":"Export People database","href":"/api-reference/endpoints/people-database/export-people-database"},{"openapi":"get /database/companies/export","title":"Export Companies database","href":"/api-reference/endpoints/people-database/export-companies-database"},{"openapi":"get /database/filters","title":"Get Database Filters","href":"/api-reference/endpoints/people-database/get-database-filters"},{"openapi":"get /database/personas","title":"List Personas","href":"/api-reference/endpoints/people-database/list-personas"},{"openapi":"post /database/personas","title":"Create Persona","href":"/api-reference/endpoints/people-database/create-persona"},{"openapi":"delete /database/personas/{personaId}","title":"Delete Persona","href":"/api-reference/endpoints/people-database/delete-persona"},{"openapi":"get /database/saved-searches","title":"List Saved Searches","href":"/api-reference/endpoints/people-database/list-saved-searches"},{"openapi":"post /database/saved-searches","title":"Create Saved Search","href":"/api-reference/endpoints/people-database/create-saved-search"},{"openapi":"get /database/saved-searches/{savedSearchId}","title":"Get Saved Search","href":"/api-reference/endpoints/people-database/get-saved-search"},{"openapi":"patch /database/saved-searches/{savedSearchId}","title":"Update Saved Search","href":"/api-reference/endpoints/people-database/update-saved-search"},{"openapi":"delete /database/saved-searches/{savedSearchId}","title":"Delete Saved Search","href":"/api-reference/endpoints/people-database/delete-saved-search"}]},{"group":"Contact sourcing","expanded":false,"pages":[{"openapi":"post /contact-sourcing","title":"Run Contact Sourcing","href":"/api-reference/endpoints/contact-sourcing/run-contact-sourcing"},{"openapi":"get /contact-sourcing","title":"Get Contact Sourcing Run","href":"/api-reference/endpoints/contact-sourcing/get-contact-sourcing-run"},{"openapi":"post /contact-sourcing/contacts","title":"Add a Sourced Contact","href":"/api-reference/endpoints/contact-sourcing/add-sourced-contact"}]},{"group":"Enrich","expanded":false,"pages":[{"title":"Enrich Data","openapi":"post /enrich","href":"/api-reference/endpoints/enrich/enrich-data"},{"openapi":"post /v2/enrichments/bulk","title":"Bulk Enrich Data","href":"/api-reference/endpoints/enrich/bulk-enrich-data"},{"openapi":"post /leads/{leadId}/enrich","title":"Enrich Lead","href":"/api-reference/endpoints/enrich/enrich-lead"},{"openapi":"get /enrich/{enrichId}","title":"Get Enrichment Result","href":"/api-reference/endpoints/enrich/get-enrichment-result"}]},{"group":"Enrichment Providers","expanded":false,"pages":[{"openapi":"get /v2/enrichments/providers","title":"List Enrichment Providers","href":"/api-reference/endpoints/enrichment-providers/list-enrichment-providers"},{"openapi":"put /v2/enrichments/providers/{providerId}/connection","title":"Connect Provider","href":"/api-reference/endpoints/enrichment-providers/connect-provider"},{"openapi":"delete /v2/enrichments/providers/{providerId}/connection","title":"Disconnect Provider","href":"/api-reference/endpoints/enrichment-providers/disconnect-provider"}]},{"group":"Enrichment Waterfalls","expanded":false,"pages":[{"openapi":"get /v2/enrichments/waterfalls","title":"List Enrichment Waterfalls","href":"/api-reference/endpoints/enrichment-waterfalls/list-enrichment-waterfalls"},{"openapi":"get /v2/enrichments/waterfalls/{waterfallId}","title":"Get Enrichment Waterfall","href":"/api-reference/endpoints/enrichment-waterfalls/get-enrichment-waterfall"},{"openapi":"patch /v2/enrichments/waterfalls/{waterfallId}","title":"Update Enrichment Waterfall","href":"/api-reference/endpoints/enrichment-waterfalls/update-enrichment-waterfall"},{"openapi":"put /v2/enrichments/waterfalls/{waterfallId}/reset","title":"Reset Enrichment Waterfall","href":"/api-reference/endpoints/enrichment-waterfalls/reset-enrichment-waterfall"}]},{"group":"lemwarm","expanded":false,"pages":[{"openapi":"post /lemwarm/{userMailboxId}/start","title":"Start lemwarm","href":"/api-reference/endpoints/lemwarm/start-lemwarm"},{"openapi":"post /lemwarm/{userMailboxId}/pause","title":"Pause lemwarm","href":"/api-reference/endpoints/lemwarm/pause-lemwarm"},{"openapi":"get /lemwarm/{userMailboxId}/settings","title":"Get lemwarm Settings","href":"/api-reference/endpoints/lemwarm/get-lemwarm-settings"},{"openapi":"patch /lemwarm/{userMailboxId}/settings","title":"Update lemwarm Settings","href":"/api-reference/endpoints/lemwarm/update-lemwarm-settings"},{"openapi":"get /lemwarm/errors","title":"Get warmup errors","href":"/api-reference/endpoints/lemwarm/get-warmup-errors"}]},{"group":"Self-recovery","expanded":false,"pages":[{"openapi":"get /self-recovery/config","title":"Get Self-recovery Config","href":"/api-reference/endpoints/self-recovery/get-config"},{"openapi":"patch /self-recovery/config","title":"Update Self-recovery Config","href":"/api-reference/endpoints/self-recovery/update-config"},{"openapi":"get /self-recovery/history","title":"List Self-recovery History","href":"/api-reference/endpoints/self-recovery/get-history"}]},{"group":"Signal Agents","expanded":false,"pages":[{"openapi":"get /watchlist","title":"List Signal Agents","href":"/api-reference/endpoints/watch-list/list-watch-lists"},{"openapi":"post /watchlist","title":"Create Signal Agent","href":"/api-reference/endpoints/watch-list/create-watch-list"},{"openapi":"patch /watchlist","title":"Update Signal Agent","href":"/api-reference/endpoints/watch-list/update-watch-list"},{"openapi":"post /watchlist/crm-lists","title":"Monitor CRM Lists with a Signal Agent","href":"/api-reference/endpoints/watch-list/associate-crm-lists"},{"openapi":"delete /watchlist","title":"Delete Signal Agent","href":"/api-reference/endpoints/watch-list/delete-watch-list"},{"openapi":"get /watchlist/history","title":"Get Signal Agent configuration history","href":"/api-reference/endpoints/watch-list/get-history"},{"openapi":"get /watchlist/signals","title":"Get Signal Agent signals","href":"/api-reference/endpoints/watch-list/get-signals"},{"openapi":"put /watchlist/signals","title":"Mark signals handled or ignored","href":"/api-reference/endpoints/watch-list/mark-signals"},{"openapi":"post /watchlist/{watchListId}/external-signals","title":"Push external signals","href":"/api-reference/endpoints/watch-list/push-external-signals"},{"openapi":"get /watchlist/library","title":"List available signal types","href":"/api-reference/endpoints/watch-list/get-library"},{"openapi":"get /watchlist/filters","title":"List allowed filters per signal type","href":"/api-reference/endpoints/watch-list/get-filters"},{"openapi":"get /watchlist/filter-values","title":"Autocomplete filter values","href":"/api-reference/endpoints/watch-list/get-filter-values"},{"openapi":"get /watchlist/linkedin-profile-views/members","title":"List LinkedIn profile views members","href":"/api-reference/endpoints/watch-list/get-linkedin-profile-views-members"}]},{"group":"Deliverability alerts","expanded":false,"pages":[{"openapi":"get /deliverability/alerts","title":"List Deliverability Alerts","href":"/api-reference/endpoints/deliverability-alerts/list-alerts"},{"openapi":"post /deliverability/alerts","title":"Create Deliverability Alert","href":"/api-reference/endpoints/deliverability-alerts/create-alert"},{"openapi":"get /deliverability/alerts/{alertId}","title":"Get Deliverability Alert","href":"/api-reference/endpoints/deliverability-alerts/get-alert"},{"openapi":"patch /deliverability/alerts/{alertId}","title":"Update Deliverability Alert","href":"/api-reference/endpoints/deliverability-alerts/update-alert"},{"openapi":"delete /deliverability/alerts/{alertId}","title":"Delete Deliverability Alert","href":"/api-reference/endpoints/deliverability-alerts/delete-alert"},{"openapi":"get /deliverability/incidents","title":"List Deliverability Incidents","href":"/api-reference/endpoints/deliverability-alerts/list-incidents"}]},{"group":"Sender picture","expanded":false,"pages":[{"openapi":"get /sender-picture/mailboxes","title":"Get Sender Picture Status","href":"/api-reference/endpoints/sender-picture/get-sender-picture-status"},{"openapi":"post /sender-picture/sync","title":"Sync Sender Picture","href":"/api-reference/endpoints/sender-picture/sync-sender-picture"}]},{"group":"Domains","expanded":false,"pages":[{"openapi":"post /domains-core/search","title":"Search Domains","href":"/api-reference/endpoints/domains/search-domains"},{"openapi":"post /domains-core/purchase","title":"Purchase Domain","href":"/api-reference/endpoints/domains/purchase-domain"},{"openapi":"get /domains-core/team-domains","title":"List Domains","href":"/api-reference/endpoints/domains/list-domains"},{"openapi":"post /domains-core/{domainId}/mailboxes","title":"Order Mailboxes","href":"/api-reference/endpoints/domains/order-mailboxes"},{"openapi":"get /domains-core/mailboxes","title":"List Domain Mailboxes","href":"/api-reference/endpoints/domains/list-domain-mailboxes"},{"openapi":"patch /domains-core/mailboxes/{mailboxId}","title":"Update Domain Mailbox","href":"/api-reference/endpoints/domains/update-domain-mailbox"}]},{"group":"Fields","expanded":false,"pages":[{"openapi":"get /fields","title":"List Fields","href":"/api-reference/endpoints/fields/list-fields"},{"openapi":"post /fields","title":"Create or Update Field","href":"/api-reference/endpoints/fields/create-field"},{"openapi":"delete /fields/{entity}/{name}","title":"Delete Field","href":"/api-reference/endpoints/fields/delete-field"}]}]},{"group":"Objects \u0026 Definitions","pages":[{"title":"Team","href":"/api-reference/objects-definitions/team"},{"title":null,"href":"/api-reference/objects-definitions/credits"},{"title":"User","href":"/api-reference/objects-definitions/user"},{"title":"Campaign","href":"/api-reference/objects-definitions/campaign"},{"title":"Campaign Settings","href":"/api-reference/objects-definitions/campaign-settings"},{"title":"Lead","href":"/api-reference/objects-definitions/lead"},{"title":"Activity","href":"/api-reference/objects-definitions/activity"},{"title":"Enrichment","href":"/api-reference/objects-definitions/enrich"},{"title":"Task","href":"/api-reference/objects-definitions/task"},{"title":"Inbox Conversation","href":"/api-reference/objects-definitions/inbox-conversation"},{"title":"Inbox Message","href":"/api-reference/objects-definitions/inbox-message"},{"title":"Contact","href":"/api-reference/objects-definitions/contact"},{"title":"Self-recovery config","href":"/api-reference/objects-definitions/self-recovery-config"},{"title":"Self-recovery case","href":"/api-reference/objects-definitions/self-recovery-case"},{"group":"People Database","expanded":false,"pages":[{"title":"Database","href":"/api-reference/objects-definitions/database"},{"title":"People","href":"/api-reference/objects-definitions/people-database"},{"title":"Company","href":"/api-reference/objects-definitions/company-database"},{"title":"Persona","href":"/api-reference/objects-definitions/persona"},{"title":"Saved search","href":"/api-reference/objects-definitions/saved-search"}]},{"title":"CRM Filter","href":"/api-reference/objects-definitions/crm-filter"},{"title":null,"href":"/api-reference/objects-definitions/company"},{"title":"Lemwarm Settings","href":"/api-reference/objects-definitions/lemwarm"},{"title":"Warmup Error","href":"/api-reference/objects-definitions/warmup-error"},{"title":"Campaign Status","href":"/api-reference/objects-definitions/campaign-status"},{"title":"Channel","href":"/api-reference/objects-definitions/channel"},{"title":"Sequence","href":"/api-reference/objects-definitions/sequence"},{"title":"Step","href":"/api-reference/objects-definitions/step"},{"title":"Message template","href":"/api-reference/objects-definitions/message-template"},{"title":"Snippet","href":"/api-reference/objects-definitions/snippet"},{"title":"Schedule","href":"/api-reference/objects-definitions/schedule"},{"title":"Label","href":"/api-reference/objects-definitions/label"},{"title":"Report","href":"/api-reference/objects-definitions/report"},{"title":"Webhook","href":"/api-reference/objects-definitions/webhook"},{"title":"Mailbox","href":"/api-reference/objects-definitions/mailbox"},{"title":"Domain","href":"/api-reference/objects-definitions/domain"},{"title":"Domain mailbox","href":"/api-reference/objects-definitions/domain-mailbox"},{"title":"Company Note","href":"/api-reference/objects-definitions/company-note"},{"title":"Contact Note","href":"/api-reference/objects-definitions/contact-note"},{"title":"CRM Log","href":"/api-reference/objects-definitions/crm-log"},{"title":"Signal Agents / Signal","href":"/api-reference/objects-definitions/signal"},{"title":"Signal Agents / Watch List","href":"/api-reference/objects-definitions/watch-list"},{"title":"Deliverability alert","href":"/api-reference/objects-definitions/deliverability-alert"},{"title":"Deliverability incident","href":"/api-reference/objects-definitions/deliverability-incident"},{"title":"Sender picture","href":"/api-reference/objects-definitions/sender-picture"}]}]},{"tab":"MCP Server","pages":[{"title":"MCP Server","href":"/mcp/setup"}]},{"tab":"CLI","pages":[{"title":"CLI","href":"/cli/overview"}]},{"tab":"Guides","pages":[{"title":"Guides","href":"/guides"}]}]},"basePath":"","title":"Lemlist Developer Docs","buildId":"dpl_8hoxaqFTU7hTr6A2fUraxAyjuiZo","deploymentId":"dpl_8hoxaqFTU7hTr6A2fUraxAyjuiZo","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CDiBsYGW.js","utils-KF9rPlmF.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C26urKTX.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BdjmJAC1.js","snippetPresets-3IpDBjt3.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-D4x_2vvo.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BIWdc5Pa.js","shallow-LQqfiMNd.js","getApiPlaygroundDisplay-DryzlOZG.js","CodeSnippet-tcJujU4r.js","CodeSnippets-BHp0nVLL.js","Page-1CZdsdAn.js","getPastedJson-DU-1ayUv.js","icon-CZK2hPr4.js","MethodPill-DOaqmTFC.js","DuplicateIcon-B5-nUxxl.js","createIcon-CDP_U77G.js","DynamicMarkdown-GHvayGOn.js","SectionHeading-BYvpkmUD.js","axios-vUo_bRtp.js","Markdown-uxhlayGT.js","clsx-B35qUV0p.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BvrGG8gU.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-CAf0yVYe.js"]}