Get a campaign

GET
/advanced/campaigns/{campaignId}

Returns the full campaign: schedule (settings), sequence tree (steps), identities, attached lists with their contact count, status and dates. Read it before any PATCH: the steps and settings routes replace what you send.

Authorization

apiKey
Authorization<token>

Your 48 character API key, sent as is (a Bearer prefix is tolerated). Create it at https://v3.emelia.io/settings/api.

In: header

Path Parameters

campaignId*string

Identifier of a multichannel campaign (24 hexadecimal characters), as returned by POST /advanced/campaigns or GET /advanced/campaigns.

Match^[0-9a-fA-F]{24}$

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/advanced/campaigns/6650f1a2b839d80011c5a0f1" \  -H "Authorization: YOUR_API_KEY"
{  "success": true,  "campaign": {    "_id": "6650f1a2b839d80011c5a0f1",    "name": "Q4 outreach: SaaS founders",    "status": "DRAFT",    "tagIds": [      "6650f1a2b839d80011c5a0f1"    ],    "identities": [      {        "_id": "6650f1a2b839d80011c5a0f1",        "userId": "6650f1a2b839d80011c5a0f1",        "name": "Marie Martin",        "email": "6650f1a2b839d80011c5a0f1",        "linkedin": "6650f1a2b839d80011c5a0f1",        "whatsapp": "6650f1a2b839d80011c5a0f1"      }    ],    "schedule": {      "dailyEmailAdded": 35,      "dailyEmailLimit": 100,      "dailyLinkedinAdded": 20,      "dailyWhatsappAdded": 20,      "bcc": "",      "trackLinks": false,      "trackOpens": false,      "timeZone": "Europe/Brussels",      "days": [        0,        1,        2,        3,        4      ],      "start": "08:00",      "end": "17:00",      "blacklistUnsub": false,      "excludeAlreadyMessaged": true,      "eventToStop": [        "VISITED"      ],      "alwaysOn": false,      "ignoreAutoReplies": false    },    "steps": {      "_id": "6650f1a2b839d800552fc201",      "stepType": "START",      "delay": {        "amount": 1,        "unit": "MINUTES"      },      "identities": [        "6650f1a2b839d800d4064809"      ],      "versions": [        {          "_id": "6650f1a2b839d800ed4363dc",          "subject": "Quick question about Nexora",          "message": "Hi Claire, thanks for your reply. Are you free for a call on Thursday?",          "disabled": false,          "rawHtml": true,          "attachments": [            {              "mediaType": "MEDIA"            }          ]        }      ],      "cc": "",      "conditions": {        "field": "MAIL_REPLIED",        "operator": "EQUAL"      },      "next": {        "_id": "6650f1a2b839d800f83a5090",        "stepType": "START",        "delay": {          "amount": 1,          "unit": "MINUTES"        },        "identities": [          "6650f1a2b839d800c85e3a84"        ],        "versions": [          {            "_id": "6650f1a2b839d8001daab8ff",            "subject": "Quick question about Nexora",            "message": "Hi Claire, thanks for your reply. Are you free for a call on Thursday?",            "disabled": false,            "rawHtml": true,            "attachments": []          }        ],        "cc": "",        "conditions": {          "field": "MAIL_REPLIED",          "operator": "EQUAL"        },        "next": {          "_id": "6650f1a2b839d80040f13c3f",          "stepType": "START",          "delay": {            "amount": 1,            "unit": "MINUTES"          },          "identities": [            "6650f1a2b839d800c39d462f"          ],          "versions": [            {}          ],          "cc": "",          "conditions": {            "field": "MAIL_REPLIED",            "operator": "EQUAL"          },          "next": {            "_id": "6650f1a2b839d80035cb8e8a",            "stepType": "START",            "delay": {              "unit": "MINUTES"            },            "identities": [],            "versions": [],            "cc": "",            "conditions": {              "operator": "EQUAL"            },            "next": {              "stepType": "START"            },            "yes": {              "stepType": "START"            },            "no": {              "stepType": "START"            }          },          "yes": {            "_id": "6650f1a2b839d8008283738e",            "stepType": "START",            "delay": {              "unit": "MINUTES"            },            "identities": [],            "versions": [],            "cc": "",            "conditions": {              "operator": "EQUAL"            },            "next": {              "stepType": "START"            },            "yes": {              "stepType": "START"            },            "no": {              "stepType": "START"            }          },          "no": {            "_id": "6650f1a2b839d800fabfab18",            "stepType": "START",            "delay": {              "unit": "MINUTES"            },            "identities": [],            "versions": [],            "cc": "",            "conditions": {              "operator": "EQUAL"            },            "next": {              "stepType": "START"            },            "yes": {              "stepType": "START"            },            "no": {              "stepType": "START"            }          }        },        "yes": {          "_id": "6650f1a2b839d800cf9b2e9d",          "stepType": "START",          "delay": {            "amount": 1,            "unit": "MINUTES"          },          "identities": [            "6650f1a2b839d800cd9659c5"          ],          "versions": [            {}          ],          "cc": "",          "conditions": {            "field": "MAIL_REPLIED",            "operator": "EQUAL"          },          "next": {            "_id": "6650f1a2b839d8000feddd84",            "stepType": "START",            "delay": {              "unit": "MINUTES"            },            "identities": [],            "versions": [],            "cc": "",            "conditions": {              "operator": "EQUAL"            },            "next": {              "stepType": "START"            },            "yes": {              "stepType": "START"            },            "no": {              "stepType": "START"            }          },          "yes": {            "_id": "6650f1a2b839d8006252b58c",            "stepType": "START",            "delay": {              "unit": "MINUTES"            },            "identities": [],            "versions": [],            "cc": "",            "conditions": {              "operator": "EQUAL"            },            "next": {              "stepType": "START"            },            "yes": {              "stepType": "START"            },            "no": {              "stepType": "START"            }          },          "no": {            "_id": "6650f1a2b839d800f02835ee",            "stepType": "START",            "delay": {              "unit": "MINUTES"            },            "identities": [],            "versions": [],            "cc": "",            "conditions": {              "operator": "EQUAL"            },            "next": {              "stepType": "START"            },            "yes": {              "stepType": "START"            },            "no": {              "stepType": "START"            }          }        },        "no": {          "_id": "6650f1a2b839d80090000761",          "stepType": "START",          "delay": {            "amount": 1,            "unit": "MINUTES"          },          "identities": [            "6650f1a2b839d800df7d5a69"          ],          "versions": [            {}          ],          "cc": "",          "conditions": {            "field": "MAIL_REPLIED",            "operator": "EQUAL"          },          "next": {            "_id": "6650f1a2b839d800e7c06cf0",            "stepType": "START",            "delay": {              "unit": "MINUTES"            },            "identities": [],            "versions": [],            "cc": "",            "conditions": {              "operator": "EQUAL"            },            "next": {              "stepType": "START"            },            "yes": {              "stepType": "START"            },            "no": {              "stepType": "START"            }          },          "yes": {            "_id": "6650f1a2b839d80044432310",            "stepType": "START",            "delay": {              "unit": "MINUTES"            },            "identities": [],            "versions": [],            "cc": "",            "conditions": {              "operator": "EQUAL"            },            "next": {              "stepType": "START"            },            "yes": {              "stepType": "START"            },            "no": {              "stepType": "START"            }          },          "no": {            "_id": "6650f1a2b839d8001cc27212",            "stepType": "START",            "delay": {              "unit": "MINUTES"            },            "identities": [],            "versions": [],            "cc": "",            "conditions": {              "operator": "EQUAL"            },            "next": {              "stepType": "START"            },            "yes": {              "stepType": "START"            },            "no": {              "stepType": "START"            }          }        }      },      "yes": {        "_id": "6650f1a2b839d8002fcb7330",        "stepType": "START",        "delay": {          "amount": 1,          "unit": "MINUTES"        },        "identities": [          "6650f1a2b839d80073add4a4"        ],        "versions": [          {            "_id": "6650f1a2b839d800501b769f",            "subject": "Quick question about Nexora",            "message": "Hi Claire, thanks for your reply. Are you free for a call on Thursday?",            "disabled": false,            "rawHtml": true,            "attachments": []          }        ],        "cc": "",        "conditions": {          "field": "MAIL_REPLIED",          "operator": "EQUAL"        },        "next": {          "_id": "6650f1a2b839d8008e0454df",          "stepType": "START",          "delay": {            "amount": 1,            "unit": "MINUTES"          },          "identities": [            "6650f1a2b839d8000fad334f"          ],          "versions": [            {}          ],          "cc": "",          "conditions": {            "field": "MAIL_REPLIED",            "operator": "EQUAL"          },          "next": {            "_id": "6650f1a2b839d8005ea5a9aa",            "stepType": "START",            "delay": {              "unit": "MINUTES"            },            "identities": [],            "versions": [],            "cc": "",            "conditions": {              "operator": "EQUAL"            },            "next": {              "stepType": "START"            },            "yes": {              "stepType": "START"            },            "no": {              "stepType": "START"            }          },          "yes": {            "_id": "6650f1a2b839d8002c0be9ae",            "stepType": "START",            "delay": {              "unit": "MINUTES"            },            "identities": [],            "versions": [],            "cc": "",            "conditions": {              "operator": "EQUAL"            },            "next": {              "stepType": "START"            },            "yes": {              "stepType": "START"            },            "no": {              "stepType": "START"            }          },          "no": {            "_id": "6650f1a2b839d800a7cdff38",            "stepType": "START",            "delay": {              "unit": "MINUTES"            },            "identities": [],            "versions": [],            "cc": "",            "conditions": {              "operator": "EQUAL"            },            "next": {              "stepType": "START"            },            "yes": {              "stepType": "START"            },            "no": {              "stepType": "START"            }          }        },        "yes": {          "_id": "6650f1a2b839d8009c26aa3d",          "stepType": "START",          "delay": {            "amount": 1,            "unit": "MINUTES"          },          "identities": [            "6650f1a2b839d8005f17e165"          ],          "versions": [            {}          ],          "cc": "",          "conditions": {            "field": "MAIL_REPLIED",            "operator": "EQUAL"          },          "next": {            "_id": "6650f1a2b839d800b36aea24",            "stepType": "START",            "delay": {              "unit": "MINUTES"            },            "identities": [],            "versions": [],            "cc": "",            "conditions": {              "operator": "EQUAL"            },            "next": {              "stepType": "START"            },            "yes": {              "stepType": "START"            },            "no": {              "stepType": "START"            }          },          "yes": {            "_id": "6650f1a2b839d800e02962ac",            "stepType": "START",            "delay": {              "unit": "MINUTES"            },            "identities": [],            "versions": [],            "cc": "",            "conditions": {              "operator": "EQUAL"            },            "next": {              "stepType": "START"            },            "yes": {              "stepType": "START"            },            "no": {              "stepType": "START"            }          },          "no": {            "_id": "6650f1a2b839d80027a94e0e",            "stepType": "START",            "delay": {              "unit": "MINUTES"            },            "identities": [],            "versions": [],            "cc": "",            "conditions": {              "operator": "EQUAL"            },            "next": {              "stepType": "START"            },            "yes": {              "stepType": "START"            },            "no": {              "stepType": "START"            }          }        },        "no": {          "_id": "6650f1a2b839d80093737481",          "stepType": "START",          "delay": {            "amount": 1,            "unit": "MINUTES"          },          "identities": [            "6650f1a2b839d800f3adb689"          ],          "versions": [            {}          ],          "cc": "",          "conditions": {            "field": "MAIL_REPLIED",            "operator": "EQUAL"          },          "next": {            "_id": "6650f1a2b839d8009dccc810",            "stepType": "START",            "delay": {              "unit": "MINUTES"            },            "identities": [],            "versions": [],            "cc": "",            "conditions": {              "operator": "EQUAL"            },            "next": {              "stepType": "START"            },            "yes": {              "stepType": "START"            },            "no": {              "stepType": "START"            }          },          "yes": {            "_id": "6650f1a2b839d800a937cdb0",            "stepType": "START",            "delay": {              "unit": "MINUTES"            },            "identities": [],            "versions": [],            "cc": "",            "conditions": {              "operator": "EQUAL"            },            "next": {              "stepType": "START"            },            "yes": {              "stepType": "START"            },            "no": {              "stepType": "START"            }          },          "no": {            "_id": "6650f1a2b839d800a9f44632",            "stepType": "START",            "delay": {              "unit": "MINUTES"            },            "identities": [],            "versions": [],            "cc": "",            "conditions": {              "operator": "EQUAL"            },            "next": {              "stepType": "START"            },            "yes": {              "stepType": "START"            },            "no": {              "stepType": "START"            }          }        }      },      "no": {        "_id": "6650f1a2b839d800b74f7ab2",        "stepType": "START",        "delay": {          "amount": 1,          "unit": "MINUTES"        },        "identities": [          "6650f1a2b839d800d01a715e"        ],        "versions": [          {            "_id": "6650f1a2b839d80015726ab1",            "subject": "Quick question about Nexora",            "message": "Hi Claire, thanks for your reply. Are you free for a call on Thursday?",            "disabled": false,            "rawHtml": true,            "attachments": []          }        ],        "cc": "",        "conditions": {          "field": "MAIL_REPLIED",          "operator": "EQUAL"        },        "next": {          "_id": "6650f1a2b839d800919d6c25",          "stepType": "START",          "delay": {            "amount": 1,            "unit": "MINUTES"          },          "identities": [            "6650f1a2b839d8001b9fadcd"          ],          "versions": [            {}          ],          "cc": "",          "conditions": {            "field": "MAIL_REPLIED",            "operator": "EQUAL"          },          "next": {            "_id": "6650f1a2b839d800afc51a2c",            "stepType": "START",            "delay": {              "unit": "MINUTES"            },            "identities": [],            "versions": [],            "cc": "",            "conditions": {              "operator": "EQUAL"            },            "next": {              "stepType": "START"            },            "yes": {              "stepType": "START"            },            "no": {              "stepType": "START"            }          },          "yes": {            "_id": "6650f1a2b839d800a0db0d14",            "stepType": "START",            "delay": {              "unit": "MINUTES"            },            "identities": [],            "versions": [],            "cc": "",            "conditions": {              "operator": "EQUAL"            },            "next": {              "stepType": "START"            },            "yes": {              "stepType": "START"            },            "no": {              "stepType": "START"            }          },          "no": {            "_id": "6650f1a2b839d800cc259cb6",            "stepType": "START",            "delay": {              "unit": "MINUTES"            },            "identities": [],            "versions": [],            "cc": "",            "conditions": {              "operator": "EQUAL"            },            "next": {              "stepType": "START"            },            "yes": {              "stepType": "START"            },            "no": {              "stepType": "START"            }          }        },        "yes": {          "_id": "6650f1a2b839d800271026d7",          "stepType": "START",          "delay": {            "amount": 1,            "unit": "MINUTES"          },          "identities": [            "6650f1a2b839d8005e80ef67"          ],          "versions": [            {}          ],          "cc": "",          "conditions": {            "field": "MAIL_REPLIED",            "operator": "EQUAL"          },          "next": {            "_id": "6650f1a2b839d8004728f7c2",            "stepType": "START",            "delay": {              "unit": "MINUTES"            },            "identities": [],            "versions": [],            "cc": "",            "conditions": {              "operator": "EQUAL"            },            "next": {              "stepType": "START"            },            "yes": {              "stepType": "START"            },            "no": {              "stepType": "START"            }          },          "yes": {            "_id": "6650f1a2b839d800f6ba16e6",            "stepType": "START",            "delay": {              "unit": "MINUTES"            },            "identities": [],            "versions": [],            "cc": "",            "conditions": {              "operator": "EQUAL"            },            "next": {              "stepType": "START"            },            "yes": {              "stepType": "START"            },            "no": {              "stepType": "START"            }          },          "no": {            "_id": "6650f1a2b839d8002a3b9db0",            "stepType": "START",            "delay": {              "unit": "MINUTES"            },            "identities": [],            "versions": [],            "cc": "",            "conditions": {              "operator": "EQUAL"            },            "next": {              "stepType": "START"            },            "yes": {              "stepType": "START"            },            "no": {              "stepType": "START"            }          }        },        "no": {          "_id": "6650f1a2b839d8001f510c4b",          "stepType": "START",          "delay": {            "amount": 1,            "unit": "MINUTES"          },          "identities": [            "6650f1a2b839d8004a565f5b"          ],          "versions": [            {}          ],          "cc": "",          "conditions": {            "field": "MAIL_REPLIED",            "operator": "EQUAL"          },          "next": {            "_id": "6650f1a2b839d8004b91260e",            "stepType": "START",            "delay": {              "unit": "MINUTES"            },            "identities": [],            "versions": [],            "cc": "",            "conditions": {              "operator": "EQUAL"            },            "next": {              "stepType": "START"            },            "yes": {              "stepType": "START"            },            "no": {              "stepType": "START"            }          },          "yes": {            "_id": "6650f1a2b839d80018e2a0ca",            "stepType": "START",            "delay": {              "unit": "MINUTES"            },            "identities": [],            "versions": [],            "cc": "",            "conditions": {              "operator": "EQUAL"            },            "next": {              "stepType": "START"            },            "yes": {              "stepType": "START"            },            "no": {              "stepType": "START"            }          },          "no": {            "_id": "6650f1a2b839d800cd0fbfc4",            "stepType": "START",            "delay": {              "unit": "MINUTES"            },            "identities": [],            "versions": [],            "cc": "",            "conditions": {              "operator": "EQUAL"            },            "next": {              "stepType": "START"            },            "yes": {              "stepType": "START"            },            "no": {              "stepType": "START"            }          }        }      }    },    "recipients": {      "lists": [        {          "_id": "6650f1a2b839d80011c5a0f1",          "name": "Q4 outreach: SaaS founders",          "contactCount": 1        }      ],      "excludedLists": [        {          "_id": "6650f1a2b839d80011c5a0f1",          "name": "Q4 outreach: SaaS founders",          "contactCount": 1        }      ],      "processing": true    },    "zapierData": [      {        "_id": "6650f1a2b839d80011c5a0f1",        "webhookUrl": "https://hooks.yourcompany.com/emelia",        "events": []      }    ],    "hubspotIntegration": {},    "pipedriveIntegration": {},    "createdAt": "2026-10-06T09:30:00.000Z",    "startAt": "2026-10-06T09:30:00.000Z",    "estimatedEnd": "2026-10-06T09:30:00.000Z",    "plannedStart": "2026-10-06T09:30:00.000Z"  }}