> This page is for API Reference & Tools.

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.moveworks.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.moveworks.com/_mcp/server.

# List live agent integrations

GET https://api.moveworks.ai/configurations/v1alpha1/tool/live-agent/integrations

Returns every live agent integration in your organization as a JSON array.

Reference: https://docs.moveworks.com/api-reference/configuration-api/handoff-live-agent/live-agent-integrations/list-live-agent-integrations

## Authentication

- `Authorization` header (bearer token, required) — JWT bearer token authentication. Include the Configuration API key in the Authorization header as 'Bearer \<token>'.

## Response

### 200

The live agent integrations in your organization

- `list of AgentHandoffConfig`

## Errors

### 401 Unauthorized Error

Unauthorized - the `Authorization` header is missing or the token is invalid

- `error` (ErrorResponseError, required)

### 403 Forbidden Error

Forbidden - the API key isn't allowed to change this configuration, or the configuration is frozen for your organization

- `error` (ErrorResponseError, required)

### 429 Too Many Requests Error

Too many requests - the organization exceeded the Configuration API rate limit. Back off and retry.

- `error` (ErrorResponseError, required)

### 500 Internal Server Error

Internal server error - retry the request

- `error` (ErrorResponseError, required)

## Types

### AgentHandoffConfig

A live agent handoff that defines how users are connected to a human agent, such as via a channel, provider API, URL or agent broker.

- `id` (string, optional) — Unique identifier of the handoff configuration, assigned by the server.
- `name` (string, optional) — Unique key used to refer to this handoff. Must start with a lowercase letter and contain only lowercase letters, digits and underscores. Cannot be changed after creation.
- `channel` (ChannelHandoffConfig, optional) — Hands off by routing the user's messages to a channel where agents respond.
- `api` (ApiHandoffConfig, optional) — Hands off through a live agent provider's API, such as Vayusphere or BeyondTrust.
- `url` (UrlHandoffConfig, optional) — Hands off by directing the user to a URL that connects them to an agent.
- `agent_broker` (AgentBrokerHandoffConfig, optional) — Hands off by brokering the chat to a live agent provider, such as Amazon Connect, ServiceNow, Genesys or Salesforce.
- `file_ticket_enabled` (boolean, optional) — If true, a ticket is automatically filed for the user whenever they request a live agent.
- `ticket_receipt_traits` (AgentHandoffTicketTraits, optional) — Additional settings for the ticket filed when a user requests a live agent.
- `updated_time` (datetime, optional) — When the configuration was last updated.
- `updated_by` (string, optional) — Who last updated the configuration.
- `version` (Version, optional) — Document version. On update, send back the num from your last read.

### ErrorResponseError

- `code` (string, optional) — A machine-readable error code.
- `message` (string, optional) — What went wrong, and for a rejected field, which rule it broke.

### ChannelHandoffConfig

- `routes` (list of ChannelRouteConfig, optional) — Channels the user's messages can be routed to. Between 1 and 20 routes.

### ApiHandoffConfig

- `vayusphere` (VayusphereLiveAgentApiHandoffConfig, optional) — Hands off to a live agent queue through the Vayusphere API.
- `beyond_trust` (BeyondTrustApiHandoffConfig, optional) — Hands off to a live agent session through the BeyondTrust API.

### UrlHandoffConfig

- `base_url` (string, optional) — Base URL that connects the user to an agent. Must start with http:// or https:// when set.
- `user_comment_collection_enabled` (boolean, optional) — If true, a comment is collected from the user and made available to the URL parameter mapper under the key 'user_text'.
- `url_params_bender` (UrlHandoffConfigUrlParamsBender, optional) — Data mapper that defines the URL parameters Moveworks adds to the handoff URL.
- `url_tracking_enabled` (boolean, optional) — If true, the URL is wrapped as a Moveworks link so clicks are tracked in analytics. Not recommended for Microsoft Teams, where it opens a browser tab.

### AgentBrokerHandoffConfig

- `anonymous_agents_enabled` (boolean, optional) — If true, the live agent provider uses anonymous agents.
- `amazon_connect` (AmazonConnectHandoffConfig, optional) — Settings for brokering live agent chats to Amazon Connect.
- `eight_x_eight` (EightXEightHandoffConfig, optional) — Settings for brokering live agent chats to 8x8.
- `snow` (SnowHandoffConfig, optional) — Settings for brokering live agent chats to ServiceNow.
- `glia` (GliaHandoffConfig, optional) — Settings for brokering live agent chats to Glia.
- `fresh_chat` (FreshChatHandoffConfig, optional) — Settings for brokering live agent chats to Freshchat.
- `five_nine` (FiveNineHandoffConfig, optional) — Settings for brokering live agent chats to Five9.
- `genesys` (GenesysHandoffConfig, optional) — Settings for brokering live agent chats to Genesys.
- `salesforce` (SalesforceHandoffConfig, optional) — Settings for brokering live agent chats to Salesforce.
- `session_timeout_seconds` (integer, optional) — Seconds of inactivity after which a live agent session is automatically ended. Defaults to 120 seconds if not set.
- `connector_id` (string, optional) — Connector used to start the live agent connection. ID of an existing connector (GET /configurations/v1alpha1/platform/connectors).

### AgentHandoffTicketTraits

- `short_description_prefix` (string, optional) — Prefix added to the short description of the ticket filed when a user requests a live agent.

### Version

- `num` (integer, optional) — Version number set by the server. On update, send the num from your last read; a stale num is rejected as a conflict.
- `change_description` (string, optional) — A short note describing this change. Required on every create and update.

### ChannelRouteConfig

- `channel_id` (string, optional) — ID of the channel where the user's messages are sent to communicate with an agent.
- `connector_id` (string, optional) — Connector for the chat platform that hosts the handoff channel. ID of an existing connector (GET /configurations/v1alpha1/platform/connectors).
- `item_ref` (string, optional) — Server-assigned row identifier. Omit it on create; on update, send back the value from your last read so the row is matched correctly.

### VayusphereLiveAgentApiHandoffConfig

- `agent_name` (string, optional) — Agent name passed to the Vayusphere API when adding a user to a queue. Up to 32 characters.
- `group_path_configs` (list of GroupPathConfig, optional) — Group paths (Vayusphere queues) the user can be placed in, each with a rule that selects it.
- `default_group_path` (string, optional) — Fallback group path (Vayusphere queue) used when none of the group path rules match. Up to 32 characters.
- `link_to_assistant` (string, optional) — Link to the Vayusphere landing page the user is directed to.

### BeyondTrustApiHandoffConfig

- `connector_id` (string, optional) — Connector used to call the BeyondTrust API. ID of an existing connector (GET /configurations/v1alpha1/platform/connectors).
- `session_key_url` (string, optional) — URL used to generate a session key from the BeyondTrust API. Must start with http:// or https://.
- `base_url` (string, optional) — Base URL that connects the user to an agent. Must start with http:// or https://.
- `url_params_bender` (BeyondTrustApiHandoffConfigUrlParamsBender, optional) — Data mapper that defines the URL parameters Moveworks adds to the handoff URL.

### UrlHandoffConfigUrlParamsBender

Data mapper that defines the URL parameters Moveworks adds to the handoff URL.

### AmazonConnectHandoffConfig

- `domain_attributes` (list of AmazonConnectDomainAttribute, optional) — Per-domain attributes sent to Amazon Connect.

### EightXEightHandoffConfig

- `domain_attributes` (list of EightXEightDomainAttribute, optional) — Per-domain 8x8 channel and queue settings.
- `live_agent_start_time` (string, optional) — Start time of the daily window when 8x8 live agents are available, in HH:MM format.
- `live_agent_end_time` (string, optional) — End time of the daily window when 8x8 live agents are available, in HH:MM format.

### SnowHandoffConfig

- `context_bender` (SnowHandoffConfigContextBender, optional) — Data mapper that defines the context passed to ServiceNow when the chat is handed off.
- `show_agent_wait_time` (boolean, optional) — If true, the user is shown how long they must wait before being connected to a live agent.
- `app_inbound_id` (string, optional) — ServiceNow app inbound ID. Set this when there are multiple provider applications.

### GliaHandoffConfig

- `site_id` (string, optional) — Glia site ID for the integration.
- `queue_ids` (list of string, optional) — Glia queue IDs for the site that chats can be routed to.
- `webhook_token` (string, optional) — Webhook token for the Glia integration.
- `user_details_bender` (GliaHandoffConfigUserDetailsBender, optional) — Data mapper that defines the user details sent to Glia. The mapper can reference the 'user' object.

### FreshChatHandoffConfig

- `domain_attributes` (list of FreshChatDomainAttribute, optional) — Per-domain Freshchat channel settings.

### FiveNineHandoffConfig

- `domain_attributes` (list of FiveNineDomainAttribute, optional) — Per-domain Five9 settings.

### GenesysHandoffConfig

- `domain_attributes` (list of GenesysDomainAttribute, optional) — Per-domain Genesys integration settings.

### SalesforceHandoffConfig

- `domain_attributes` (list of SalesforceDomainAttribute, optional) — Per-domain Salesforce settings.

### GroupPathConfig

- `group_path` (string, optional) — Vayusphere group path that represents a queue the user can be placed in. Up to 32 characters.
- `group_rule_dsl` (string, optional) — Moveworks DSL rule that determines when the user is placed in this group path.
- `item_ref` (string, optional) — Server-assigned row identifier. Omit it on create; on update, send back the value from your last read so the row is matched correctly.

### BeyondTrustApiHandoffConfigUrlParamsBender

Data mapper that defines the URL parameters Moveworks adds to the handoff URL.

### AmazonConnectDomainAttribute

- `domain` (string, optional) — Support domain these settings apply to, such as IT_DOMAIN, HR_DOMAIN or FINANCE_DOMAIN.
- `attributes` (list of AmazonConnectAttributes, optional) — Key-value attributes sent to Amazon Connect for this domain.
- `item_ref` (string, optional) — Server-assigned row identifier. Omit it on create; on update, send back the value from your last read so the row is matched correctly.

### EightXEightDomainAttribute

- `domain` (string, optional) — Support domain these settings apply to, such as IT_DOMAIN, HR_DOMAIN or FINANCE_DOMAIN.
- `channel_id` (string, optional) — 8x8 channel ID used for chats in this domain.
- `queue_id` (string, optional) — 8x8 queue ID that chats in this domain are routed to.
- `item_ref` (string, optional) — Server-assigned row identifier. Omit it on create; on update, send back the value from your last read so the row is matched correctly.

### SnowHandoffConfigContextBender

Data mapper that defines the context passed to ServiceNow when the chat is handed off.

### GliaHandoffConfigUserDetailsBender

Data mapper that defines the user details sent to Glia. The mapper can reference the 'user' object.

### FreshChatDomainAttribute

- `domain` (string, optional) — Support domain these settings apply to: IT_DOMAIN or HR_DOMAIN.
- `channel_id` (string, optional) — Freshchat channel ID used for chats in this domain.
- `item_ref` (string, optional) — Server-assigned row identifier. Omit it on create; on update, send back the value from your last read so the row is matched correctly.

### FiveNineDomainAttribute

- `domain` (string, optional) — Support domain these settings apply to, such as IT_DOMAIN, HR_DOMAIN or FINANCE_DOMAIN.
- `tenant_name` (string, optional) — Five9 tenant name used to authenticate with Five9.
- `campaign_name` (string, optional) — Five9 campaign that chats in this domain are sent to.
- `greeting_message` (string, optional) — Greeting message used when starting a Five9 chat for this domain.
- `item_ref` (string, optional) — Server-assigned row identifier. Omit it on create; on update, send back the value from your last read so the row is matched correctly.

### GenesysDomainAttribute

- `domain` (string, optional) — Support domain these settings apply to, such as IT_DOMAIN, HR_DOMAIN or FINANCE_DOMAIN.
- `external_integration_id_in_agent_instance` (string, optional) — Genesys integration ID used to start conversations and send messages to agents for this domain.
- `external_integration_id_for_user_id` (string, optional) — Genesys integration ID used to identify the user when starting a conversation for this domain.
- `item_ref` (string, optional) — Server-assigned row identifier. Omit it on create; on update, send back the value from your last read so the row is matched correctly.

### SalesforceDomainAttribute

- `domain` (string, optional) — Support domain these settings apply to, such as IT_DOMAIN, HR_DOMAIN or FINANCE_DOMAIN.
- `greeting_message` (string, optional) — Greeting message used when starting a Salesforce chat for this domain.
- `item_ref` (string, optional) — Server-assigned row identifier. Omit it on create; on update, send back the value from your last read so the row is matched correctly.

### AmazonConnectAttributes

- `key` (string, optional) — Name of the attribute sent to Amazon Connect.
- `value` (string, optional) — Value of the attribute sent to Amazon Connect.
- `item_ref` (string, optional) — Server-assigned row identifier. Omit it on create; on update, send back the value from your last read so the row is matched correctly.

## Examples

**Response**

```json
[
  {
    "id": "3f6c1e2a-8b4d-4c7e-9a1f-2d5b6c7e8f90",
    "name": "example",
    "channel": {
      "routes": [
        {
          "channel_id": "<id>",
          "connector_id": "<connector-uuid>",
          "item_ref": "<string>"
        }
      ]
    },
    "file_ticket_enabled": true,
    "updated_time": "2026-11-12T18:04:11Z",
    "updated_by": "admin@example.com",
    "version": {
      "num": 2,
      "change_description": "Initial setup"
    }
  }
]
```

**SDK Code**

```python Live Agent Integrations endpoints_listLiveAgentIntegrations_example
import requests

url = "https://api.moveworks.ai/configurations/v1alpha1/tool/live-agent/integrations"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript Live Agent Integrations endpoints_listLiveAgentIntegrations_example
const url = 'https://api.moveworks.ai/configurations/v1alpha1/tool/live-agent/integrations';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Live Agent Integrations endpoints_listLiveAgentIntegrations_example
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.moveworks.ai/configurations/v1alpha1/tool/live-agent/integrations"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Live Agent Integrations endpoints_listLiveAgentIntegrations_example
require 'uri'
require 'net/http'

url = URI("https://api.moveworks.ai/configurations/v1alpha1/tool/live-agent/integrations")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

```java Live Agent Integrations endpoints_listLiveAgentIntegrations_example
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.moveworks.ai/configurations/v1alpha1/tool/live-agent/integrations")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php Live Agent Integrations endpoints_listLiveAgentIntegrations_example
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.moveworks.ai/configurations/v1alpha1/tool/live-agent/integrations', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();
```

```csharp Live Agent Integrations endpoints_listLiveAgentIntegrations_example
using RestSharp;

var client = new RestClient("https://api.moveworks.ai/configurations/v1alpha1/tool/live-agent/integrations");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift Live Agent Integrations endpoints_listLiveAgentIntegrations_example
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.moveworks.ai/configurations/v1alpha1/tool/live-agent/integrations")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```