> 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.

# Get display settings

GET https://api.moveworks.ai/configurations/v1alpha1/assistant/display

Returns your organization's display settings. There is one per organization, so there is no `id`.

Reference: https://docs.moveworks.com/api-reference/configuration-api/handoff-live-agent/display/get-display-settings

## Authentication

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

## Response

### 200

Your organization's display settings

- `bot_friendly_name` (string, optional) — Name the assistant uses to refer to itself. Other fields can reference it with \{\{ bot\_friendly\_name }}.
- `handoff_category_names` (map from string to string, optional) — Display titles for handoff categories, keyed by category key. Each key must match a configured handoff category. An update replaces the whole map.
- `handoff_category_desc` (map from string to string, optional) — Descriptions shown beneath each handoff category, keyed by category key. An update replaces the whole map.
- `handoff_item_names` (map from string to string, optional) — Display titles for handoff items, keyed by item key. Each key must match a configured handoff item. An update replaces the whole map.
- `handoff_item_descs` (map from string to string, optional) — Descriptions shown beneath each handoff item, keyed by item key. An update replaces the whole map.
- `handoff_item_action_texts` (map from string to string, optional) — Button label for each handoff item, keyed by item key, for example Visit Facilities Portal. An update replaces the whole map.
- `handoff_item_disclaimers` (map from string to string, optional) — Additional information or disclaimer shown under a handoff item, keyed by item key. An update replaces the whole map.
- `welcome_message_to_portal_mapping` (map from string to string, optional) — Web chat welcome message for each portal, keyed by portal system name. Overrides default_welcome_message for that portal.
- `default_welcome_message` (string, optional) — Welcome message shown when users first open web chat, for portals without a specific message.
- `webchat_chatbox_placeholder` (string, optional) — Placeholder text shown in the web chat input box.
- `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.

## 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)

### 404 Not Found Error

Not found - this configuration has never been written 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

### 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.

### ErrorResponseError

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

## Examples

**Response**

```json
{
  "bot_friendly_name": "example-name",
  "handoff_category_names": {},
  "handoff_category_desc": {},
  "handoff_item_names": {},
  "handoff_item_descs": {},
  "handoff_item_action_texts": {},
  "handoff_item_disclaimers": {},
  "welcome_message_to_portal_mapping": {},
  "updated_time": "2026-11-12T18:04:11Z",
  "updated_by": "admin@example.com",
  "version": {
    "num": 2,
    "change_description": "Initial setup"
  }
}
```

**SDK Code**

```python Display endpoints_getDisplaySettings_example
import requests

url = "https://api.moveworks.ai/configurations/v1alpha1/assistant/display"

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

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

print(response.json())
```

```javascript Display endpoints_getDisplaySettings_example
const url = 'https://api.moveworks.ai/configurations/v1alpha1/assistant/display';
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 Display endpoints_getDisplaySettings_example
package main

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

func main() {

	url := "https://api.moveworks.ai/configurations/v1alpha1/assistant/display"

	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 Display endpoints_getDisplaySettings_example
require 'uri'
require 'net/http'

url = URI("https://api.moveworks.ai/configurations/v1alpha1/assistant/display")

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 Display endpoints_getDisplaySettings_example
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

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

```php Display endpoints_getDisplaySettings_example
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

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

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

```csharp Display endpoints_getDisplaySettings_example
using RestSharp;

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

```swift Display endpoints_getDisplaySettings_example
import Foundation

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

let request = NSMutableURLRequest(url: NSURL(string: "https://api.moveworks.ai/configurations/v1alpha1/assistant/display")! 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()
```