Retrieve an automation | Resend API (unofficial showcase)

1 parameter

automation_idstringrequired

The UUID of the automation to retrieve.

1 status code

200Returns the automation's identifier, name, current status, creation and update dates, and the steps and connections in its active version.

objectstringoptional

Type of the response object.

idstringoptional

The ID of the automation.

namestringoptional

The name of the automation.

statusstringoptional

The current status of the automation.

Allowed:enableddisabled

created_atstringoptional

The date and time the automation was created.

updated_atstringoptional

The date and time the automation was last updated.

stepsarray<object>optional

The steps in the active version of the automation.

connectionsarray<object>optional

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

Error handling

The automation_id path parameter must be a UUID and identify an existing automation.

import { Client } from "@octridev/resend";

const client = new Client({
  baseUrl: "https://api.resend.com",
  auth: { bearer: process.env.API_TOKEN },
});

const result = await client.automations.get({ automationId: "9b2f1c10-7a3e-4d54-8c2a-1f6b9e0d4a21" });

{
  "object": "automation",
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Example Name",
  "status": "enabled",
  "created_at": "2023-10-06 23:47:56.678+00",
  "updated_at": "2023-10-06 23:47:56.678+00",
  "steps": [
    {
      "key": "example_key_abc123",
      "type": "trigger"
    }
  ],
  "connections": [
    {
      "from": "example_value",
      "to": "example_value",
      "type": "default"
    }
  ]
}

Request

Response

Errors