> 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 conversational processes

GET https://api.moveworks.ai/configurations/v1alpha1/platform/extensions/conversational-processes

Returns every conversational process in your organization as a JSON array. Unset fields come back as empty values, and secrets come back redacted.

Reference: https://docs.moveworks.com/api-reference/configuration-api/tool-studio/conversational-processes/list-conversational-processes

## 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 conversational processes in your organization

- `list of ConversationalProcess`

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

### ConversationalProcess

A conversational process built in Tool Studio that collects inputs (slots) from the user and runs a flow of actions and content to complete a task.

- `id` (string, optional) — Unique identifier of the conversational process, assigned by the server. Cannot be changed.
- `signature` (FunctionSignatureSettings, optional) — Name and description of the conversational process. The internal name is derived from the display name. Required.
- `slots` (list of ConversationalProcessSlot, optional) — Input values (slots) the process collects from the user and uses as variables in the conversation flow.
- `conversation_flow` (ConversationBlock, optional) — The control flow of the process, built from sequential, switch, activity, return and no-op blocks. Required.
- `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.

### FunctionSignatureSettings

- `name` (string, optional) — Technical name used to reference this function. Must start with a letter and contain only letters, digits and underscores; 2 to 64 characters.
- `description` (string, optional) — Description of what this function does. 12 to 1024 characters.
- `arguments` (list of ArgumentSettings, optional) — Input arguments the function accepts.
- `result_schema` (FunctionSignatureSettingsResultSchema, optional) — JSON schema describing the function's output.
- `display_name` (string, optional) — Human-readable name of the function. 2 to 64 characters. If empty, name is shown instead.

### ConversationalProcessSlot

- `name` (string, optional) — Unique slot name used to refer to the slot in the conversation flow. Must start with a letter and contain only letters, digits and underscores (2 to 64 characters).
- `description` (string, optional) — Natural language description of the slot that tells the assistant what to ask the user. Required.
- `type` (TypeSettings, optional) — Data type of the slot value, such as string, List[User] or a custom data type. Required.
- `resolution` (ConversationalProcessSlotResolution, optional) — How the slot value is resolved, inferred or requested from the user.
- `validations` (list of ConversationalProcessSlotValidation, optional) — Rules checked against the resolved slot value. The resolved value is available as value.

### ConversationBlock

- `sequential` (ConversationSequential, optional) — A sequence of blocks run in order.
- `switch` (ConversationSwitch, optional) — A set of conditional cases plus a default; exactly one branch runs.
- `activity` (ConversationActivity, optional) — A single activity, such as running an action or showing text, knowledge or a form.
- `return` (ConversationReturn, optional) — Exits the entire conversation flow.
- `noop` (ConversationNoop, optional) — A block that does nothing, used as a pass-through in the flow.

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

### ArgumentSettings

- `name` (string, optional) — Name of the argument. Must start with a letter and contain only letters, digits and underscores; 2 to 64 characters.
- `description` (string, optional) — Description of the argument. 2 to 256 characters.
- `type` (TypeSettings, optional) — Data type of the argument, e.g. string, List[User] or a custom type. Required.
- `required` (boolean, optional) — If true, a value must be provided for this argument.
- `default_value` (ArgumentSettingsDefaultValue, optional, nullable) — Value used for this argument when none is provided.
- `example_value` (ArgumentSettingsExampleValue, optional, nullable) — Example value for this argument.

### FunctionSignatureSettingsResultSchema

JSON schema describing the function's output.

### TypeSettings

- `primitive` (enum, optional) — A primitive type. One of: string, integer, number, boolean, array, object.
  - Allowed values: `string`, `integer`, `number`, `boolean`, `array`, `object`
- `native` (enum, optional) — A Moveworks-defined type. One of: User, File, ariba.v1.CatalogItem, workday.v1.JobProfile, Room, Group.
  - Allowed values: `User`, `File`, `ariba.v1.CatalogItem`, `workday.v1.JobProfile`, `Room`, `Group`
- `custom` (string, optional) — Name of a custom type registered in your organization. ID of an existing data_type (GET /configurations/v1alpha1/platform/extensions/data-types).
- `list` (boolean, optional) — If true, the argument is a list of the selected type rather than a single value.

### ConversationalProcessSlotResolution

- `strategy_invocation` (ResolutionStrategyInvocation, optional) — Resolution strategy used to resolve the slot value. If omitted, the default resolution strategy for the data type is used.
- `must_request` (boolean, optional) — If true, the assistant always explicitly asks the user for this slot value.
- `value_population_policy` (ConversationalProcessSlotValuePopulationPolicy, optional) — Controls whether the value is inferred or requested, and an optional fallback value.

### ConversationalProcessSlotValidation

- `condition` (string, optional) — DSL rule evaluated against the slot value. The value is valid if the result is truthy.
- `error_message` (string, optional) — Message shown to the user when the validation fails. Supports Mustache templates.

### ConversationSequential

- `steps` (list of ConversationBlock, optional) — Blocks run in order.

### ConversationSwitch

- `prerequisite_slots` (list of string, optional) — Names of slots that must be resolved before the cases are evaluated.
- `cases` (list of ConversationSwitchCase, optional) — Conditional cases evaluated in order; the first matching case runs.
- `default` (ConversationBlock, optional) — Block that runs when no case matches.

### ConversationActivity

- `prerequisite_slots` (list of string, optional) — Names of slots that must be resolved before the activity runs.
- `output_slot` (string, optional) — Name under which the activity result is stored for use later in the flow.
- `action` (ActionInvocation, optional) — Runs an action with the given input and output mappings.
- `text` (ConversationText, optional) — Shows a text message to the user.
- `knowledge` (ConversationKnowledge, optional) — Shows a knowledge article to the user.
- `form` (ConversationForm, optional) — Shows a form to the user.
- `needs_confirmation` (boolean, optional) — If true, the user must confirm before the activity runs.
- `wait_for_completion` (boolean, optional) — If true, the flow waits for the action to finish before continuing. New actions default to true.

### ConversationReturn

### ConversationNoop

### ArgumentSettingsDefaultValue

Value used for this argument when none is provided.

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

### ArgumentSettingsExampleValue

Example value for this argument.

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

### ResolutionStrategyInvocation

- `strategy` (ResolutionStrategySelection, optional) — Resolution strategy used to find the value, either a custom strategy or a built-in one.
- `input_mappers` (list of ResolverMethodInputMapper, optional) — Mappings from the invocation context to the inputs of each resolver method in the strategy.

### ConversationalProcessSlotValuePopulationPolicy

- `inference_type` (enum, optional) — Whether the assistant always requests the value from the user or always infers it. If omitted, the assistant uses its best judgement at runtime.
  - Allowed values: `CONVERSATIONAL_PROCESS_INFERENCE_TYPE_UNSPECIFIED`, `CONVERSATIONAL_PROCESS_INFERENCE_TYPE_ALWAYS_REQUEST`, `CONVERSATIONAL_PROCESS_INFERENCE_TYPE_ALWAYS_INFER`
- `fallback_expression` (string, optional) — Optional DSL expression that calculates a default value for the slot.

### ConversationSwitchCase

- `condition` (string, optional) — DSL condition that selects this case when it evaluates to true.
- `then` (ConversationBlock, optional) — Block that runs when the condition matches. Required.

### ActionInvocation

- `action_id` (ActionId, optional) — The action to call.
- `input_mapper` (ActionInvocationInputMapper, optional, nullable) — Data mapping that builds the action's input arguments.
- `output_mapper` (ActionInvocationOutputMapper, optional, nullable) — Data mapping applied to the action's result.

### ConversationText

- `template` (string, optional) — Text shown to the user. Supports Mustache templates.

### ConversationKnowledge

- `document_id` (ConversationKnowledgeDocumentId, optional) — ID of the knowledge article to show.
- `document_title` (string, optional) — Title of the knowledge article, used for preview.

### ConversationForm

- `form_id` (string, optional) — ID of the form to show.
- `form_title` (string, optional) — Title of the form, used for preview.

### ResolutionStrategySelection

- `custom_strategy` (CustomResolutionStrategy, optional) — A custom resolution strategy defined inline with its resolver methods.
- `native_strategy` (enum, optional) — A built-in resolution strategy. Allowed value: user_resolution_strategy.
  - Allowed values: `user_resolution_strategy`

### ResolverMethodInputMapper

- `resolver_method_id` (string, optional) — ID of the resolver method this mapping applies to. Must match a method ID in the selected strategy.
- `input_mapper` (ResolverMethodInputMapperInputMapper, optional, nullable) — Data mapper from the invocation context, available under 'args', to the resolver method's input schema.

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

### ActionInvocationInputMapper

Data mapping that builds the action's input arguments.

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

### ActionInvocationOutputMapper

Data mapping applied to the action's result.

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

### ConversationKnowledgeDocumentId

ID of the knowledge article to show.

- integer
- string

### CustomResolutionStrategy

- `resolver_methods` (list of ResolverMethod, optional) — Independent methods that can each resolve a value.

### ResolverMethodInputMapperInputMapper

Data mapper from the invocation context, available under 'args', to the resolver method's input schema.

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

### ResolverMethod

- `id` (string, optional) — Unique name of the resolver method. Letters, digits and underscores only, starting with a letter or underscore; up to 64 characters.
- `input_schema` (ResolverMethodInputSchema, optional) — JSON schema describing the inputs this method accepts.
- `dynamic` (DynamicResolver, optional) — Looks up candidate values by running an action.
- `static` (StaticResolver, optional) — Chooses a value from a fixed list of options.

### ResolverMethodInputSchema

JSON schema describing the inputs this method accepts.

### DynamicResolver

- `action_id` (ActionId, optional) — Action this resolver method runs. The action must return synchronously.
- `input_mapper` (DynamicResolverInputMapper, optional, nullable) — Data mapper from the method's inputs to the action's arguments. Input values are available under 'data'.
- `output_mapper` (DynamicResolverOutputMapper, optional, nullable) — Data mapper from the action result, available under 'response', to the resolved value or list of candidate values.
- `produces_multiple_candidates` (boolean, optional) — If true, the method returns a list of candidate values that the user must choose from.

### StaticResolver

- `options` (list of StaticOption, optional) — Fixed candidate values to choose from. At least one is required.

### DynamicResolverInputMapper

Data mapper from the method's inputs to the action's arguments. Input values are available under 'data'.

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

### DynamicResolverOutputMapper

Data mapper from the action result, available under 'response', to the resolved value or list of candidate values.

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

### StaticOption

- `display_name` (string, optional) — Short, user-friendly name for this candidate value.
- `value` (StaticOptionValue, optional, nullable) — The full candidate value.

### StaticOptionValue

The full candidate value.

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

## Examples

**Response**

```json
[
  {
    "id": "3f6c1e2a-8b4d-4c7e-9a1f-2d5b6c7e8f90",
    "signature": {
      "description": "Looks up a purchase order by number and reports its status.",
      "display_name": "Purchase Order Lookup"
    },
    "slots": [
      {
        "name": "po_number",
        "description": "The purchase order number the user is asking about.",
        "type": {
          "primitive": "string"
        },
        "resolution": {
          "must_request": true,
          "value_population_policy": {
            "inference_type": "CONVERSATIONAL_PROCESS_INFERENCE_TYPE_ALWAYS_INFER"
          }
        }
      }
    ],
    "conversation_flow": {
      "sequential": {
        "steps": [
          {
            "activity": {
              "prerequisite_slots": [
                "po_number"
              ],
              "output_slot": "purchase_order",
              "action": {
                "action_id": {
                  "http_action": "1b7d4f5a-2c88-4e0b-9f31-7c5a0d9e4411"
                },
                "input_mapper": {
                  "po_number": "data.po_number"
                }
              },
              "needs_confirmation": false
            }
          },
          {
            "return": {}
          }
        ]
      }
    },
    "updated_time": "2026-11-12T18:04:11Z",
    "updated_by": "admin@example.com",
    "version": {
      "num": 2,
      "change_description": "Initial version."
    }
  }
]
```

**SDK Code**

```python Conversational Processes endpoints_listConversationalProcesses_example
import requests

url = "https://api.moveworks.ai/configurations/v1alpha1/platform/extensions/conversational-processes"

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

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

print(response.json())
```

```javascript Conversational Processes endpoints_listConversationalProcesses_example
const url = 'https://api.moveworks.ai/configurations/v1alpha1/platform/extensions/conversational-processes';
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 Conversational Processes endpoints_listConversationalProcesses_example
package main

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

func main() {

	url := "https://api.moveworks.ai/configurations/v1alpha1/platform/extensions/conversational-processes"

	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 Conversational Processes endpoints_listConversationalProcesses_example
require 'uri'
require 'net/http'

url = URI("https://api.moveworks.ai/configurations/v1alpha1/platform/extensions/conversational-processes")

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 Conversational Processes endpoints_listConversationalProcesses_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/conversational-processes")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php Conversational Processes endpoints_listConversationalProcesses_example
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

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

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

```csharp Conversational Processes endpoints_listConversationalProcesses_example
using RestSharp;

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

```swift Conversational Processes endpoints_listConversationalProcesses_example
import Foundation

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

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