Get automation by ID
curl --request GET \
--url https://api.stardex.ai/v1/automations/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.stardex.ai/v1/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://api.stardex.ai/v1/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://api.stardex.ai/v1/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://api.stardex.ai/v1/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://api.stardex.ai/v1/automations/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.stardex.ai/v1/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": "aaa11111-bbbb-cccc-dddd-eeeeeeee2222",
"name": "Email owner when a candidate is rejected",
"is_enabled": true,
"is_archived": false,
"runs_on_api_changes": false,
"created_by": "567e8901-e23c-45d6-e789-012345678901",
"trigger": {
"type": "candidate_status_changed",
"pipeline_stage_ids": [
"123e4567-e89b-12d3-a456-426614174000"
],
"match_rejection_stages": true
},
"actions": [
{
"id": "aaa11111-bbbb-cccc-dddd-eeeeeeee2223",
"position": 1,
"action_type": "send_email",
"recipient_type": "candidate",
"team_member_id": null,
"payload": {
"subject": "Your application for {{job_name}}",
"body": "Hi {{candidate_first_name}},\n\nThank you for your time on the {{job_name}} search.\n\nBest,\n{{search_owner}}",
"sender": {
"kind": "mailbox",
"nylas_grant_id": "8b3f4e5d-6c7a-4182-9c9d-0e1f2a3b4c5d"
},
"include_signature": true
}
},
{
"id": "aaa11111-bbbb-cccc-dddd-eeeeeeee2228",
"position": 2,
"action_type": "send_email",
"recipient_type": "team_members",
"team_member_id": null,
"payload": {
"subject": "{{candidate_name}} was rejected on {{job_name}}",
"body": "{{candidate_name}} moved to {{stage_name}} on {{job_name}}.",
"team_member_ids": [
"567e8901-e23c-45d6-e789-012345678901"
],
"email_addresses": [
"finance@yourfirm.com"
]
}
},
{
"id": "aaa11111-bbbb-cccc-dddd-eeeeeeee2226",
"position": 3,
"action_type": "delay",
"payload": {
"amount": 2,
"unit": "days"
}
},
{
"id": "aaa11111-bbbb-cccc-dddd-eeeeeeee2224",
"position": 4,
"action_type": "add_note",
"team_member_id": "567e8901-e23c-45d6-e789-012345678901",
"payload": {
"content": "Rejected by automation — review before closing the loop."
}
},
{
"id": "aaa11111-bbbb-cccc-dddd-eeeeeeee2225",
"position": 5,
"action_type": "agent_instructions",
"payload": {
"instructions": "Summarize why this candidate was rejected."
}
},
{
"id": "aaa11111-bbbb-cccc-dddd-eeeeeeee2227",
"position": 6,
"action_type": "create_task",
"assignee_type": "job_owner",
"team_member_id": null,
"payload": {
"content": "Call {{candidate_name}} with feedback on {{job_name}}",
"task_type": "call",
"due_in_days": 1
}
}
],
"created_at": "2026-08-21T10:00:00Z",
"updated_at": "2026-08-21T10:00:00Z"
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>"
}
}Automations
Get automation by ID
Retrieve one automation, including its trigger and ordered actions. Archived automations are still returned by ID.
GET
/
v1
/
automations
/
{id}
Get automation by ID
curl --request GET \
--url https://api.stardex.ai/v1/automations/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.stardex.ai/v1/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://api.stardex.ai/v1/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://api.stardex.ai/v1/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://api.stardex.ai/v1/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://api.stardex.ai/v1/automations/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.stardex.ai/v1/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": "aaa11111-bbbb-cccc-dddd-eeeeeeee2222",
"name": "Email owner when a candidate is rejected",
"is_enabled": true,
"is_archived": false,
"runs_on_api_changes": false,
"created_by": "567e8901-e23c-45d6-e789-012345678901",
"trigger": {
"type": "candidate_status_changed",
"pipeline_stage_ids": [
"123e4567-e89b-12d3-a456-426614174000"
],
"match_rejection_stages": true
},
"actions": [
{
"id": "aaa11111-bbbb-cccc-dddd-eeeeeeee2223",
"position": 1,
"action_type": "send_email",
"recipient_type": "candidate",
"team_member_id": null,
"payload": {
"subject": "Your application for {{job_name}}",
"body": "Hi {{candidate_first_name}},\n\nThank you for your time on the {{job_name}} search.\n\nBest,\n{{search_owner}}",
"sender": {
"kind": "mailbox",
"nylas_grant_id": "8b3f4e5d-6c7a-4182-9c9d-0e1f2a3b4c5d"
},
"include_signature": true
}
},
{
"id": "aaa11111-bbbb-cccc-dddd-eeeeeeee2228",
"position": 2,
"action_type": "send_email",
"recipient_type": "team_members",
"team_member_id": null,
"payload": {
"subject": "{{candidate_name}} was rejected on {{job_name}}",
"body": "{{candidate_name}} moved to {{stage_name}} on {{job_name}}.",
"team_member_ids": [
"567e8901-e23c-45d6-e789-012345678901"
],
"email_addresses": [
"finance@yourfirm.com"
]
}
},
{
"id": "aaa11111-bbbb-cccc-dddd-eeeeeeee2226",
"position": 3,
"action_type": "delay",
"payload": {
"amount": 2,
"unit": "days"
}
},
{
"id": "aaa11111-bbbb-cccc-dddd-eeeeeeee2224",
"position": 4,
"action_type": "add_note",
"team_member_id": "567e8901-e23c-45d6-e789-012345678901",
"payload": {
"content": "Rejected by automation — review before closing the loop."
}
},
{
"id": "aaa11111-bbbb-cccc-dddd-eeeeeeee2225",
"position": 5,
"action_type": "agent_instructions",
"payload": {
"instructions": "Summarize why this candidate was rejected."
}
},
{
"id": "aaa11111-bbbb-cccc-dddd-eeeeeeee2227",
"position": 6,
"action_type": "create_task",
"assignee_type": "job_owner",
"team_member_id": null,
"payload": {
"content": "Call {{candidate_name}} with feedback on {{job_name}}",
"task_type": "call",
"due_in_days": 1
}
}
],
"created_at": "2026-08-21T10:00:00Z",
"updated_at": "2026-08-21T10:00:00Z"
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>"
}
}Was this page helpful?