Skip to navigation
HeyReach APICampaigns

GetCampaignSequence

View as Markdown

Retrieves the current sequence (workflow) of a campaign as a PublicSequenceNodeDto.

The returned object is directly compatible with the sequence field in Create and UpdateSequence - you can use it as-is without modification. Returns an empty 200 response if the campaign has no sequence.

Query Parameters

  • campaignId (long, required): The campaign whose sequence to retrieve.

Integration node payloads in the response

SEND_LEAD_TO_* payloads include the current state of the external lead flag (see UpdateSequence for the full schemas):

  • SEND_LEAD_TO_SMARTLEAD: pauseExternalLead is always present.

  • SEND_LEAD_TO_INSTANTLY: removeExternalLead is present only when resourceType is CAMPAIGN; it is omitted entirely for LIST.

  • SEND_LEAD_TO_BISON: stopExternalLead is null when the node has no bisonCampaignId.

If you edit a response before sending it back, keep those rules in mind - adding removeExternalLead to a LIST node, or stopExternalLead to a node without a bisonCampaignId, is rejected with 400.

Headers

X-API-KEYstringOptional

API key header using this scheme. Example: “X-API-KEY: {API_KEY}”

Query parameters

campaignIdstringOptional

(Required) The campaign whose sequence to retrieve

Response

OK
nodeTypestring
actionDelayinteger
actionDelayUnitstring
payloadobject
conditionalNodeobject
unconditionalNodeobject