> 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 rich text form

GET https://api.moveworks.ai/configurations/v1alpha1/tool/ticket/rich-text-forms/{id}

Returns one rich text form by its `id`.

Reference: https://docs.moveworks.com/api-reference/configuration-api/ticketing/rich-text-forms/get-rich-text-form

## 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 rich text form, as returned when it was created or listed.

## Response

### 200

The rich text form

- `id` (string, optional) — Unique identifier of this configuration, assigned by the server. Send it in update requests to identify the configuration.
- `domain` (enum, optional) — The business domain the form belongs to, such as IT_DOMAIN, HR_DOMAIN or FINANCE_DOMAIN.
  - Allowed values: `IT_DOMAIN`, `HR_DOMAIN`, `FACILITY_DOMAIN`, `FINANCE_DOMAIN`, `LEGAL_DOMAIN`, `OTHER_DOMAIN`, `PAYROLL_DOMAIN`, `PROCUREMENT_DOMAIN`, `TRAVEL_AND_EXPENSE_DOMAIN`, `SALES_DOMAIN`, `HEALTHCARE_DOMAIN`, `LOGISTICS_DOMAIN`
- `form_id` (string, optional) — Your unique identifier for the form. Must not duplicate another form's ID and cannot be changed after creation.
- `title` (string, optional) — The title of the form shown to users.
- `short_description` (string, optional) — A short description of the form.
- `description` (string, optional) — An optional longer description of the form. Up to 1000 characters.
- `fields` (list of TicketFormFieldSettings, optional) — The input fields shown on the form.
- `update_rules` (list of TicketFormUpdateRuleSettings, optional) — Rules that dynamically change field behavior on the form. Rules run in the order defined, so a later rule overrides an earlier one for the same field.
- `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

### TicketFormFieldSettings

- `label` (string, optional) — The primary label displayed for the field.
- `field_name` (string, optional) — The field name from your external system. Must be unique within the form; it identifies the field when the form is submitted.
- `type` (enum, optional) — The input type of the field, such as TEXT, OPTIONS, DATE, USER, MULTI_LINE_TEXT or ATTACHMENT.
  - Allowed values: `TEXT`, `BINARY`, `OPTIONS`, `DATE`, `USER`, `MULTI_LINE_TEXT`, `MULTI_SELECT_USER`, `ATTACHMENT`, `LABEL`, `EMAIL_GROUP`, `MULTI_EMAIL_GROUP`
- `description` (string, optional) — An optional additional description of the field, which may appear as a tooltip.
- `required` (boolean, optional) — If true, the user must fill in this field.
- `read_only` (boolean, optional) — If true, the user cannot edit this field. Not needed for LABEL fields.
- `auto_population_setting` (string, optional) — How the field is automatically populated, for example CURRENT_USER or CURRENT_USER_PHONE_NUMBER. Leave empty or use IGNORE for no auto-population.
- `field_options` (list of TicketFormFieldOptionSettings, optional) — The selectable options for an OPTIONS field. Up to 250 options; note Slack shows at most 100 options per field.
- `default_value` (TicketFormDefaultValueSettings, optional) — The default value of the field. To preselect more than one value, mark defaults in the field options instead.
- `item_ref` (string, optional) — Server-assigned identity of this list item. Leave it unset on create; on update, send back the value from your last read so the item is matched correctly.

### TicketFormUpdateRuleSettings

- `field_update_condition` (TicketFormFieldUpdateConditionSettings, optional) — The condition this rule evaluates against the form's field values.
- `field_updates_when_true` (list of TicketFormFieldUpdateSettings, optional) — Field changes applied when the condition is true.
- `field_updates_when_false` (list of TicketFormFieldUpdateSettings, optional) — Field changes applied when the condition is false.
- `rule_description` (string, optional) — An optional description explaining what the rule does.
- `item_ref` (string, optional) — Server-assigned identity of this list item. Leave it unset on create; on update, send back the value from your last read so the item is matched correctly.

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

### TicketFormFieldOptionSettings

- `label` (string, optional) — The option text displayed to the user.
- `value` (string, optional) — The value submitted when this option is selected.
- `mark_as_default` (boolean, optional) — If true, this option is selected by default.
- `item_ref` (string, optional) — Server-assigned identity of this list item. Leave it unset on create; on update, send back the value from your last read so the item is matched correctly.

### TicketFormDefaultValueSettings

- `label` (string, optional) — The display label of the default value.
- `value` (string, optional) — The default value of the field. Must not contain commas.

### TicketFormFieldUpdateConditionSettings

- `condition_expression` (string, optional) — Condition over field names prefixed with 'field_', for example field_123 IN ['1', '2'] OR field_abc == 'xyz' (written here with single quotes). The expression itself must use double quotes; single quotes are rejected.
- `condition_expression_policy_field_ids` (list of string, optional) — Every field ID referenced in the condition expression, each with the 'field_' prefix (for example field_123).

### TicketFormFieldUpdateSettings

- `policy_field_id` (string, optional) — The field to update, given as its field name with the 'field_' prefix, for example field_title.
- `field_actions` (list of TicketFormFieldActionSettings, optional) — The property changes to apply to the field.
- `item_ref` (string, optional) — Server-assigned identity of this list item. Leave it unset on create; on update, send back the value from your last read so the item is matched correctly.

### TicketFormFieldActionSettings

- `property_required_enabled` (boolean, optional) — Sets whether the field is required: true makes it required, false makes it optional.
- `property_visible_enabled` (boolean, optional) — Sets whether the field is visible: true shows it, false hides it.
- `item_ref` (string, optional) — Server-assigned identity of this list item. Leave it unset on create; on update, send back the value from your last read so the item is matched correctly.

## Examples

**Response**

```json
{
  "id": "3f6c1e2a-8b4d-4c7e-9a1f-2d5b6c7e8f90",
  "domain": "IT_DOMAIN",
  "form_id": "<id>",
  "title": "Example title",
  "short_description": "What this is for",
  "description": "What this is for",
  "fields": [
    {
      "label": "<string>",
      "field_name": "example-name",
      "type": "TEXT",
      "description": "What this is for",
      "required": true,
      "read_only": true,
      "auto_population_setting": "IGNORE",
      "field_options": [
        {
          "label": "<string>",
          "value": "<string>",
          "mark_as_default": true,
          "item_ref": "<string>"
        }
      ],
      "default_value": {
        "label": "<string>",
        "value": "<string>"
      },
      "item_ref": "<string>"
    }
  ],
  "update_rules": [
    {
      "field_update_condition": {
        "condition_expression": "<string>",
        "condition_expression_policy_field_ids": [
          "field_example"
        ]
      },
      "field_updates_when_true": [
        {
          "policy_field_id": "example_name",
          "field_actions": [
            {
              "property_required_enabled": true
            }
          ],
          "item_ref": "<string>"
        }
      ],
      "field_updates_when_false": [
        {
          "policy_field_id": "example_name",
          "field_actions": [
            {
              "property_required_enabled": true
            }
          ],
          "item_ref": "<string>"
        }
      ],
      "rule_description": "What this is for",
      "item_ref": "<string>"
    }
  ],
  "updated_time": "2026-11-12T18:04:11Z",
  "updated_by": "admin@example.com",
  "version": {
    "num": 2,
    "change_description": "Initial setup"
  }
}
```

**SDK Code**

```python Rich Text Forms endpoints_getRichTextForm_example
import requests

url = "https://api.moveworks.ai/configurations/v1alpha1/tool/ticket/rich-text-forms/id"

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

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

print(response.json())
```

```javascript Rich Text Forms endpoints_getRichTextForm_example
const url = 'https://api.moveworks.ai/configurations/v1alpha1/tool/ticket/rich-text-forms/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 Rich Text Forms endpoints_getRichTextForm_example
package main

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

func main() {

	url := "https://api.moveworks.ai/configurations/v1alpha1/tool/ticket/rich-text-forms/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 Rich Text Forms endpoints_getRichTextForm_example
require 'uri'
require 'net/http'

url = URI("https://api.moveworks.ai/configurations/v1alpha1/tool/ticket/rich-text-forms/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 Rich Text Forms endpoints_getRichTextForm_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/ticket/rich-text-forms/id")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php Rich Text Forms endpoints_getRichTextForm_example
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

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

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

```csharp Rich Text Forms endpoints_getRichTextForm_example
using RestSharp;

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

```swift Rich Text Forms endpoints_getRichTextForm_example
import Foundation

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

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