List Agents

GET

https://api.agentphone.ai/v1/agents

GET

/v1/agents

const url = 'https://api.agentphone.ai/v1/agents';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

{
  "data": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "voiceMode": "webhook",
      "voice": "string",
      "createdAt": "2024-01-15T09:30:00Z",
      "enableMessaging": true,
      "modelTier": "balanced",
      "systemPrompt": "string",
      "voicePrompt": "string",
      "beginMessage": "string",
      "transferNumber": "string",
      "customTools": [
        {}
      ],
      "voicemailMessage": "string",
      "callScreeningIdentity": "string",
      "callScreeningPurpose": "string",
      "sttMode": "fast",
      "ambientSound": "none",
      "denoisingMode": "noise-cancellation",
      "maxSilenceMs": 600000,
      "voiceSpeed": 1,
      "interruptionSensitivity": 0.8,
      "enableBackchannel": true,
      "language": "en-US",
      "numbers": [
        {
          "id": "string",
          "phoneNumber": "string",
          "status": "string",
          "type": "sms"
        }
      ]
    }
  ],
  "total": 1
}

List all agents for this account.

Authentication

AuthorizationBearer

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

Query parameters

limitintegerOptional<=100Defaults to 20

offsetintegerOptional0-10000Defaults to 0

Response

Successful Response

datalist of objects

totalinteger

Errors

422

Unprocessable Entity Error

Authentication

Headers

Query parameters

Response

Errors