Obter automação

Obtém uma automação com seus triggers e actions

GET /automations/:id

cURL

curl \
-H "Authorization: Bearer API_KEY" \
-X GET https://api.ayrshare.com/api/automations/auto_9xKp2Lm4nQ

const API_KEY = "API_KEY";
const id = "auto_9xKp2Lm4nQ";

fetch(`https://api.ayrshare.com/api/automations/${id}`, {
  method: "GET",
  headers: { "Authorization": `Bearer ${API_KEY}` },
})
  .then((res) => res.json())
  .then((json) => console.log(json))
  .catch(console.error);

import requests

headers = {"Authorization": "Bearer API_KEY"}
automation_id = "auto_9xKp2Lm4nQ"

r = requests.get(
    f"https://api.ayrshare.com/api/automations/{automation_id}",
    headers=headers,
)

print(r.json())

$id = "auto_9xKp2Lm4nQ";
$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => "https://api.ayrshare.com/api/automations/" . $id,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => ["Authorization: Bearer API_KEY"],
]);

$response = curl_exec($curl);
curl_close($curl);
echo $response;

200: Success

{
  "status": "success",
  "id": "auto_9xKp2Lm4nQ",
  "platform": "instagram",
  "accountId": "17841400000000000",
  "name": "Spring promo",
  "description": "",
  "active": true,
  "stats": {
    "totalSent": 42,
    "totalFailed": 1,
    "lastTriggeredAt": "2026-05-12T09:14:22.000Z",
    "lastSentAt": "2026-05-12T09:14:48.000Z"
  },
  "created": "2026-04-30T12:00:00.000Z",
  "updated": "2026-05-12T09:14:48.000Z",
  "triggers": [
    {
      "id": "trg_a1b2c3",
      "type": "comment_keyword",
      "active": true,
      "config": {
        "postId": "17895695668004550",
        "keywords": ["INFO", "LINK"]
      }
    }
  ],
  "actions": [
    {
      "id": "act_d4e5f6",
      "type": "send_dm",
      "active": true,
      "config": {
        "message": "Hey {{recipient_username}}, here is the link you wanted: https://example.com"
      }
    }
  ]
}

{
  "action": "automation",
  "status": "error",
  "code": 469,
  "message": "Automation not found"
}

Beta. Consulte a visão geral de Automations para a descrição completa do recurso.

Retorna uma automação incluindo todos os triggers e actions anexados. Automações soft-deleted retornam 469, para que um atacante sondando IDs receba a mesma resposta que um “não encontrado” legítimo.

​

Parâmetros de cabeçalho

​

Parâmetros de caminho

id · string · obrigatório

O ID da automação retornado por POST /automations.

cURL

curl \
-H "Authorization: Bearer API_KEY" \
-X GET https://api.ayrshare.com/api/automations/auto_9xKp2Lm4nQ

const API_KEY = "API_KEY";
const id = "auto_9xKp2Lm4nQ";

fetch(`https://api.ayrshare.com/api/automations/${id}`, {
  method: "GET",
  headers: { "Authorization": `Bearer ${API_KEY}` },
})
  .then((res) => res.json())
  .then((json) => console.log(json))
  .catch(console.error);

import requests

headers = {"Authorization": "Bearer API_KEY"}
automation_id = "auto_9xKp2Lm4nQ"

r = requests.get(
    f"https://api.ayrshare.com/api/automations/{automation_id}",
    headers=headers,
)

print(r.json())

$id = "auto_9xKp2Lm4nQ";
$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => "https://api.ayrshare.com/api/automations/" . $id,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => ["Authorization: Bearer API_KEY"],
]);

$response = curl_exec($curl);
curl_close($curl);
echo $response;

200: Success

{
  "status": "success",
  "id": "auto_9xKp2Lm4nQ",
  "platform": "instagram",
  "accountId": "17841400000000000",
  "name": "Spring promo",
  "description": "",
  "active": true,
  "stats": {
    "totalSent": 42,
    "totalFailed": 1,
    "lastTriggeredAt": "2026-05-12T09:14:22.000Z",
    "lastSentAt": "2026-05-12T09:14:48.000Z"
  },
  "created": "2026-04-30T12:00:00.000Z",
  "updated": "2026-05-12T09:14:48.000Z",
  "triggers": [
    {
      "id": "trg_a1b2c3",
      "type": "comment_keyword",
      "active": true,
      "config": {
        "postId": "17895695668004550",
        "keywords": ["INFO", "LINK"]
      }
    }
  ],
  "actions": [
    {
      "id": "act_d4e5f6",
      "type": "send_dm",
      "active": true,
      "config": {
        "message": "Hey {{recipient_username}}, here is the link you wanted: https://example.com"
      }
    }
  ]
}

{
  "action": "automation",
  "status": "error",
  "code": 469,
  "message": "Automation not found"
}