List Agents

GET

agents

List Agents

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

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

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

	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")

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": {
    "agents": [
      {
        "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"
          }
        ]
      }
    ]
  },
  "timestamp": "2026-09-07T06:00:00.000Z"
}

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

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

Read only Return the agents that belong to the authenticated organization. Use this to populate a picker in your own UI or to find an agent’s id before fetching or updating it.

When to use this

Agent pickers: populate a dropdown of available agents in your own tooling.
ID lookup: find an agent’s id by title before calling Get Agent Details or Update Agent.
Inventory checks: audit which agents exist in a workspace, for example before cleaning up unused ones with Delete Agent.

The response places records in data.agents without pagination metadata; the full list is returned in one response. Each agent carries all of its versions, but not its functions or phone numbers: fetch one agent with Get Agent Details for those. See API pagination for how each list endpoint shapes its response. Responses can include additional fields not listed here; you can ignore them.

Authorizations

Authorization

string

header

required

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

Response

Agents returned successfully.

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

Show child attributes

timestamp

string<date-time>

required

List Agents

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

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

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

	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")

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": {
    "agents": [
      {
        "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"
          }
        ]
      }
    ]
  },
  "timestamp": "2026-09-07T06:00:00.000Z"
}

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

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

Overview

Endpoints

When to use this

Authorizations

Response

​When to use this

Authorizations

Response

When to use this