Retrieve a single automation

GET/automations/{automation_id}Retrieve a single automation

Parameters

automation_idstring · uuidpathrequired

The ID of the automation.

Responses

objectAutomation

connectionsarray of object

The connections between steps in the active version of the automation.

Show child attributes

Show array items

A connection between two steps in the automation graph.

fromstringrequired

The `key` of the source step.

tostringrequired

The `key` of the target step.

typestring

The type of connection. Defaults to `default`.

one of "default", "condition_met", "condition_not_met", "timeout", "event_received" · default "default"

created_atstring

The date and time the automation was created.

idstring

The ID of the automation.

namestring

The name of the automation.

objectstring

Type of the response object.

statusstring

The current status of the automation.

one of "enabled", "disabled"

stepsarray of object

The steps in the active version of the automation.

Show child attributes

Show array items

A step as returned when retrieving an automation.

configobject

Configuration for the step. Shape depends on `type`. For `delay` steps, config contains `{ duration: string }` with a human-readable duration (e.g. `"30 minutes"`). For `wait_for_event` steps, config contains `{ event_name: string, timeout?: string, filter_rule?: object }` where `timeout` is a human-readable duration.

keystring

The unique key of this step within the automation graph.

typestring

The type of automation step.

one of "trigger", "send_email", "delay", "wait_for_event", "condition", "contact_update", "contact_delete", "add_to_segment"

updated_atstring

The date and time the automation was last updated.

Example response

{
  "connections": [
    {
      "from": "string",
      "to": "string",
      "type": "default"
    }
  ],
  "created_at": "string",
  "id": "string",
  "name": "string",
  "object": "automation",
  "status": "disabled",
  "steps": [
    {
      "config": {},
      "key": "string",
      "type": "add_to_segment"
    }
  ],
  "updated_at": "string"
}

Examples

automation_idrequiredpath parameter

curl -X GET 'https://api.resend.com/automations/00000000-0000-0000-0000-000000000000'

const response = await fetch('https://api.resend.com/automations/00000000-0000-0000-0000-000000000000', { method: 'GET' });
const data = await response.json();

const response = await fetch('https://api.resend.com/automations/00000000-0000-0000-0000-000000000000', { method: 'GET' });
console.log(await response.json());

import requests

response = requests.request("GET", "https://api.resend.com/automations/00000000-0000-0000-0000-000000000000")
print(response.json())

package main

import (
	"context"
	"net/http"
)

func main() {
	ctx := context.Background()
	req, err := http.NewRequestWithContext(ctx, "GET", "https://api.resend.com/automations/00000000-0000-0000-0000-000000000000", nil)
	if err != nil {
		panic(err)
	}
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
}

<?php
$request = curl_init("https://api.resend.com/automations/00000000-0000-0000-0000-000000000000");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "GET");
$response = curl_exec($request);
curl_close($request);

var request = HttpRequest.newBuilder(URI.create("https://api.resend.com/automations/00000000-0000-0000-0000-000000000000"))
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("https://api.resend.com/automations/00000000-0000-0000-0000-000000000000")
request = Net::HTTPGenericRequest.new("GET", false, true, uri)
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Get, "https://api.resend.com/automations/00000000-0000-0000-0000-000000000000");
using var response = await client.SendAsync(request);

{
  "connections": [
    {
      "from": "string",
      "to": "string",
      "type": "default"
    }
  ],
  "created_at": "string",
  "id": "string",
  "name": "string",
  "object": "automation",
  "status": "disabled",
  "steps": [
    {
      "config": {},
      "key": "string",
      "type": "add_to_segment"
    }
  ],
  "updated_at": "string"
}

Search documentation

Emails

Domains

Audiences

Contacts

Receiving Emails

Webhooks

Templates

Broadcasts

Segments

Topics

Contact Properties

Logs

Automations

Events

API keys