List Agents

Retrieve a paginated list of all agents in your organization.

GET /agents2

List agents

cURL

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

200

{
  "data": [
    {
      "id": "agt_abc123",
      "organization_id": "org_xyz",
      "folder_id": null,
      "current_version_number": 1,
      "is_deleted": false,
      "createdAt": "2024-03-01T10:00:00.000Z",
      "updatedAt": "2024-03-01T10:00:00.000Z",
      "timezone": null,
      "current_version": {
        "agent_id": "agt_abc123",
        "number": 1,
        "title": "Customer Support Bot",
        "is_published": true,
        "language": {
          "id": "lang_en_us",
          "details": {
            "name": "English",
            "code": "en-US"
          }
        },
        "conversation_start_type": "agent",
        "allow_interruptions": true,
        "prompts": {
          "prompt_text": "You are a helpful customer support agent for Acme Corp. Assist customers with billing inquiries, order status, and returns.",
          "welcome_message": "Hello! How can I help you today?",
          "node_positions": null,
          "json_output_instructions": null,
          "default_dynamic_variables": null
        },
        "voice": {
          "id": "voice_xyz",
          "model_id": "vmod_abc",
          "settings": {
            "speed": 1,
            "temperature": 0.8,
            "volume": 1,
            "pitch": null,
            "fallback_voices": [],
            "pronunciations": []
          }
        },
        "llm": {
          "id": "llm_gpt4o",
          "settings": {
            "temperature": 0.1,
            "structured_output": true
          },
          "fallback": {
            "fallback_llm_enabled": null,
            "llm_fallback_delay_ms": null,
            "llm_fallback_model": null
          }
        },
        "telephony": {
          "inbound": {
            "id": "phn_abc",
            "details": null
          },
          "outbound": {
            "id": null,
            "details": null
          },
          "call_limits": {
            "end_call_on_silence_sec": 180,
            "max_call_duration_sec": 600,
            "pause_before_speaking_sec": 1.5,
            "ring_duration_sec": 30
          }
        },
        "speech": {
          "background_sound": null,
          "responsiveness": 0.5,
          "interruption_sensitivity": 0.5,
          "backchanneling": false,
          "backchannel_frequency": 0.5,
          "transcription_mode": "optimize_for_speed",
          "denoising_mode": "remove_noise",
          "speech_normalization": false,
          "transcript_formatting": false,
          "transcriber_id": "tr0deepnova3xx",
          "fallback_stt_enabled": false,
          "stt_fallback_transcriber_id": "tr0soniox001xx",
          "stt_fallback_wait_ms": 500,
          "audio_cache_enabled": true
        },
        "reminders": {
          "reminder_message_interval": 10,
          "reminder_message_frequency": 1
        },
        "security": {
          "opt_out_sensitive_data_storage": false,
          "opt_in_secure_urls": false
        },
        "analysis": {
          "postcall_analysis": []
        },
        "functions": [],
        "transcriber_id": "tr0deepnova3xx",
        "fallback_stt_enabled": false,
        "stt_fallback_transcriber_id": "tr0soniox001xx",
        "stt_fallback_wait_ms": 500,
        "audio_cache_enabled": true
      },
      "pipeline_type": "Cascaded"
    }
  ],
  "meta": {
    "page": 1,
    "limit": 20,
    "total": 150,
    "totalPages": 8
  }
}

Returns all agents in your organization, sorted by creation date (newest first). Use this to populate agent selection dropdowns in your dashboard, audit configurations across your team, or sync agent state into your own database.

Query parameters

Parameter	Description
page	Page number, starting from 1.
limit	Results per page (max 100, default 20).
search	Filter agents by name (partial match).

Response

Each agent in the list includes its id, title, voice and LLM configuration, and timestamps. Use the id from this response when triggering calls or creating batch campaigns.

Request

curl "https://api.dialnexa.com/v1/agents2" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response

{
  "data": [
    {
      "id": "agt_k7m2nq9xw4p8",
      "title": "Sales Qualifier",
      "is_published": true,
      "created_at": "2024-03-01T10:00:00.000Z"
    },
    {
      "id": "agt_r3p5tz8vb2qw",
      "title": "Appointment Reminder",
      "is_published": true,
      "created_at": "2024-02-15T08:00:00.000Z"
    }
  ],
  "meta": { "page": 1, "limit": 20, "total": 2 }
}

Authorizations

Authorization · string · header · required

Pass your API key as a Bearer token in the Authorization header.

Query Parameters

page · integer · default: 1

limit · integer · default: 20

Required range: x <= 100

search · string

Filter agents by name.

Response

200 - application/json

Success.

data · object[]

Show child attributes

meta · object

Show child attributes