INinstantly
EngageItem

List AI agent items

Changed on

Requires one of the following scopes: all:read, all:all

get/api/v2/agent-items

Request

  • Base URL
    https://api.instantly.ai
  • URL
    https://api.instantly.ai/api/v2/agent-items
  • Auth
    HTTP bearer

Query parameters

limitinteger
Example:10

The number of items to return

starting_afterstring
Example:01956fbd-0eb1-72db-a565-82977a586084

The ID of the last item in the previous page - used for pagination. You can use the value of the next_starting_after field from the previous response.

typestring
Example:ai_agent,automation

Comma-separated item types: ai_agent, automation

statusstring
Example:Active,Paused

Comma-separated status values: Active, Paused, Draft, Error

ai_agent_type1 | 2 | 3 | 4 | 7 | 8 | 9 | 10 | 6 | 11
Example:2

Filter by agent sub-type. Implies type=ai_agent — automations have no sub-type.

searchstring
Example:My Agent

Text search on agent name

Response

The list of Engage Item

next_starting_afterstring

The filter for getting the next items after this one, this could either be a UUID, a timestamp, on an email depending on the specific API

Example response

{
  "items": [
    {
      "resource_id": "01a19e6e-283d-71a7-bce1-00657bfae3cd",
      "type": "campaign",
      "workspace_id": "01a19e6e-283d-71a7-bce1-006628f8d705",
      "name": "My Campaign",
      "status": "Draft",
      "metadata": {
        "original_status": 1,
        "ai_agent_type": 2,
        "pause_reason": "out_of_credits"
      },
      "timestamp_created": "2026-11-02T22:43:01.821Z",
      "timestamp_updated": "2026-11-02T22:43:01.821Z",
      "tags": [
        {
          "id": "01a19e6e-283d-71a7-bce1-006750d0031c",
          "label": "Q3 outbound"
        }
      ]
    }
  ],
  "next_starting_after": "01a19e6e-647a-7916-be5b-f1c186d866a4"
}

Changes