Get a campaign flow step

curl --request GET \
  --url https://api.extole.io/v2/campaigns/{campaignId}{version}/flow-steps/{flowStepId} \
  --header 'Authorization: <api-key>'

import requests

url = "https://api.extole.io/v2/campaigns/{campaignId}{version}/flow-steps/{flowStepId}"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.extole.io/v2/campaigns/{campaignId}{version}/flow-steps/{flowStepId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.extole.io/v2/campaigns/{campaignId}{version}/flow-steps/{flowStepId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.extole.io/v2/campaigns/{campaignId}{version}/flow-steps/{flowStepId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.extole.io/v2/campaigns/{campaignId}{version}/flow-steps/{flowStepId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "apps": [
    {
      "component_ids": [
        "<string>"
      ],
      "component_references": [
        {
          "component_id": "<string>",
          "socket_names": [
            "<string>"
          ]
        }
      ],
      "description": "<string>",
      "id": "<string>",
      "name": "<string>",
      "type": {
        "name": "<string>"
      }
    }
  ],
  "component_ids": [
    "<string>"
  ],
  "component_references": [
    {
      "component_id": "<string>",
      "socket_names": [
        "<string>"
      ]
    }
  ],
  "description": "<string>",
  "flow_path": "<string>",
  "flow_step_id": "<string>",
  "icon_color": "<string>",
  "icon_type": "<string>",
  "metrics": [
    {
      "component_ids": [
        "<string>"
      ],
      "component_references": [
        {
          "component_id": "<string>",
          "socket_names": [
            "<string>"
          ]
        }
      ],
      "description": "<string>",
      "expression": "<string>",
      "id": "<string>",
      "name": "<string>",
      "tags": [
        "<string>"
      ],
      "unit": "<string>"
    }
  ],
  "name": "<string>",
  "sequence": 123,
  "step_name": "<string>",
  "tags": [
    "<string>"
  ],
  "words": {
    "person_counting_name": "<string>",
    "plural_noun_name": "<string>",
    "rate_name": "<string>",
    "singular_noun_name": "<string>",
    "verb_name": "<string>"
  }
}

GET

campaigns

{campaignId}

{version}

flow-steps

{flowStepId}

Get a campaign flow step

curl --request GET \
  --url https://api.extole.io/v2/campaigns/{campaignId}{version}/flow-steps/{flowStepId} \
  --header 'Authorization: <api-key>'

import requests

url = "https://api.extole.io/v2/campaigns/{campaignId}{version}/flow-steps/{flowStepId}"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.extole.io/v2/campaigns/{campaignId}{version}/flow-steps/{flowStepId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.extole.io/v2/campaigns/{campaignId}{version}/flow-steps/{flowStepId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.extole.io/v2/campaigns/{campaignId}{version}/flow-steps/{flowStepId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.extole.io/v2/campaigns/{campaignId}{version}/flow-steps/{flowStepId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "apps": [
    {
      "component_ids": [
        "<string>"
      ],
      "component_references": [
        {
          "component_id": "<string>",
          "socket_names": [
            "<string>"
          ]
        }
      ],
      "description": "<string>",
      "id": "<string>",
      "name": "<string>",
      "type": {
        "name": "<string>"
      }
    }
  ],
  "component_ids": [
    "<string>"
  ],
  "component_references": [
    {
      "component_id": "<string>",
      "socket_names": [
        "<string>"
      ]
    }
  ],
  "description": "<string>",
  "flow_path": "<string>",
  "flow_step_id": "<string>",
  "icon_color": "<string>",
  "icon_type": "<string>",
  "metrics": [
    {
      "component_ids": [
        "<string>"
      ],
      "component_references": [
        {
          "component_id": "<string>",
          "socket_names": [
            "<string>"
          ]
        }
      ],
      "description": "<string>",
      "expression": "<string>",
      "id": "<string>",
      "name": "<string>",
      "tags": [
        "<string>"
      ],
      "unit": "<string>"
    }
  ],
  "name": "<string>",
  "sequence": 123,
  "step_name": "<string>",
  "tags": [
    "<string>"
  ],
  "words": {
    "person_counting_name": "<string>",
    "plural_noun_name": "<string>",
    "rate_name": "<string>",
    "singular_noun_name": "<string>",
    "verb_name": "<string>"
  }
}

Authorizations

Authorization

string

header

required

Path Parameters

campaignId

string

required

version

string

required

Pattern: (/version/.+)?

flowStepId

string

required

Response

Successful response

Stored campaign flow step definition. Fields flow_path, sequence, step_name, icon_type, tags, name, icon_color, and description are unevaluated and appear in buildtime-evaluatable form.

apps

object[]

required

Show child attributes

component_ids

string[]

required

component_references

object[]

required

Show child attributes

description

required

The description as configured: a literal value, or an expression (type:string) when defined dynamically.

flow_path

required

The flow path as configured: a literal value, or an expression (type:string) when defined dynamically.

flow_step_id

string

required

icon_color

required

The icon color as configured: a literal value, or an expression (type:string) when defined dynamically.

icon_type

required

The icon type as configured: a literal value, or an expression (type:string) when defined dynamically.

metrics

object[]

required

Show child attributes

name

required

The name as configured: a literal value, or an expression (type:string) when defined dynamically.

sequence

required

The sequence as configured: a literal value, or an expression (type:string) when defined dynamically.

step_name

required

The step name as configured: a literal value, or an expression (type:string) when defined dynamically.

Getting Started

Consumer to Extole API

Server to Extole API

Management API

Management Expert API

Get a campaign flow step

Authorizations

Path Parameters

Response