API Reference›Servicing Plane›Voice›List voice agent types

List voice agent types

GEThttps://sandbox.api.lendeasy.ai/v1/servicing/voice-provider/data/workflows/agentsImplementedBearer token ·READ_SERVICING_VOICE_PROVIDER

The provider’s registry of composable voice agent types and their configuration fields, forwarded verbatim. This registry route sits outside the data plane’s /api/v1 tree.

Request

curl https://sandbox.api.lendeasy.ai/v1/servicing/voice-provider/data/workflows/agents \
  -H "Authorization: Bearer $TOKEN" \
  -H "LendEasy-Tenant: $TENANT"

await fetch(`https://sandbox.api.lendeasy.ai/v1/servicing/voice-provider/data/workflows/agents`, {
  method: "GET",
  headers: { Authorization: `Bearer ${token}`, "LendEasy-Tenant": tenant },
});

requests.get(
  f"https://sandbox.api.lendeasy.ai/v1/servicing/voice-provider/data/workflows/agents",
  headers={"Authorization": f"Bearer {token}", "LendEasy-Tenant": tenant},
)

[
  {
    "type_key": "payment_negotiator",
    "label": "Payment negotiator",
    "description": "Negotiates a payment commitment within configured bounds.",
    "category": "conversation",
    "interrupt_eligible_default": false,
    "config_fields": [
      {
        "key": "max_installments",
        "label": "Maximum installments",
        "field_type": "number",
        "scope": "workflow",
        "required": false
      }
    ]
  }
]

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "400",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "validation.msg.validation.errors.exist",
  "errors": []
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "401",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "error.msg.not.authenticated",
  "errors": []
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "403",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "error.msg.not.authorized",
  "errors": []
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "404",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "error.msg.resource.not.found",
  "errors": []
}

Path & query parameters

Field	Type	Description
LendEasy-Tenant required in header	string	Opaque active LendEasy tenant-registry identifier. Supply exactly one instance; no alternate tenant selector is accepted.

Request

curl https://sandbox.api.lendeasy.ai/v1/servicing/voice-provider/data/workflows/agents \
  -H "Authorization: Bearer $TOKEN" \
  -H "LendEasy-Tenant: $TENANT"

await fetch(`https://sandbox.api.lendeasy.ai/v1/servicing/voice-provider/data/workflows/agents`, {
  method: "GET",
  headers: { Authorization: `Bearer ${token}`, "LendEasy-Tenant": tenant },
});

requests.get(
  f"https://sandbox.api.lendeasy.ai/v1/servicing/voice-provider/data/workflows/agents",
  headers={"Authorization": f"Bearer {token}", "LendEasy-Tenant": tenant},
)

[
  {
    "type_key": "payment_negotiator",
    "label": "Payment negotiator",
    "description": "Negotiates a payment commitment within configured bounds.",
    "category": "conversation",
    "interrupt_eligible_default": false,
    "config_fields": [
      {
        "key": "max_installments",
        "label": "Maximum installments",
        "field_type": "number",
        "scope": "workflow",
        "required": false
      }
    ]
  }
]

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "400",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "validation.msg.validation.errors.exist",
  "errors": []
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "401",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "error.msg.not.authenticated",
  "errors": []
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "403",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "error.msg.not.authorized",
  "errors": []
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "404",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "error.msg.resource.not.found",
  "errors": []
}