Get template
curl --request GET \
--url https://automations-api.vortexiq.ai/v1/automations/templates/{templateId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://automations-api.vortexiq.ai/v1/automations/templates/{templateId}"
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/templates/{templateId}', 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/templates/{templateId}",
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/templates/{templateId}"
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/templates/{templateId}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://automations-api.vortexiq.ai/v1/automations/templates/{templateId}")
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": {
"template": {
"id": "shopify-catalogue-quality",
"version": 4,
"platform": "shopify",
"outcome": "run",
"name": "Catalogue quality checklist · Shopify",
"description": "Find missing product descriptions, images, categories, variant SKUs, prices and shipping weights.",
"sentence": "Find missing product descriptions, images, categories, variant SKUs, prices and shipping weights.",
"inputs": [],
"connections": [
"shopify"
],
"reads": [
{
"tier": "catalogue",
"what": "store profile"
},
{
"tier": "catalogue",
"what": "products"
}
],
"writes": [],
"steps": [
{
"n": 1,
"kind": "Reads",
"note": "This operation is imported by the workflow and may be used when it runs.",
"gives": [],
"label": "Read store domain, currency and time zone (Shopify).",
"paged": false,
"title": "Read store domain, currency and time zone (Shopify).",
"checks": [],
"inputs": [],
"on_fail": null,
"connector": "shopify",
"operation": "shopify.starter:shopifyStarterStore"
},
{
"n": 2,
"kind": "Reads",
"note": "This operation is imported by the workflow and may be used when it runs.",
"gives": [],
"label": "Read product descriptions, images and collections (Shopify).",
"paged": false,
"title": "Read product descriptions, images and collections (Shopify).",
"checks": [],
"inputs": [],
"on_fail": null,
"connector": "shopify",
"operation": "shopify.starter:shopifyStarterProducts"
}
],
"result_view": {
"version": 1,
"title": "Product checklist",
"description": "Filter the catalogue issues, open affected products and download the complete work list.",
"collection": "records",
"columns": [
"product",
"sku"
],
"filters": [
"finding",
"findings"
],
"page_size": 25
},
"uses_ai": false,
"has_approval_step": false,
"weight": "ordinary",
"default_schedule": {
"cadence": "manual"
},
"status": "available",
"readiness": {
"ready": true,
"missing": []
},
"records_called": null
},
"kinds": [
{
"kind": "aws",
"role": "store",
"name": "Amazon Web Services",
"noun": "account"
},
{
"kind": "azure",
"role": "store",
"name": "Microsoft Azure",
"noun": "account"
}
]
}
}{
"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 template
One template by id, with its steps, inputs, default schedule and readiness. Answers 404 when no template
has this id.
Needs the automations:read scope.
GET
/
v1
/
automations
/
templates
/
{templateId}
Get template
curl --request GET \
--url https://automations-api.vortexiq.ai/v1/automations/templates/{templateId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://automations-api.vortexiq.ai/v1/automations/templates/{templateId}"
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/templates/{templateId}', 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/templates/{templateId}",
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/templates/{templateId}"
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/templates/{templateId}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://automations-api.vortexiq.ai/v1/automations/templates/{templateId}")
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": {
"template": {
"id": "shopify-catalogue-quality",
"version": 4,
"platform": "shopify",
"outcome": "run",
"name": "Catalogue quality checklist · Shopify",
"description": "Find missing product descriptions, images, categories, variant SKUs, prices and shipping weights.",
"sentence": "Find missing product descriptions, images, categories, variant SKUs, prices and shipping weights.",
"inputs": [],
"connections": [
"shopify"
],
"reads": [
{
"tier": "catalogue",
"what": "store profile"
},
{
"tier": "catalogue",
"what": "products"
}
],
"writes": [],
"steps": [
{
"n": 1,
"kind": "Reads",
"note": "This operation is imported by the workflow and may be used when it runs.",
"gives": [],
"label": "Read store domain, currency and time zone (Shopify).",
"paged": false,
"title": "Read store domain, currency and time zone (Shopify).",
"checks": [],
"inputs": [],
"on_fail": null,
"connector": "shopify",
"operation": "shopify.starter:shopifyStarterStore"
},
{
"n": 2,
"kind": "Reads",
"note": "This operation is imported by the workflow and may be used when it runs.",
"gives": [],
"label": "Read product descriptions, images and collections (Shopify).",
"paged": false,
"title": "Read product descriptions, images and collections (Shopify).",
"checks": [],
"inputs": [],
"on_fail": null,
"connector": "shopify",
"operation": "shopify.starter:shopifyStarterProducts"
}
],
"result_view": {
"version": 1,
"title": "Product checklist",
"description": "Filter the catalogue issues, open affected products and download the complete work list.",
"collection": "records",
"columns": [
"product",
"sku"
],
"filters": [
"finding",
"findings"
],
"page_size": 25
},
"uses_ai": false,
"has_approval_step": false,
"weight": "ordinary",
"default_schedule": {
"cadence": "manual"
},
"status": "available",
"readiness": {
"ready": true,
"missing": []
},
"records_called": null
},
"kinds": [
{
"kind": "aws",
"role": "store",
"name": "Amazon Web Services",
"noun": "account"
},
{
"kind": "azure",
"role": "store",
"name": "Microsoft Azure",
"noun": "account"
}
]
}
}{
"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
bearerAuthapiCredential
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 template's id, such as shopify-catalogue-quality.
Pattern:
^[a-z0-9][a-z0-9-]{1,80}$Was this page helpful?
⌘I