List All AI Agents in Your Organization

This endpoint returns a paginated list of all AI agents configured in your DeltaLead organization. Each agent record includes its current status, the language it converses in, and the channels it is assigned to handle — giving you a full operational snapshot of your AI workforce at a glance.

Endpoint

GET https://platform-api.deltalead.ai/v1/agents

Query Parameters

integer

default:"20"

Maximum number of agents to return per page. Accepts values between 1 and 100.

string

Pagination cursor returned in the previous response’s pagination.next_cursor field. Omit this parameter to start from the beginning of the list.

string

Filter results by agent status. Accepted values: active, inactive, draft. Omit to return agents of all statuses.

Example Request

cURL

curl https://platform-api.deltalead.ai/v1/agents \
  -H "X-API-Key: YOUR_API_KEY"

Response

array

Array of agent objects matching the query.

Show Agent object fields

string

Unique identifier for the agent, e.g. agent_abc123.

string

ID of the organization this agent belongs to.

string

Display name of the agent, e.g. Martín de Ventas.

string

Current status of the agent: active, inactive, or draft.

string

Language locale the agent uses: es-AR, es-MX, es-CR, es-CO, pt-BR, or en-US.

array

List of channels the agent handles: whatsapp, facebook, instagram, web, email, or phone.

string

ISO 8601 timestamp of when the agent was created.

string

ISO 8601 timestamp of the most recent update to the agent.

object

Pagination metadata for the result set.

Show Pagination fields

integer

The limit value applied to this request.

string | null

Cursor to pass as cursor in your next request to retrieve the following page. null when no further pages exist.

boolean

true if additional pages of results are available.

200 OK

{
  "data": [
    {
      "id": "agent_abc123",
      "organization_id": "org_xyz789",
      "name": "Martín de Ventas",
      "status": "active",
      "language": "es-AR",
      "channels": ["whatsapp", "instagram"],
      "created_at": "2024-01-15T10:00:00Z",
      "updated_at": "2024-10-01T08:30:00Z"
    },
    {
      "id": "agent_def456",
      "organization_id": "org_xyz789",
      "name": "Ana Atención",
      "status": "active",
      "language": "es-CR",
      "channels": ["web", "email"],
      "created_at": "2024-03-20T14:00:00Z",
      "updated_at": "2024-09-15T11:00:00Z"
    }
  ],
  "pagination": {
    "limit": 20,
    "next_cursor": null,
    "has_more": false
  }
}

active agents are currently handling live conversations. inactive agents are paused and will not respond to new messages. draft agents have been created but never published — they have not yet interacted with any leads.

Overview

Leads

Conversations

Agents

Webhooks

List All AI Agents in Your Organization | DeltaLead

Endpoint

Query Parameters

Example Request

Response

​Endpoint

​Query Parameters

​Example Request

​Response

Endpoint

Query Parameters

Example Request

Response