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

GET https://api.moveworks.ai/configurations/v1alpha1/platform/extensions/plugins/{id}

Returns one plugin by its `id`. Secrets come back redacted.

Reference: https://docs.moveworks.com/api-reference/configuration-api/tool-studio/plugins/get-plugin

## Authentication

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

## Request

### Path parameters

- `id` (string, required) — The `id` of the plugin, as returned when it was created or listed.

## Response

### 200

The plugin

- `basic_info` (UseCaseBasicInfo, optional) — Name and description of the plugin, as shown to users.
- `launch_config` (UseCaseLaunchConfig, optional) — Who can use the plugin, whether analytics are enabled, and how logs are redacted. If omitted, analytics are disabled and standard log redaction is used.
- `triggering_config` (UseCaseTriggeringConfig, optional) — What triggers the plugin. Set exactly one of custom_triggering_config or system_triggering_config.
- `execution_config` (UseCaseExecutionConfig, optional) — What the plugin runs. Must match the trigger: conversational triggers run a conversational process; system triggers run an action.
- `id` (string, optional) — Unique identifier of the plugin, assigned by the server.
- `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 - no item with this `id` exists in 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

### UseCaseBasicInfo

- `name` (string, optional) — Name of the plugin, 3 to 64 characters.
- `description` (string, optional) — Description of what the plugin does, 3 to 1024 characters.

### UseCaseLaunchConfig

- `user_allow_list_config` (UserAllowlistConfig, optional) — Who can use the plugin. Needed for conversational plugins; set exactly one audience option.
- `enable_analytics` (boolean, optional) — If true, analytics are enabled for the plugin. Defaults to false.
- `log_redaction_policy` (enum, optional) — Log redaction policy for the plugin: LOG_REDACTION_POLICY_STANDARD, LOG_REDACTION_POLICY_STRICT, or LOG_REDACTION_POLICY_PERMISSIVE. Defaults to LOG_REDACTION_POLICY_STANDARD.
  - Allowed values: `LOG_REDACTION_POLICY_UNSPECIFIED`, `LOG_REDACTION_POLICY_STANDARD`, `LOG_REDACTION_POLICY_STRICT`, `LOG_REDACTION_POLICY_PERMISSIVE`

### UseCaseTriggeringConfig

- `custom_triggering_config` (CustomTriggeringConfig, optional) — Conversational trigger: example user utterances that invoke the plugin. Use with execution_config.conversational_plugin_body_config_uuid.
- `system_triggering_config` (SystemTriggeringConfig, optional) — Webhook, schedule, or built-in event triggers. Use with execution_config.system_plugin_body_config.

### UseCaseExecutionConfig

- `conversational_plugin_body_config_uuid` (string, optional) — ID of an existing conversational process the plugin runs. Use with a conversational trigger. Set exactly one of this or system_plugin_body_config.
- `system_plugin_body_config` (SystemPluginBodyConfig, optional) — Action run by a webhook, schedule, or built-in trigger. Set exactly one of this or conversational_plugin_body_config_uuid.

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

### UserAllowlistConfig

- `allow_all` (boolean, optional) — If true, the plugin is available to every user.
- `allow_emails` (ListStringValues, optional) — Email addresses of the only users who can use the plugin.
- `block_emails` (ListStringValues, optional) — Email addresses of users who cannot use the plugin; everyone else can.
- `allowlist_rule` (string, optional) — Moveworks DSL rule; the plugin is available only to users who match it.

### CustomTriggeringConfig

- `positive_triggering_examples` (list of string, optional) — Example user utterances that should invoke the plugin. At least five are required.
- `negative_triggering_examples` (list of string, optional) — Example user utterances that should not invoke the plugin.

### SystemTriggeringConfig

- `event_subscriptions` (list of EventSubscription, optional) — Webhook listener events that trigger the plugin. Configure exactly one trigger across event_subscriptions, scheduled_triggers, and built_in_triggers.
- `scheduled_triggers` (list of ScheduledTrigger, optional) — Schedules that trigger the plugin. Configure exactly one trigger across event_subscriptions, scheduled_triggers, and built_in_triggers.
- `built_in_triggers` (list of BuiltInTrigger, optional) — Built-in Moveworks events that trigger the plugin. Configure exactly one trigger across event_subscriptions, scheduled_triggers, and built_in_triggers.

### SystemPluginBodyConfig

- `action_id` (ActionId, optional) — Action to run when the plugin is triggered. Required.

### ListStringValues

- `values` (list of string, optional) — Email addresses. Each address may appear only once.

### EventSubscription

- `listener_id` (string, optional) — ID of an existing Tool Studio listener whose events trigger the plugin.
- `ttl` (string, optional) — Maximum age of an event that is still accepted for execution. Defaults to 30 minutes.
- `input_mapper` (EventSubscriptionInputMapper, optional, nullable) — Moveworks data mapping that builds the plugin's input from the event.
- `skip_execution_condition` (string, optional) — Moveworks DSL expression; when it evaluates to true, the event is skipped.

### ScheduledTrigger

- `cron_schedule` (CronSchedule, optional) — Run on a cron schedule. Set exactly one schedule type.
- `interval_schedule` (IntervalSchedule, optional) — Run at a fixed interval. Set exactly one schedule type.
- `calendar_schedule` (CalendarSchedule, optional) — Run on specific dates. Set exactly one schedule type.
- `input_mapper` (ScheduledTriggerInputMapper, optional, nullable) — Moveworks data mapping that builds the plugin's input for each scheduled run.
- `disabled` (boolean, optional) — If true, the schedule is kept but does not run. Defaults to false.

### BuiltInTrigger

- `event_type` (enum, optional) — Built-in Moveworks event that triggers the plugin. Allowed value: BUILT_IN_EVENT_TYPE_CONVERSATIONAL_FEEDBACK.
  - Allowed values: `BUILT_IN_EVENT_TYPE_CONVERSATIONAL_FEEDBACK`
- `input_mapper` (BuiltInTriggerInputMapper, optional, nullable) — Moveworks data mapping that builds the plugin's input from the event.
- `disabled` (boolean, optional) — If true, the trigger is disabled. Defaults to false.

### ActionId

- `http_action` (string, optional) — Name of an HTTP action to call. Set exactly one action type.
- `compound_action` (string, optional) — Name of a compound action to call. Set exactly one action type.
- `script_action` (string, optional) — Name of a script action to call. Set exactly one action type.
- `built_in_action` (enum, optional) — Name of a built-in Moveworks action to call, such as get_user_by_email or send_plaintext_chat_notification. Set exactly one action type.
  - Allowed values: `batch_get_users_by_email`, `batch_send_plaintext_chat_notification`, `create_generic_approval_request`, `generate_structured_value_action`, `generate_text_action`, `get_user_by_email`, `llm_decision_action`, `run_script_action`, `send_plaintext_chat_notification`, `summarize_text_action`

### EventSubscriptionInputMapper

Moveworks data mapping that builds the plugin's input from the event.

- string
- double
- integer
- boolean
- map from string to any
- list of any

### CronSchedule

- `cron_expression` (string, optional) — Cron expression for when the trigger runs, for example 0 9 * * 1-5.
- `schedule_window` (ScheduleWindow, optional) — Optional window that limits when the schedule is active.

### IntervalSchedule

- `interval` (string, optional) — Time between runs. Required.
- `schedule_window` (ScheduleWindow, optional) — Optional window that limits when the schedule is active.

### CalendarSchedule

- `dates` (list of DateTime, optional) — Dates and times when the trigger runs. At least one is required.

### ScheduledTriggerInputMapper

Moveworks data mapping that builds the plugin's input for each scheduled run.

- string
- double
- integer
- boolean
- map from string to any
- list of any

### BuiltInTriggerInputMapper

Moveworks data mapping that builds the plugin's input from the event.

- string
- double
- integer
- boolean
- map from string to any
- list of any

### ScheduleWindow

- `start_at` (DateTime, optional) — When the schedule starts.
- `end_at` (DateTime, optional) — When the schedule ends. Set either end_at or recurrences, not both.
- `recurrences` (long, optional) — Number of runs after which the schedule ends. Must be at least 1. Set either end_at or recurrences, not both.

### DateTime

- `year` (integer, optional)
- `month` (integer, optional)
- `day` (integer, optional)
- `hours` (integer, optional)
- `minutes` (integer, optional)
- `seconds` (integer, optional)
- `nanos` (integer, optional)
- `utc_offset` (string, optional)
- `time_zone` (TimeZone, optional)

### TimeZone

- `id` (string, optional)
- `version` (string, optional)

## Examples

**Response**

```json
{
  "basic_info": {
    "name": "Purchase Order Lookup",
    "description": "Looks up a purchase order and reports its status."
  },
  "launch_config": {
    "user_allow_list_config": {
      "allow_emails": {
        "values": [
          "jordan.lee@example.com"
        ]
      }
    },
    "enable_analytics": true
  },
  "triggering_config": {
    "custom_triggering_config": {
      "positive_triggering_examples": [
        "where is my purchase order",
        "check the status of PO-1024",
        "has my PO been approved yet",
        "look up purchase order PO-2231",
        "what happened to my purchase order"
      ],
      "negative_triggering_examples": [
        "create a new purchase order",
        "cancel my purchase order",
        "list all purchase orders for my team"
      ]
    }
  },
  "execution_config": {
    "conversational_plugin_body_config_uuid": "0f36c4e2-9a0f-4d21-8e0e-3a9c2f6b1d77"
  },
  "id": "3f6c1e2a-8b4d-4c7e-9a1f-2d5b6c7e8f90",
  "updated_time": "2026-11-12T18:04:11Z",
  "updated_by": "admin@example.com",
  "version": {
    "num": 2,
    "change_description": "Initial version."
  }
}
```

**SDK Code**

```python Plugins endpoints_getPlugin_example
import requests

url = "https://api.moveworks.ai/configurations/v1alpha1/platform/extensions/plugins/id"

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

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

print(response.json())
```

```javascript Plugins endpoints_getPlugin_example
const url = 'https://api.moveworks.ai/configurations/v1alpha1/platform/extensions/plugins/id';
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 Plugins endpoints_getPlugin_example
package main

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

func main() {

	url := "https://api.moveworks.ai/configurations/v1alpha1/platform/extensions/plugins/id"

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

url = URI("https://api.moveworks.ai/configurations/v1alpha1/platform/extensions/plugins/id")

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

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

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

$client = new \GuzzleHttp\Client();

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

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

```csharp Plugins endpoints_getPlugin_example
using RestSharp;

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

```swift Plugins endpoints_getPlugin_example
import Foundation

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

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