Skip to main content
GET
/
v1
/
agents
/
List All Agents
curl --request GET \
  --url https://api.nedzo.ai/v1/agents/ \
  --header 'Authorization: Bearer <token>'
{
  "status_code": 123,
  "message": "<string>",
  "data": {
    "agents": [
      {
        "name": "<string>",
        "language": "English",
        "phone_number_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "phone_number_option": "Shared US phone collection",
        "voice": "Joseph (English)",
        "background_sound": true,
        "description": "<string>",
        "first_message": "<string>",
        "ivr_navigation": true,
        "prompt": "<string>",
        "transfer_phone_number": "<string>",
        "transfer_sentence": "<string>",
        "leave_voicemail_message": true,
        "voicemail_message": "<string>",
        "webhook_url": "<string>",
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "total_dials": 123,
        "total_outcomes": 123,
        "total_seconds": 123
      }
    ],
    "skip": 123,
    "limit": 123,
    "totalCount": 123
  }
}

Authorizations

Authorization
string
header
required

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

Query Parameters

keyword
string | null
skip
integer
default:0
limit
integer
default:20

Response

Successful Response

status_code
integer
required
message
string
required
data
object | null