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

# Forms

> Create, read and update Forms through the Moveworks Configuration API: endpoints, fields and examples.

`tool.search.forms`

* **Endpoint:** `/tool/search/forms`  |  **Methods:** GET, PATCH, POST
* **Request shape:** fields go at the top level of the JSON body, with no `resource` wrapper. The item's `id` goes in the URL for reads and updates, not in the body.
* **Updates:** a JSON merge-patch. Send only the fields you change, plus `version: {num, change_description}` with the `num` from your last read. Lists and maps you send replace the stored ones whole.

### Endpoints

All paths are relative to `https://api.moveworks.ai/configurations/v1alpha1`. Each endpoint page lists the request and response schema, an example, and the errors it can return.

| Method  | Path                      | Endpoint reference                                                              |
| ------- | ------------------------- | ------------------------------------------------------------------------------- |
| `GET`   | `/tool/search/forms`      | [List forms](/api-reference/configuration-api/content-forms/forms/list-forms)   |
| `POST`  | `/tool/search/forms`      | [Create form](/api-reference/configuration-api/content-forms/forms/create-form) |
| `GET`   | `/tool/search/forms/{id}` | [Get form](/api-reference/configuration-api/content-forms/forms/get-form)       |
| `PATCH` | `/tool/search/forms/{id}` | [Update form](/api-reference/configuration-api/content-forms/forms/update-form) |

### Fields

| Field          | Type    | Required  | Notes                                                                                                                                                                                                                                                                                                                                                                                                            |
| -------------- | ------- | --------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id`           | string  | read-only | Unique identifier of the forms ingestion configuration, assigned by the server. Cannot be changed.                                                                                                                                                                                                                                                                                                               |
| `name`         | string  | ✅         | Name of this forms ingestion, for your reference.                                                                                                                                                                                                                                                                                                                                                                |
| `connector_id` | string  |           | ID of the connector that forms are ingested from. Cannot be changed after creation. ID of an existing connector (GET /configurations/v1alpha1/platform/connectors).                                                                                                                                                                                                                                              |
| `system`       | enum    |           | External system the forms are ingested from. Must match the system-specific settings provided. Cannot be changed after creation. One of: `EXTERNAL_SYSTEM_SERVICE_NOW`, `EXTERNAL_SYSTEM_JIRA`, `EXTERNAL_SYSTEM_BMC_REMEDY`, `EXTERNAL_SYSTEM_BMC_REMEDY_DWP`, `EXTERNAL_SYSTEM_FRESH_SERVICE`, `EXTERNAL_SYSTEM_IVANTI`, `EXTERNAL_SYSTEM_MANAGE_ENGINE`, `EXTERNAL_SYSTEM_MICROSOFT_DYNAMICS`, … (13 values). |
| `updated_time` | string  | read-only | When the configuration was last updated.                                                                                                                                                                                                                                                                                                                                                                         |
| `updated_by`   | string  | read-only | Who last updated the configuration.                                                                                                                                                                                                                                                                                                                                                                              |
| `version`      | Version | ✅         | Document version. On update, send back the num from your last read.                                                                                                                                                                                                                                                                                                                                              |

Set at most one of `service_now_config`, `jira_config`, `fresh_service_config`, `wolken_config`, `ivanti_config`, `solarwinds_config`, `bmc_remedy_config`, `bmc_remedy_dwp_config`, `manage_engine_config`, `workday_config`, `microsoft_dynamics_config`, `symphony_config`, `gateway_config`.

### Variants (13, pick one)

**`service_now_config`**

Form ingestion settings for ServiceNow.

| Field                   | Type                        | Required | Notes                                                                                                                                      |
| ----------------------- | --------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
| `domain_configs`        | array\<SNOWPerDomainConfig> | ✅        | Form ingestion settings grouped by business domain. Between 1 and 50 entries.                                                              |
| `requester_field_names` | array\<string>              |          | Form field names to pre-populate with the current user, typically 'requested_for' and 'requested_by'.                                      |
| `script_ids_to_ignore`  | array\<string>              |          | sys_ids of client scripts that can safely be ignored. Ignoring them lets more forms be filled natively in chat.                            |
| `custom_url_field`      | string                      |          | Name of an attribute in your instance that holds the full form URL. If set, its value is used as the form URL instead of the URL template. |
| `access_lite_ingestion` | boolean                     |          | If true, all forms redirect users to fill them in the ServiceNow portal instead of in the AI Assistant.                                    |

**`jira_config`**

Form ingestion settings for Jira Service Management.

| Field            | Type                        | Required | Notes                                                                                                                                                            |
| ---------------- | --------------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `domain_configs` | array\<JiraPerDomainConfig> | ✅        | Form ingestion settings grouped by business domain. Between 1 and 50 entries.                                                                                    |
| `url_template`   | string                      |          | End-user facing URL template used to link users to a form in the source system, with \{form_id} as the form placeholder. If blank, a default URL format is used. |

**`fresh_service_config`**

Form ingestion settings for Freshservice.

| Field            | Type                                | Required | Notes                                                                         |
| ---------------- | ----------------------------------- | -------- | ----------------------------------------------------------------------------- |
| `domain_configs` | array\<FreshServicePerDomainConfig> | ✅        | Form ingestion settings grouped by business domain. Between 1 and 50 entries. |

**`wolken_config`**

Form ingestion settings for Wolken.

| Field            | Type                          | Required | Notes                                                                         |
| ---------------- | ----------------------------- | -------- | ----------------------------------------------------------------------------- |
| `domain_configs` | array\<WolkenPerDomainConfig> | ✅        | Form ingestion settings grouped by business domain. Between 1 and 50 entries. |

**`ivanti_config`**

Form ingestion settings for Ivanti.

| Field            | Type                          | Required | Notes                                                                                                                                                            |
| ---------------- | ----------------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `url_template`   | string                        |          | End-user facing URL template used to link users to a form in the source system, with \{form_id} as the form placeholder. If blank, a default URL format is used. |
| `domain_configs` | array\<IvantiPerDomainConfig> | ✅        | Form ingestion settings grouped by business domain. Between 1 and 50 entries.                                                                                    |

**`solarwinds_config`**

Form ingestion settings for SolarWinds.

| Field            | Type                              | Required | Notes                                                                         |
| ---------------- | --------------------------------- | -------- | ----------------------------------------------------------------------------- |
| `domain_configs` | array\<SolarwindsPerDomainConfig> | ✅        | Form ingestion settings grouped by business domain. Between 1 and 50 entries. |

**`bmc_remedy_config`**

Form ingestion settings for BMC Remedy.

| Field            | Type                             | Required | Notes                                                                                                                                                            |
| ---------------- | -------------------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `domain_configs` | array\<BMCRemedyPerDomainConfig> | ✅        | Form ingestion settings grouped by business domain. Between 1 and 50 entries.                                                                                    |
| `url_template`   | string                           |          | End-user facing URL template used to link users to a form in the source system, with \{form_id} as the form placeholder. If blank, a default URL format is used. |

**`bmc_remedy_dwp_config`**

Form ingestion settings for BMC Remedy Digital Workplace.

| Field            | Type                                | Required | Notes                                                                                                                                                            |
| ---------------- | ----------------------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `domain_configs` | array\<BMCRemedyDwpPerDomainConfig> | ✅        | Form ingestion settings grouped by business domain. Between 1 and 50 entries.                                                                                    |
| `url_template`   | string                              |          | End-user facing URL template used to link users to a form in the source system, with \{form_id} as the form placeholder. If blank, a default URL format is used. |

**`manage_engine_config`**

Form ingestion settings for ManageEngine.

| Field                       | Type                                | Required | Notes                                                                                                                                                            |
| --------------------------- | ----------------------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `domain_configs`            | array\<ManageEnginePerDomainConfig> | ✅        | Form ingestion settings grouped by business domain. Between 1 and 50 entries.                                                                                    |
| `url_template`              | string                              |          | End-user facing URL template used to link users to a form in the source system, with \{form_id} as the form placeholder. If blank, a default URL format is used. |
| `map_subject_to_form_title` | boolean                             |          | If true, the ManageEngine 'subject' field is used as the form title. Confirm the 'subject' field is available in your instance first.                            |

**`workday_config`**

Form ingestion settings for Workday.

| Field                        | Type                           | Required | Notes                                                                                                                                                    |
| ---------------------------- | ------------------------------ | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `domain_configs`             | array\<WorkdayPerDomainConfig> | ✅        | Form ingestion settings grouped by business domain. Between 1 and 50 entries.                                                                            |
| `report_name`                | string                         |          | Name of the Workday report that lists all case types (forms).                                                                                            |
| `url_template`               | string                         |          | End-user facing URL that redirects users to the Workday Help Center form, such as Create Case. Varies by tenant. If blank, redirect links are not shown. |
| `include_non_fillable_forms` | boolean                        |          | If true, non-fillable forms are also ingested and shown with their redirect URL. If false, only fillable forms are ingested.                             |

**`microsoft_dynamics_config`**

Form ingestion settings for Microsoft Dynamics.

| Field           | Type                             | Required | Notes                                                                                                                                                     |
| --------------- | -------------------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `url_template`  | string                           |          | End-user facing URL template used to link users to a form, using the form's \{adx_partialurl} as the placeholder. If blank, a default URL format is used. |
| `domain_config` | MicrosoftDynamicsPerDomainConfig |          | Form ingestion settings for Microsoft Dynamics, including the business domain and filters.                                                                |

**`symphony_config`**

Form ingestion settings for Symphony.

| Field            | Type                            | Required | Notes                                                                         |
| ---------------- | ------------------------------- | -------- | ----------------------------------------------------------------------------- |
| `domain_configs` | array\<SymphonyPerDomainConfig> | ✅        | Form ingestion settings grouped by business domain. Between 1 and 50 entries. |

**`gateway_config`**

Form ingestion settings for Gateway.

| Field            | Type           | Required | Notes                                                                       |
| ---------------- | -------------- | -------- | --------------------------------------------------------------------------- |
| `disallowed_ids` | array\<string> |          | Form IDs to exclude from ingestion. Respected regardless of other settings. |

### Example create body

```json
{
  "name": "example-name",
  "connector_id": "<connector-uuid>",
  "system": "EXTERNAL_SYSTEM_SERVICE_NOW",
  "service_now_config": {
    "domain_configs": [
      {
        "domain": "IT_DOMAIN",
        "whitelisted_ids": [
          "<id>"
        ],
        "url_template": "https://example.com/path",
        "order_guide_url_template": "https://example.com/path",
        "disallowed_ids": [
          "<id>"
        ],
        "default_filter": {
          "catalog_ids": [
            "<id>"
          ],
          "ingest_forms_missing_catalog_api_access": true,
          "extra_sys_class_names_to_ingest": [
            "example-name"
          ]
        }
      }
    ],
    "requester_field_names": [
      "example-name"
    ],
    "script_ids_to_ignore": [
      "<id>"
    ],
    "custom_url_field": "https://example.com/path",
    "access_lite_ingestion": true
  },
  "version": {
    "change_description": "Create form"
  }
}
```