Get a specific automation by ID
curl --request GET \
--url https://your-instance.example.com/api/automations/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://your-instance.example.com/api/automations/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://your-instance.example.com/api/automations/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://your-instance.example.com/api/automations/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://your-instance.example.com/api/automations/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://your-instance.example.com/api/automations/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://your-instance.example.com/api/automations/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"_id": "64d2f9c5e8a1d4e001a0b1c2",
"name": "Follow-up after 24h",
"description": "Send a follow-up SMS if the lead has not replied in 24h.",
"triggerLogicType": "timer",
"enabled": true
}
}{
"success": false,
"message": "Automation not found"
}Automations
Get a specific automation by ID
Returns a single Automation owned by the caller, enriched with the caller’s per-user enabled preference and SMS notification settings. Empty action arrays are stripped from the response.
GET
/
api
/
automations
/
{id}
Get a specific automation by ID
curl --request GET \
--url https://your-instance.example.com/api/automations/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://your-instance.example.com/api/automations/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://your-instance.example.com/api/automations/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://your-instance.example.com/api/automations/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://your-instance.example.com/api/automations/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://your-instance.example.com/api/automations/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://your-instance.example.com/api/automations/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"_id": "64d2f9c5e8a1d4e001a0b1c2",
"name": "Follow-up after 24h",
"description": "Send a follow-up SMS if the lead has not replied in 24h.",
"triggerLogicType": "timer",
"enabled": true
}
}{
"success": false,
"message": "Automation not found"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Response
Automation returned
Available options:
true An Automation document with two derived per-user fields: enabled (from User.automations[id]) and userSmsNotification (per-user SMS settings).
Show child attributes
Show child attributes
Example:
{
"_id": "64d2f9c5e8a1d4e001a0b1c2",
"name": "Follow-up after 24h",
"description": "Send a follow-up SMS if the lead has not replied in 24h.",
"organizationId": "64a1b2c3d4e5f60012345678",
"userId": "64a1b2c3d4e5f60012345679",
"event": "message.received",
"actions": {
"sendMessage": [
{
"template": "follow-up-24h",
"channel": "sms"
}
]
},
"sourceStatuses": ["New lead"],
"maxTransitions": 3,
"triggerType": "status_change",
"conditions": [
{
"field": "lastInboundDirection",
"op": "eq",
"value": "inbound"
}
],
"triggerLogicType": "timer",
"timerLogic": {
"enabled": true,
"delay": 24,
"unit": "hours"
},
"schedule": { "start": "09:00", "end": "18:00" },
"maxFollowUpCount": 3,
"enabled": true,
"userSmsNotification": {
"enabled": true,
"phoneNumbers": ["+14155551234"],
"message": "New lead pending follow-up."
},
"createdAt": "2026-04-12T14:22:10.000Z",
"updatedAt": "2026-04-22T10:14:00.000Z"
}
⌘I