INinstantly
AIInboxManager

Get an AI Inbox Manager

Changed on

Retrieve a single AI Inbox Manager with its full configuration.

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

get/api/v2/ai-agents/inbox-manager/{id}

Request

  • Base URL
    https://api.instantly.ai
  • URL
    https://api.instantly.ai/api/v2/ai-agents/inbox-manager/{id}
  • Auth
    HTTP bearer

Path parameters

idstring uuid required
Example:0195b1a5-3b1d-7b6e-9c1a-2f7a4b0c1d2e

AI Inbox Manager ID

Query parameters

with_metadataboolean
Example:true

Whether to include additional metadata about the ai agent

Response

The requested AI Inbox Manager

idstring uuid required

Unique identifier for the AI agent

organization_idstring uuid required

Organization ID

namestring required

Name of the AI Agent

type1 | 2 | 3 | 4 | 6 | 7 | 8 | 9 | 10 | 11 nullable

Type of the AI Agent

timestamp_createdstring required

Timestamp when the AI agent was created

timestamp_updatedstring required

Timestamp when the AI agent was updated

status-1 | 0 | 1 required

Status of the AI Agent

is_auto_createdboolean nullable

Whether the AI agent was auto-created

created_bystring uuid nullable

User ID who created the AI agent

descriptionstring nullable

Description of the AI agent

Example response

{
  "id": "01a19e6f-5074-7a90-9d10-535a367c0bf1",
  "organization_id": "01a19e6f-5074-7a90-9d10-535b0a6d005c",
  "name": "Test AI Agent",
  "payload": {
    "configuration_type": 1,
    "tags": [
      "default"
    ],
    "handle_followup": true,
    "respond_to_automatic_emails": true,
    "handle_objections": true,
    "integrations": {
      "slack": {
        "connectionId": "01a19e6f-5074-7a90-9d10-535574c781bc",
        "connectionName": "My Connection"
      }
    },
    "no_show": {
      "enabled": true,
      "max_followups": 3
    },
    "trigger_on_labels": [
      1,
      -1
    ],
    "trigger_on_labels_mode": "include",
    "monthly_credit_budget": 1000,
    "followup_business_days_only": true,
    "followup_delay": 3,
    "followup_delay_unit": "days"
  },
  "type": 1,
  "timestamp_created": "2026-11-02T22:44:17.652Z",
  "timestamp_updated": "2026-11-02T22:44:17.652Z",
  "status": 1,
  "created_by": "01a19e6f-5074-7a90-9d10-535cef352927",
  "description": "Optional agent description",
  "metadata": {
    "tags": {
      "tag-id": {
        "id": "tag-id",
        "label": "Tag Label"
      }
    }
  }
}

Changes