Get Agent Details

GET

agents

{id}

Get Agent Details

curl --request GET \
  --url https://api.dialnexa.com/v1/agents/{id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.dialnexa.com/v1/agents/{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.dialnexa.com/v1/agents/{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.dialnexa.com/v1/agents/{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))

}

require 'uri'
require 'net/http'

url = URI("https://api.dialnexa.com/v1/agents/{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,
  "error": false,
  "statusCode": 200,
  "message": "Success",
  "data": {
    "id": "agent_2g7Xy3tY53gRlp",
    "folder_id": null,
    "current_version_number": "0",
    "timezone": "Asia/Kolkata",
    "agent_type": "Single_Prompt_Agent",
    "pipeline_type": "Cascaded",
    "webhook_id": null,
    "current_version": {
      "agent_id": "agent_2g7Xy3tY53gRlp",
      "version_number": "0",
      "version_title": "Version 0",
      "title": "Customer Support Agent",
      "is_published": false,
      "language_id": "lang_en_in",
      "voice_id": "voice_abc123",
      "llm_id": "llm_A1B2C3D4E5F6G7",
      "transcriber_id": "trs_deepgram_nova_2",
      "fallback_stt_enabled": true,
      "stt_fallback_transcriber_id": "trs_soniox"
    },
    "versions": [
      {
        "agent_id": "agent_2g7Xy3tY53gRlp",
        "version_number": "0",
        "version_title": "Version 0",
        "title": "Customer Support Agent",
        "is_published": false,
        "language_id": "lang_en_in",
        "voice_id": "voice_abc123",
        "llm_id": "llm_A1B2C3D4E5F6G7",
        "transcriber_id": "trs_deepgram_nova_2",
        "fallback_stt_enabled": true,
        "stt_fallback_transcriber_id": "trs_soniox"
      }
    ],
    "inbound_phone_numbers": [],
    "outbound_phone_numbers": [
      {
        "id": "phn_abc123",
        "phone_number": "9876543210",
        "country_iso": "91",
        "nickname": "Support line",
        "sip_trunk_enabled": false,
        "linked_at": "2026-09-30T06:00:00.000Z"
      }
    ]
  },
  "timestamp": "2026-09-07T06:00:00.000Z"
}

{
  "statusCode": 401,
  "error": true,
  "success": false,
  "data": [],
  "message": "Invalid API key",
  "errors": []
}

{
  "statusCode": 404,
  "error": true,
  "success": false,
  "data": [],
  "message": "Agent with ID 2g7Xy3tY53gRlp not found",
  "errors": []
}

{
  "statusCode": 500,
  "error": true,
  "success": false,
  "data": [],
  "message": "Failed to fetch agent: Internal server error",
  "errors": []
}

Read only Fetch one agent by its id. The request is scoped to the authenticated organization automatically. The response includes the agent’s versions, so this is the endpoint to call when you need the full configuration rather than a list summary.

When to use this

Before an update: fetch the current configuration and version numbers, then send only the changed fields to Update Agent.
Config review: confirm which version is published and what prompt, voice, and LLM it uses before routing production calls to it.
Syncing: mirror agent configuration into your own admin UI or configuration store.

The response also carries inbound_phone_numbers and outbound_phone_numbers: the numbers linked to the agent, up to three per direction. Every version uses them. Manage them with Attach Agent Phone Number and Detach Agent Phone Number. Responses can include additional fields not listed here; you can ignore them. If the agent does not exist or belongs to another organization, the API returns 404 Not Found. See API errors for the standard error format.

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

string

required

Agent ID

Example:

"agent_2g7Xy3tY53gRlp"

Response

Agent returned with all versions and embedded agent_functions.

success

enum<boolean>

required

Available options:

true

error

enum<boolean>

required

Available options:

false

statusCode

integer

required

Example:

200

message

string

required

Example:

"Success"

data

object

required

An agent as stored. Returned by the list and get endpoints.

Show child attributes

timestamp

string<date-time>

required

Get Agent Details

curl --request GET \
  --url https://api.dialnexa.com/v1/agents/{id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.dialnexa.com/v1/agents/{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.dialnexa.com/v1/agents/{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.dialnexa.com/v1/agents/{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))

}

require 'uri'
require 'net/http'

url = URI("https://api.dialnexa.com/v1/agents/{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,
  "error": false,
  "statusCode": 200,
  "message": "Success",
  "data": {
    "id": "agent_2g7Xy3tY53gRlp",
    "folder_id": null,
    "current_version_number": "0",
    "timezone": "Asia/Kolkata",
    "agent_type": "Single_Prompt_Agent",
    "pipeline_type": "Cascaded",
    "webhook_id": null,
    "current_version": {
      "agent_id": "agent_2g7Xy3tY53gRlp",
      "version_number": "0",
      "version_title": "Version 0",
      "title": "Customer Support Agent",
      "is_published": false,
      "language_id": "lang_en_in",
      "voice_id": "voice_abc123",
      "llm_id": "llm_A1B2C3D4E5F6G7",
      "transcriber_id": "trs_deepgram_nova_2",
      "fallback_stt_enabled": true,
      "stt_fallback_transcriber_id": "trs_soniox"
    },
    "versions": [
      {
        "agent_id": "agent_2g7Xy3tY53gRlp",
        "version_number": "0",
        "version_title": "Version 0",
        "title": "Customer Support Agent",
        "is_published": false,
        "language_id": "lang_en_in",
        "voice_id": "voice_abc123",
        "llm_id": "llm_A1B2C3D4E5F6G7",
        "transcriber_id": "trs_deepgram_nova_2",
        "fallback_stt_enabled": true,
        "stt_fallback_transcriber_id": "trs_soniox"
      }
    ],
    "inbound_phone_numbers": [],
    "outbound_phone_numbers": [
      {
        "id": "phn_abc123",
        "phone_number": "9876543210",
        "country_iso": "91",
        "nickname": "Support line",
        "sip_trunk_enabled": false,
        "linked_at": "2026-09-30T06:00:00.000Z"
      }
    ]
  },
  "timestamp": "2026-09-07T06:00:00.000Z"
}

{
  "statusCode": 401,
  "error": true,
  "success": false,
  "data": [],
  "message": "Invalid API key",
  "errors": []
}

{
  "statusCode": 404,
  "error": true,
  "success": false,
  "data": [],
  "message": "Agent with ID 2g7Xy3tY53gRlp not found",
  "errors": []
}

{
  "statusCode": 500,
  "error": true,
  "success": false,
  "data": [],
  "message": "Failed to fetch agent: Internal server error",
  "errors": []
}

Overview

Endpoints

When to use this

Authorizations

Path Parameters

Response

​When to use this

Authorizations

Path Parameters

Response

When to use this