List automations

Request

curl -X GET 'https://app.mailyte.com/api/v1/automations' \
  -H 'Authorization: Bearer mk_live_YOUR_API_KEY'

const response = await fetch('https://app.mailyte.com/api/v1/automations', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer mk_live_YOUR_API_KEY',
  },
});
const { data } = await response.json();

import requests
response = requests.get(
    "https://app.mailyte.com/api/v1/automations",
    headers={"Authorization": "Bearer mk_live_YOUR_API_KEY"},
)
data = response.json()["data"]

<?php

$response = Http::withToken('mk_live_YOUR_API_KEY')
    ->get('https://app.mailyte.com/api/v1/automations');

$data = $response->json('data');

require "net/http"
require "json"
uri = URI("https://app.mailyte.com/api/v1/automations")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer mk_live_YOUR_API_KEY"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

Response

Success.

• dataobject
  • dataarray<object>
    • idstring
    • namestring
    • statestringdraft | live | paused | archived
    • entry_rulestringonce | every_time | cooldown

      Whether a contact may enter more than once.

    • settingsobject
      • exit_eventsarray<string>

        Event names that end a run early, checked before every step.

      • exitsobject

        The full exit rules: events (with optional property filters), whether unsubscribing exits, and segments whose entry exits.

      • streamstringmarketing | transactional
      • cooldown_hoursinteger
    • graphobject

      The editable draft: {nodes[{id,type,config}], edges[{from,to,branch?}]}. Publishing snapshots it into a version.

    • validationobject
      • okboolean
      • errorsobject

        Problems keyed by node id (nodes.<id>.<field>) or graph/settings.

    • live_versionobject
      • idstring
      • numberinteger
      • published_atstring
    • paused_bystringuser | breaker
    • countsobject
      • in_flightinteger

        Runs that have not finished.

      • completedinteger
      • exitedinteger
      • failedinteger
      • emails_sentinteger

        Emails this automation has actually sent, across every version. Only counted on the list; 0 elsewhere.

    • published_atstring
    • paused_atstring
    • archived_atstring
    • created_atstring
    • updated_atstring
  • pagination_metaany

Returned inside the standard envelope.

Errors

Every status, with what causes it and what to do, is on the error reference.