MCP is live.Set up
OmniDimension
Agents

List agents

Retrieve all agents for the authenticated user with pagination support.

GET/agents
Query parameters
pagenointeger

Page number for pagination.

pagesizeinteger

Number of items per page (max 150).

namestring

Filter agents whose name matches this substring (case-insensitive).

curl -X GET 'https://backend.omnidim.io/api/v1/agents?pageno=1&pagesize=30' \
  -H 'Authorization: Bearer YOUR_API_KEY'
Example response
{
  "bots": [
    {
      "id": 6342,
      "name": "Customer Support Agent",
      "bot_type": "prompt",
      "user_name": "Demo User",
      "user_id": 1234,
      "bot_action_name": false,
      "language": [
        "English"
      ],
      "voice": "cgSgspJ2msm6clMCkdW9",
      "voice_provider": "deepgram",
      "voice_external_id": "aura-asteria-en",
      "eleven_lab_voice_public_owner_id": false,
      "english_voice_accent": "en-IN",
      "voice_name": "asteria",
      "llm_service": "gpt-4.1-mini",
      "llm_straming_enabled": true,
      "allow_to_delete": true,
      "status_of_building_flow": "Completed",
      "dynamic_variables": [],
      "flow_data": false,
      "bot_call_type": "Outgoing",
      "attach_file_ids": [],
      "attach_file_access_description": false,
      "integration_ids": [],
      "integrations": [],
      "enable_web_search": false,
      "web_search_engine": false,
      "post_call_config_ids": [
        {
          "id": 13208,
          "delivery_method": false,
          "destination": "demo@example.com",
          "include_summary": true,
          "include_full_conversation": true,
          "include_sentiment": true,
          "include_extracted_info": true,
          "extracted_variables": [
            {
              "key": "user_name",
              "description": "Name of the lead being called"
            },
            {
              "key": "agent_name",
              "description": "Name of the virtual agent"
            },
            {
              "key": "company_name",
              "description": "Name of the real estate company"
            }
          ],
          "slack_integration_id": false,
          "slack_channel_name": false,
          "slack_channel_id": false,
          "salesforce_integration_id": false,
          "salesforce_object_name": false,
          "hubspot_integration_id": false,
          "hubspot_object_name": false,
          "webhook_url": false,
          "payload_transformation_type": "none",
          "payload_transformation_template": false,
          "strip_country_code": false,
          "google_sheets_integration_id": false,
          "google_sheets_spreadsheet_id": false,
          "google_sheets_spreadsheet_name": false,
          "google_sheets_worksheet_name": "Sheet1",
          "whatsapp_integration_id": false,
          "whatsapp_template_sid": false,
          "cloud_whatsapp_phone_number_id": false,
          "cloud_whatsapp_template_id": false,
          "cloud_whatsapp_template_variables": [],
          "cloud_whatsapp_templates": [],
          "workflow_id": false,
          "trigger_call_statuses": [
            "completed",
            "voicemail_detected"
          ]
        }
      ],
      "is_end_call_enabled": true,
      "end_call_condition": "End the call when the user says goodbye, thank you, or indicates they are done with the conversation",
      "end_call_message": "Thank you for calling. Have a great day! Goodbye.",
      "end_call_message_type": "prompt",
      "end_call_message_prompt": "End the call politely in the same language user is speaking",
      "voicemail_enabled": false,
      "background_noice_name": false,
      "background_audio_volume": 0.2,
      "background_noise_enabled": false,
      "initial_ringing_sound_enabled": false,
      "speech_speed": 1,
      "organization_branch_ids": [],
      "closed_organization_branch_ids": []
    }
  ],
  "total_records": 61
}

Authorization

BearerAuth
AuthorizationBearer <token>

Bearer token authentication. Obtain your API key from the OmniDimension dashboard.

In: header

Query Parameters

pageno?integer

Page number for pagination.

Default1
pagesize?integer

Number of items per page (max 150).

Default30
Rangevalue <= 150
name?string

Filter agents whose name matches this substring (case-insensitive).

Response Body

application/json