Get an Agent
curl --request GET \
--url https://api.getnexor.ai/api/public/workflows/{id} \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.getnexor.ai/api/public/workflows/{id}"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.getnexor.ai/api/public/workflows/{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.getnexor.ai/api/public/workflows/{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 => [
"X-API-Key: <api-key>"
],
]);
$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.getnexor.ai/api/public/workflows/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
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.getnexor.ai/api/public/workflows/{id}")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getnexor.ai/api/public/workflows/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"workflow": {
"fields": [
{
"key": "<string>",
"label": "<string>",
"type": "text",
"required": false,
"options": [
"<string>"
],
"extraction_hints": "<string>",
"sort_order": 123,
"metadata_key": "<string>",
"intake_value_map": {}
}
],
"channel_prompts": {},
"prompt_sha256": "<string>"
}
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>",
"code": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>",
"code": "<string>"
}Get an Agent
This operation lets you get an agent for the authenticated Nexor account. This reference documents verified path, query, and top-level JSON body fields, observed response status codes, and top-level response fields. Provider-owned or deeply nested response shapes may remain open.
GET
/
workflows
/
{id}
Get an Agent
curl --request GET \
--url https://api.getnexor.ai/api/public/workflows/{id} \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.getnexor.ai/api/public/workflows/{id}"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.getnexor.ai/api/public/workflows/{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.getnexor.ai/api/public/workflows/{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 => [
"X-API-Key: <api-key>"
],
]);
$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.getnexor.ai/api/public/workflows/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
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.getnexor.ai/api/public/workflows/{id}")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getnexor.ai/api/public/workflows/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"workflow": {
"fields": [
{
"key": "<string>",
"label": "<string>",
"type": "text",
"required": false,
"options": [
"<string>"
],
"extraction_hints": "<string>",
"sort_order": 123,
"metadata_key": "<string>",
"intake_value_map": {}
}
],
"channel_prompts": {},
"prompt_sha256": "<string>"
}
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>",
"code": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>",
"code": "<string>"
}GET
See Authentication.
/workflows/:id
Fetch one agent’s full tree: base config, funnel statuses, custom fields, and custom tools.
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string (uuid) | Yes | Agent ID |
Responses
200 — Successful response
{
"workflow": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "Sales Agent",
"description": "Qualifies inbound leads and books demo calls",
"goal_type": "appointment",
"global_prompt": "You are Iris, a friendly sales rep for Acme...",
"channel_prompts": {
"whatsapp": "Keep each message to two short lines..."
},
"prompt_sha256": "7e0225eb7915dc01ec70a8c3dc75a543ee568c202c23d2b93d598aa73008d917",
"is_paused": false,
"is_active": true,
"timezone": "America/Santiago",
"created_at": "2026-01-15T09:00:00Z",
"updated_at": "2026-02-01T12:00:00Z",
"statuses": [
{ "key": "new", "label": "New", "category": "active", "is_initial": true, "is_terminal": false, "sort_order": 0 },
{ "key": "won", "label": "Won", "category": "won", "is_initial": false, "is_terminal": true, "sort_order": 1 }
],
"fields": [
{
"key": "employee_count",
"label": "Employee count",
"type": "number",
"required": false,
"metadata_key": "company.employee_count",
"intake_value_map": { "unknown": "0" }
}
],
"tools": [
{ "name": "check_availability", "is_active": true }
]
}
}
Response Fields — Workflow
| Field | Type | Description |
|---|---|---|
id | string (uuid) | Agent identifier |
name | string | Agent name |
description | string | null | Agent description |
goal_type | string | See Create Agent for valid values |
global_prompt | string | The base prompt |
prompt_sha256 | string | SHA-256 (lowercase hex) of the UTF-8 bytes of global_prompt; an agent with no prompt hashes as the empty string. Send it as expected_prompt_sha256 in Set Agent Prompt so the write fails instead of overwriting a newer prompt |
channel_prompts | object | null | Per-channel prompts keyed by channel name (for example whatsapp or email). Empty or null when the agent has none. Read it before you replace a channel prompt with Set an Agent Channel Prompt |
is_paused | boolean | Whether the agent is currently paused |
inbound_only | boolean | Reply-only switch: true when the agent never initiates contact and only answers inbound messages |
is_active | boolean | Whether the agent is active (vs. archived) |
timezone | string | IANA timezone used for cadence scheduling |
statuses | array | Funnel statuses, ordered by sort_order |
fields | array | Custom lead fields this agent collects. Each field returns metadata_key and intake_value_map; either can be null when metadata prefill is not configured |
tools | array | Custom tools this agent can call, with name and is_active only — see List Workflow Tools for full detail |
401 — Authentication error
See Authentication.
404 — Not found
{
"error": "Not found",
"message": "Workflow not found"
}
500 — Internal server error
Authorizations
API key for authentication. Keys are prefixed with nxr_live_.
Path Parameters
Workflow identifier.
Response
Successful response.
Complete tenant-scoped workflow tree returned by getWorkflowTree.
Show child attributes
Show child attributes
Last modified on October 13, 2026
⌘I