curl --request GET \
--url https://automations-api.vortexiq.ai/v1/automations/imports/{importId}/plan \
--header 'Authorization: Bearer <token>'import requests
url = "https://automations-api.vortexiq.ai/v1/automations/imports/{importId}/plan"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://automations-api.vortexiq.ai/v1/automations/imports/{importId}/plan', 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://automations-api.vortexiq.ai/v1/automations/imports/{importId}/plan",
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: Bearer <token>"
],
]);
$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://automations-api.vortexiq.ai/v1/automations/imports/{importId}/plan"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://automations-api.vortexiq.ai/v1/automations/imports/{importId}/plan")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://automations-api.vortexiq.ai/v1/automations/imports/{importId}/plan")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"success": true,
"contract_version": 1,
"data": {
"plan": {
"name": "Daily product summary",
"platform": "shopify",
"plan_hash": "efce57d742d87684551fd55d5348b48159fc83d6b8bd12c75952f98f50651c5a",
"runnable": true,
"refusal": null,
"trigger": {
"kind": "schedule",
"node": "Daily"
},
"schedule": {
"cadence": "daily",
"run_at": "07:00"
},
"trigger_rule": "every day at 07:00",
"trigger_timezone": null,
"plan_summary": {
"runs": 3,
"shows": 0,
"unsupported": 0,
"sends": 0
},
"steps": [
{
"name": "Daily",
"type": "n8n-nodes-base.scheduleTrigger",
"disposition": "run",
"reason": null,
"needs": null
},
{
"name": "Products",
"type": "n8n-nodes-base.httpRequest",
"disposition": "run",
"reason": null,
"needs": {
"kind": "store",
"target": null
}
}
]
}
}
}{
"success": false,
"contract_version": 2,
"message": "<string>",
"code": "<string>",
"errors": {}
}{
"success": false,
"contract_version": 2,
"message": "<string>",
"code": "<string>",
"errors": {}
}{
"success": false,
"contract_version": 2,
"message": "<string>",
"code": "<string>",
"errors": {}
}{
"success": false,
"contract_version": 2,
"message": "<string>",
"code": "<string>",
"errors": {}
}Get import plan
How an imported workflow (an n8n or Shopify Flow export) would run as your own automation, step by step:
whether each step runs, only shows what it would write, or is not supported, with the reason, and what a step
needs connected. Nothing runs. Answers 404 for an import made from a description, which has no workflow, and
when running imported workflows is not switched on for your organisation.
Needs the automations:read scope.
curl --request GET \
--url https://automations-api.vortexiq.ai/v1/automations/imports/{importId}/plan \
--header 'Authorization: Bearer <token>'import requests
url = "https://automations-api.vortexiq.ai/v1/automations/imports/{importId}/plan"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://automations-api.vortexiq.ai/v1/automations/imports/{importId}/plan', 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://automations-api.vortexiq.ai/v1/automations/imports/{importId}/plan",
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: Bearer <token>"
],
]);
$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://automations-api.vortexiq.ai/v1/automations/imports/{importId}/plan"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://automations-api.vortexiq.ai/v1/automations/imports/{importId}/plan")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://automations-api.vortexiq.ai/v1/automations/imports/{importId}/plan")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"success": true,
"contract_version": 1,
"data": {
"plan": {
"name": "Daily product summary",
"platform": "shopify",
"plan_hash": "efce57d742d87684551fd55d5348b48159fc83d6b8bd12c75952f98f50651c5a",
"runnable": true,
"refusal": null,
"trigger": {
"kind": "schedule",
"node": "Daily"
},
"schedule": {
"cadence": "daily",
"run_at": "07:00"
},
"trigger_rule": "every day at 07:00",
"trigger_timezone": null,
"plan_summary": {
"runs": 3,
"shows": 0,
"unsupported": 0,
"sends": 0
},
"steps": [
{
"name": "Daily",
"type": "n8n-nodes-base.scheduleTrigger",
"disposition": "run",
"reason": null,
"needs": null
},
{
"name": "Products",
"type": "n8n-nodes-base.httpRequest",
"disposition": "run",
"reason": null,
"needs": {
"kind": "store",
"target": null
}
}
]
}
}
}{
"success": false,
"contract_version": 2,
"message": "<string>",
"code": "<string>",
"errors": {}
}{
"success": false,
"contract_version": 2,
"message": "<string>",
"code": "<string>",
"errors": {}
}{
"success": false,
"contract_version": 2,
"message": "<string>",
"code": "<string>",
"errors": {}
}{
"success": false,
"contract_version": 2,
"message": "<string>",
"code": "<string>",
"errors": {}
}Authorizations
A bearer token from Login, sent as Authorization: Bearer <token>. Valid for 60 minutes; it acts as the person named at login, within their organisation, and never approves. Rotating or disabling the organisation's API credential ends every token made with it on its next call. See Authentication.
Path Parameters
The import's id. A public id (a ULID).
^[0-9A-HJKMNP-TV-Z]{26}$Was this page helpful?