List coming runs

curl --request GET \
  --url https://automations-api.vortexiq.ai/v1/automations/occurrences \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://automations-api.vortexiq.ai/v1/automations/occurrences"

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/occurrences', 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/occurrences",
  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/occurrences"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://automations-api.vortexiq.ai/v1/automations/occurrences")

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": {
    "occurrences": [
      {
        "automation_id": "01M51XBN46TASJ8NG9MA26GVKJ",
        "automation_name": "Low-stock and sold-out watch · Shopify",
        "automation_version": 1,
        "timezone": "Europe/London",
        "slot_at": "2026-10-19T06:00:00.000Z",
        "run_at": "2026-10-19T06:00:00.000Z",
        "state": "pending",
        "reason": null,
        "run_id": null,
        "run_status": null,
        "moved_from": null,
        "version": 1,
        "projected": false
      },
      {
        "automation_id": "01M520GSDQH5TQ3CAAQ584TTKH",
        "automation_name": "Weekly catalogue check",
        "automation_version": 2,
        "timezone": "Europe/London",
        "slot_at": "2026-10-19T06:00:00.000Z",
        "run_at": "2026-10-19T06:02:00.000Z",
        "state": "pending",
        "reason": null,
        "run_id": null,
        "run_status": null,
        "moved_from": null,
        "version": 1,
        "projected": false
      }
    ]
  }
}

{
  "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": {}
}

List coming runs

The coming runs of your automations between from and to, at most 62 days apart, as a calendar shows them: each with its run_at, its state (pending, queued or skipped) and its version. Pass automation_id for one automation’s.

Runs further ahead are worked out from the schedule (projected: true): you can move one (with occurrence_version: 0), and skip it once it comes closer. Past runs are in List runs.

Needs the automations:read scope.

GET

automations

occurrences

List coming runs

curl --request GET \
  --url https://automations-api.vortexiq.ai/v1/automations/occurrences \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://automations-api.vortexiq.ai/v1/automations/occurrences"

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/occurrences', 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/occurrences",
  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/occurrences"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://automations-api.vortexiq.ai/v1/automations/occurrences")

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": {
    "occurrences": [
      {
        "automation_id": "01M51XBN46TASJ8NG9MA26GVKJ",
        "automation_name": "Low-stock and sold-out watch · Shopify",
        "automation_version": 1,
        "timezone": "Europe/London",
        "slot_at": "2026-10-19T06:00:00.000Z",
        "run_at": "2026-10-19T06:00:00.000Z",
        "state": "pending",
        "reason": null,
        "run_id": null,
        "run_status": null,
        "moved_from": null,
        "version": 1,
        "projected": false
      },
      {
        "automation_id": "01M520GSDQH5TQ3CAAQ584TTKH",
        "automation_name": "Weekly catalogue check",
        "automation_version": 2,
        "timezone": "Europe/London",
        "slot_at": "2026-10-19T06:00:00.000Z",
        "run_at": "2026-10-19T06:02:00.000Z",
        "state": "pending",
        "reason": null,
        "run_id": null,
        "run_status": null,
        "moved_from": null,
        "version": 1,
        "projected": false
      }
    ]
  }
}

{
  "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

Authorization

string

header

required

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.

Query Parameters

from

string<date-time>

required

The start of the period (ISO 8601). A time in UTC (ISO 8601).

string<date-time>

required

The end of the period (ISO 8601), at most 62 days after from. A time in UTC (ISO 8601).

automation_id

string

Only this automation's coming runs. A public id (a ULID).

Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$

Response

The coming runs in the period, by the time they will really run.

success

boolean

required

contract_version

integer

required

The version of the API this answer follows. It changes only for a breaking change.

Required range: x >= 1

data

object

required

Show child attributes

Choose your outcome

Get Started

The AI OS

List coming runs

Authorizations

Query Parameters

Response