> 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 native plugin settings

GET https://api.moveworks.ai/configurations/v1alpha1/tool/setting

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

Reference: https://docs.moveworks.com/api-reference/configuration-api/platform-org/native-plugins/get-native-plugin-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 native plugin settings

- `search` (NativeSearchPluginsGroup, optional) — Settings for search plugins, such as forms, rooms, people and enterprise search.
- `user_preferences` (NativeUserPreferencesPluginsGroup, optional) — Settings for user preference plugins, such as changing the response language.
- `ticketing` (NativeTicketingPluginsGroup, optional) — Settings for ticketing plugins, such as viewing, resolving, reopening and commenting on tickets.
- `access_provisioning` (NativeAccessProvisioningPluginsGroup, optional) — Settings for access provisioning plugins, such as distribution list management and software access.
- `access_account` (NativeAccessAccountPluginsGroup, optional) — Settings for account access plugins, such as unlocking accounts and resetting passwords or MFA.
- `approvals` (NativeApprovalsPluginsGroup, optional) — Settings for approvals plugins, such as viewing, listing and acting on approval records.
- `llm_passthrough` (NativePassthroughPluginsGroup, optional) — Settings for general writing plugins, such as writing emails and translating text.
- `smart_handoff` (NativeSmartHandoffPluginsGroup, optional) — Settings for the smart handoff plugin.
- `gpt` (NativeGPTPluginsGroup, optional) — Settings for generative AI plugins, such as QuickGPT and world knowledge web search.
- `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

### NativeSearchPluginsGroup

- `forms_plugin` (PluginControl, optional) — Plugin that lets users search for and fill out forms.
- `room_plugin` (PluginControl, optional) — Plugin that lets users look up rooms.
- `people_plugin_multifield` (PluginControl, optional) — Plugin that lets users look up people by multiple fields, including batch lookups.
- `brief_me_interactions_plugin` (PluginControl, optional) — Plugin that lets users generate content from uploaded files. Requires the brief me start and end plugin to be enabled.
- `enterprise_search_plugin` (PluginControl, optional) — Plugin that enables enterprise search.

### NativeUserPreferencesPluginsGroup

- `change_language_plugin` (PluginControl, optional) — Plugin that lets users change the AI Assistant's response language. Requires multilingual support to be enabled.
- `brief_me_start_end_plugin` (PluginControl, optional) — Plugin that lets users start and end a focused session over uploaded files. Enable it for the brief me interactions plugin to work.

### NativeTicketingPluginsGroup

- `display_ticket_plugin` (PluginControl, optional) — Plugin that shows users the details of a ticket, respecting ticket visibility rules.
- `resolve_ticket_plugin` (PluginControl, optional) — Plugin that lets users resolve their tickets.
- `reopen_ticket_plugin` (PluginControl, optional) — Plugin that lets users reopen their tickets.
- `add_comment_to_ticket_plugin` (PluginControl, optional) — Plugin that lets users add a comment to a ticket. Use this when ticket translation is not enabled.
- `add_translated_comment_to_ticket_plugin` (PluginControl, optional) — Plugin that lets users add a comment to a ticket with translation. Use this instead of the add comment plugin when ticket translation is enabled.
- `list_tickets_plugin` (PluginControl, optional) — Plugin that lists a user's tickets, respecting ticket visibility rules.

### NativeAccessProvisioningPluginsGroup

- `add_to_dl_plugin` (PluginControl, optional) — Plugin that lets users request to be added to a distribution list.
- `remove_from_dl_plugin` (PluginControl, optional) — Plugin that lets users request to be removed from a distribution list.
- `create_dl_plugin` (PluginControl, optional) — Plugin that lets users request a new distribution list.
- `check_dl_membership_plugin` (PluginControl, optional) — Plugin that lets users check distribution list membership.
- `find_dl_owner_plugin` (PluginControl, optional) — Plugin that lets users find the owner of a distribution list.
- `access_sw_plugin` (PluginControl, optional) — Plugin that lets users request access to software.

### NativeAccessAccountPluginsGroup

- `unlock_account_plugin` (PluginControl, optional) — Plugin that lets users unlock their account.
- `reset_password_plugin` (PluginControl, optional) — Plugin that lets users reset their password.
- `reset_mfa_plugin` (PluginControl, optional) — Plugin that lets users reset their multi-factor authentication.
- `change_password_plugin` (PluginControl, optional) — Plugin that lets users change their password.

### NativeApprovalsPluginsGroup

- `display_approval_record_plugin` (PluginControl, optional) — Plugin that shows users the details of an approval record. Requires the approvals database to be enabled.
- `approval_record_action_plugin` (PluginControl, optional) — Plugin that lets users approve or deny approval records. Requires the approvals database to be enabled.
- `list_approval_records_plugin` (PluginControl, optional) — Plugin that lists a user's approval records. Requires the approvals database to be enabled.

### NativePassthroughPluginsGroup

- `write_email_plugin` (PluginControl, optional) — Plugin that writes requested text as an email with a subject line and body. It does not send the email.
- `translate_text_plugin` (PluginControl, optional) — Plugin that translates text into a specified language without changing the user's response language preference.

### NativeSmartHandoffPluginsGroup

- `smart_handoff_plugin` (PluginControl, optional) — Plugin that hands users off to support and lets them take actions in chat.

### NativeGPTPluginsGroup

- `quick_gpt_plugin` (PluginControl, optional) — QuickGPT plugin that gives users quick, safe access to generative AI models, and web search if available, for a wide variety of tasks.
- `world_knowledge_plugin` (PluginControl, optional) — Plugin that uses web search to ground responses in up-to-date information from the public web.

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

### PluginControl

- `launch_config` (LaunchConfig, optional) — Which users the plugin is enabled for.
- `fixed_response_plugin_message_config` (FixedResponsePluginMessageConfig, optional) — Optional fixed response. When set, the plugin shows this message instead of performing its action.

### LaunchConfig

- `access_rule_dsl` (string, optional) — Moveworks DSL rule for which users the plugin is enabled. Use 'true' to enable for all users or 'false' to disable; leave empty for the default.

### FixedResponsePluginMessageConfig

- `fixed_response_message` (string, optional) — Message shown to the user instead of running the plugin, for example to direct them to self-service. The plugin must still be enabled for the user.
- `message_paraphrasing_enabled` (boolean, optional) — If true, the AI Assistant paraphrases the fixed response message instead of sending it word for word.

## Examples

**Response**

```json
{
  "search": {
    "forms_plugin": {
      "launch_config": {},
      "fixed_response_plugin_message_config": {}
    },
    "room_plugin": {
      "launch_config": {},
      "fixed_response_plugin_message_config": {}
    },
    "people_plugin_multifield": {
      "launch_config": {},
      "fixed_response_plugin_message_config": {}
    },
    "brief_me_interactions_plugin": {
      "launch_config": {},
      "fixed_response_plugin_message_config": {}
    },
    "enterprise_search_plugin": {
      "launch_config": {},
      "fixed_response_plugin_message_config": {}
    }
  },
  "user_preferences": {
    "change_language_plugin": {
      "launch_config": {},
      "fixed_response_plugin_message_config": {}
    },
    "brief_me_start_end_plugin": {
      "launch_config": {},
      "fixed_response_plugin_message_config": {}
    }
  },
  "ticketing": {
    "display_ticket_plugin": {
      "launch_config": {},
      "fixed_response_plugin_message_config": {}
    },
    "resolve_ticket_plugin": {
      "launch_config": {},
      "fixed_response_plugin_message_config": {}
    },
    "reopen_ticket_plugin": {
      "launch_config": {},
      "fixed_response_plugin_message_config": {}
    },
    "add_comment_to_ticket_plugin": {
      "launch_config": {},
      "fixed_response_plugin_message_config": {}
    },
    "add_translated_comment_to_ticket_plugin": {
      "launch_config": {},
      "fixed_response_plugin_message_config": {}
    },
    "list_tickets_plugin": {
      "launch_config": {},
      "fixed_response_plugin_message_config": {}
    }
  },
  "access_provisioning": {
    "add_to_dl_plugin": {
      "launch_config": {},
      "fixed_response_plugin_message_config": {}
    },
    "remove_from_dl_plugin": {
      "launch_config": {},
      "fixed_response_plugin_message_config": {}
    },
    "create_dl_plugin": {
      "launch_config": {},
      "fixed_response_plugin_message_config": {}
    },
    "check_dl_membership_plugin": {
      "launch_config": {},
      "fixed_response_plugin_message_config": {}
    },
    "find_dl_owner_plugin": {
      "launch_config": {},
      "fixed_response_plugin_message_config": {}
    },
    "access_sw_plugin": {
      "launch_config": {},
      "fixed_response_plugin_message_config": {}
    }
  },
  "access_account": {
    "unlock_account_plugin": {
      "launch_config": {},
      "fixed_response_plugin_message_config": {}
    },
    "reset_password_plugin": {
      "launch_config": {},
      "fixed_response_plugin_message_config": {}
    },
    "reset_mfa_plugin": {
      "launch_config": {},
      "fixed_response_plugin_message_config": {}
    },
    "change_password_plugin": {
      "launch_config": {},
      "fixed_response_plugin_message_config": {}
    }
  },
  "approvals": {
    "display_approval_record_plugin": {
      "launch_config": {},
      "fixed_response_plugin_message_config": {}
    },
    "approval_record_action_plugin": {
      "launch_config": {},
      "fixed_response_plugin_message_config": {}
    },
    "list_approval_records_plugin": {
      "launch_config": {},
      "fixed_response_plugin_message_config": {}
    }
  },
  "llm_passthrough": {
    "write_email_plugin": {
      "launch_config": {},
      "fixed_response_plugin_message_config": {}
    },
    "translate_text_plugin": {
      "launch_config": {},
      "fixed_response_plugin_message_config": {}
    }
  },
  "smart_handoff": {
    "smart_handoff_plugin": {
      "launch_config": {},
      "fixed_response_plugin_message_config": {}
    }
  },
  "updated_time": "2026-11-12T18:04:11Z",
  "updated_by": "admin@example.com",
  "version": {
    "num": 2,
    "change_description": "Initial setup"
  }
}
```

**SDK Code**

```python Native Plugins endpoints_getNativePluginSettings_example
import requests

url = "https://api.moveworks.ai/configurations/v1alpha1/tool/setting"

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

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

print(response.json())
```

```javascript Native Plugins endpoints_getNativePluginSettings_example
const url = 'https://api.moveworks.ai/configurations/v1alpha1/tool/setting';
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 Native Plugins endpoints_getNativePluginSettings_example
package main

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

func main() {

	url := "https://api.moveworks.ai/configurations/v1alpha1/tool/setting"

	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 Native Plugins endpoints_getNativePluginSettings_example
require 'uri'
require 'net/http'

url = URI("https://api.moveworks.ai/configurations/v1alpha1/tool/setting")

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 Native Plugins endpoints_getNativePluginSettings_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/setting")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php Native Plugins endpoints_getNativePluginSettings_example
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

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

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

```csharp Native Plugins endpoints_getNativePluginSettings_example
using RestSharp;

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

```swift Native Plugins endpoints_getNativePluginSettings_example
import Foundation

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

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