AI Agent

List agents

get/companies/{company}/agents

Path parameters

companyinteger required

Query parameters

businessUnitIdinteger

querystring

Search by name or creator

templateinteger

Filter by template ID

createdBystring

Filter by creator name

sortBystring

sortDirection'asc' | 'desc'

Response

List of agents

idinteger

externalIdstring

providerstring

namestring nullable

descriptionstring nullable

industrystring nullable

googlePlaceIdstring nullable

voiceIdstring nullable

voiceLanguagestring

additionalLanguagesstring[]

Extra language codes the agent supports beyond its primary voiceLanguage.

languagePresetsobject

Per-language greeting/prompt overrides, keyed by language code.

scheduleIdinteger nullable

callTrainingAnalysisIdinteger nullable

websiteAnalysisIdinteger nullable

enabledboolean

While false the agent answers nothing: numbers and call flows assigned to it fall through to their regular routing.

voicemailFallbackEnabledboolean

transferSummaryEnabledboolean

escalationPolicystring nullable

callerIdentityEnabledboolean

messageCaptureEnabledboolean

callbackCaptureEnabledboolean

callerIdentityFirstMessagestring nullable

voiceSpeednumber float nullable

backgroundMusicSourceId'office1' | 'office2' | 'restaurant' | 'city' | 'typing' nullable

backgroundMusicVolumenumber float nullable

promptstring nullable

firstMessagestring nullable

dynamicVariablesobject nullable

toolIdsstring[] nullable

deployedAtstring date-time nullable

companyIdinteger nullable

businessUnitIdinteger nullable

knowledgeBaseIdsinteger[]

assignmentsCountinteger nullable

answeringCountinteger nullable

Assignments where the agent currently answers; null unless the endpoint computed it.

createdAtstring date-time

updatedAtstring date-time

Example response

[
  {
    "fallbacks": [
      {
        "destination": {
          "value": "nt:12"
        }
      }
    ],
    "schedule": {
      "preset": "custom",
      "timezone": "America/Chicago",
      "timezone_source": "explicit"
    }
  }
]

Changes

No recorded changes to this endpoint across all 1 revision of this API.