Retrieve an automation run | Resend API (unofficial showcase)

2 parameters

automation_idstringrequired

The UUID of the automation that owns the run.

run_idstringrequired

The UUID of the automation run to retrieve.

1 status code

200Returns the run's identifier, current status, start, completion, and creation dates, plus its step executions in graph order.

objectstringoptional

Type of the response object.

idstringoptional

The ID of the automation run.

statusstringoptional

The current status of the automation run.

Allowed:runningcompletedfailedcancelled

started_atstringoptional

The date and time the run started.

completed_atstringoptional

The date and time the run completed.

created_atstringoptional

The date and time the run was created.

stepsarray<object>optional

The steps executed in this run, sorted in graph order.

Error handling

The automation_id and run_id path parameters must be UUIDs; automation_id must identify an existing automation and run_id an existing run for that 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.runs.get({
  automationId: "9b2f1c10-7a3e-4d54-8c2a-1f6b9e0d4a21",
  runId: "9b2f1c10-7a3e-4d54-8c2a-1f6b9e0d4a21",
});

{
  "object": "automation_run",
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "status": "running",
  "started_at": "2023-10-06 23:47:56.678+00",
  "completed_at": "2023-10-06 23:47:56.678+00",
  "created_at": "2023-10-06 23:47:56.678+00",
  "steps": [
    {
      "key": "example_key_abc123",
      "type": "trigger",
      "status": "active",
      "started_at": "2023-10-06 23:47:56.678+00",
      "completed_at": "2023-10-06 23:47:56.678+00",
      "output": "example_value",
      "error": "example_value",
      "created_at": "2023-10-06 23:47:56.678+00"
    }
  ]
}

Request

Response

Errors