> 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 ticket type mapper

GET https://api.moveworks.ai/configurations/v1alpha1/tool/ticket/integration/field-mappers/{id}

Returns one ticket type mapper by its `id`.

Reference: https://docs.moveworks.com/api-reference/configuration-api/ticketing/ticket-integration-mappers-ticket-types/get-ticket-type-mapper

## 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 ticket type mapper, as returned when it was created or listed.

## Response

### 200

The ticket type mapper

- `id` (string, optional) — Unique ID of this configuration, assigned by the server.
- `connector_id` (string, optional) — Connector for the ticketing system whose ticket types these settings describe. Cannot be changed after creation. ID of an existing connector (GET /configurations/v1alpha1/platform/connectors).
- `ticket_types` (list of TicketTypeSettings, optional) — Settings for each ticket type in the ticketing system. A ticket type may appear more than once.
- `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

### TicketTypeSettings

- `type` (enum, optional) — Moveworks ticket type these settings apply to. Allowed values: INCIDENT, REQUEST, REQUEST_ITEM, CALL, TASK, MISC, UNIVERSAL_REQUEST, HR_CASE.
  - Allowed values: `INCIDENT`, `REQUEST`, `REQUEST_ITEM`, `CALL`, `TASK`, `MISC`, `UNIVERSAL_REQUEST`, `HR_CASE`
- `prefix` (string, optional) — Ticket number prefix. Some systems use it to determine the ticket type; otherwise it is shown to the requesting user.
- `table_name` (string, optional) — External table this ticket type is read from. For Zendesk, an empty value is valid.
- `domain` (string, optional) — Business domain of this ticket type. Currently used only for Zendesk. Allowed values: IT_DOMAIN, HR_DOMAIN, FACILITY_DOMAIN, FINANCE_DOMAIN, LEGAL_DOMAIN, PAYROLL_DOMAIN, PROCUREMENT_DOMAIN, TRAVEL_AND_EXPENSE_DOMAIN.
- `requestor_column_name` (string, optional) — Column in the ServiceNow ticket table that identifies the requestor.
- `ticket_external_url_template` (string, optional) — URL template for the link to the ticket shown to the requesting user.
- `ticket_agent_url_template` (string, optional) — URL template for the link to the ticket shown to agents.
- `states` (TicketTypeStatesSettings, optional) — How this ticket type's states map to Moveworks ticket states.
- `ticket_destination_id` (string, optional) — Ticket destination this ticket type is filed to. ID of an existing ticket_integration_destination (GET /configurations/v1alpha1/tool/ticket/integration/destinations).
- `ticket_fields_mapper` (TicketFieldsMapperByActionsSettings, optional) — Field mappings used for each ticket action: create, query, update, resolve and reopen.
- `jira_service_desk_id` (string, optional) — ID of the Jira service desk for this ticket type.
- `jira_transitions` (TicketTypeTransitionsSettings, optional) — Jira workflow transitions used to move tickets of this type between states.
- `retain_state_on_user_comment_enabled` (boolean, optional) — If true, a Jira issue keeps its current state when the user adds a comment.
- `additional_query_parameter_filter` (string, optional) — Extra filter added to API calls when polling tickets of this type. ServiceNow only.
- `item_ref` (string, optional) — Server-assigned identity of this list entry. Leave empty on create; send back the value from your last read on update so the entry 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.

### TicketTypeStatesSettings

- `internal_states` (TicketTypeInternalStatesSettings, optional) — Explicit mapping between Moveworks states and the ticketing system's states. Set this or use_same_as_ticket_destination.
- `use_same_as_ticket_destination` (string, optional) — Ticket destination whose state mapping to reuse. Set this or internal_states. ID of an existing ticket_integration_destination (GET /configurations/v1alpha1/tool/ticket/integration/destinations).

### TicketFieldsMapperByActionsSettings

- `create_ticket` (TicketCreateMapperSettings, optional) — Field mapping used when creating a ticket.
- `query_ticket` (TicketQueryMapperSettings, optional) — Field mapping used when reading tickets from the ticketing system.
- `update_ticket` (TicketUpdateMapperSettings, optional) — Field mapping used when updating a ticket.
- `resolve_ticket` (TicketResolveMapperSettings, optional) — Field mappings used when resolving a ticket.
- `reopen_ticket` (TicketReopenMapperSettings, optional) — Field mapping used when reopening a ticket.

### TicketTypeTransitionsSettings

- `jira_transitions` (TicketTypeJiraTransitionsSettings, optional) — Explicit list of Jira transitions. Set this or use_same_as_ticket_destination.
- `use_same_as_ticket_destination` (string, optional) — Ticket destination whose Jira transitions to reuse. Set this or jira_transitions. ID of an existing ticket_integration_destination (GET /configurations/v1alpha1/tool/ticket/integration/destinations).

### TicketTypeInternalStatesSettings

- `internal_states` (list of TicketTypeInternalStateSettings, optional) — One entry per Moveworks state, mapping it to and from the ticketing system's states.

### TicketCreateMapperSettings

- `output_field_map` (TicketFieldsMapperSettings, optional) — Mapping of ticket fields sent to the ticketing system when creating a ticket.

### TicketQueryMapperSettings

- `parse_field_map_with_input_fields` (TicketFieldsMapperWithInputFieldsSettings, optional) — Mapping, with its input fields, used to parse tickets read from the ticketing system.

### TicketUpdateMapperSettings

- `output_field_map` (TicketFieldsMapperSettings, optional) — Mapping of ticket fields sent to the ticketing system when updating a ticket.

### TicketResolveMapperSettings

- `output_field_map` (TicketFieldsMapperSettings, optional) — Mapping of ticket fields sent to the ticketing system when resolving a ticket.
- `update_if_empty_field_map` (TicketFieldsMapperSettings, optional) — Mapping of ticket fields set on resolve only if they are currently empty.

### TicketReopenMapperSettings

- `output_field_map` (TicketFieldsMapperSettings, optional) — Mapping of ticket fields sent to the ticketing system when reopening a ticket.

### TicketTypeJiraTransitionsSettings

- `jira_transitions` (list of TicketTypeJiraTransitionSettings, optional) — Jira transitions, each moving a ticket to a Moveworks state.

### TicketTypeInternalStateSettings

- `name` (enum, optional) — Moveworks ticket state being mapped. Allowed values: NEW, WIP, WAITING_FOR_USER, WAITING_FOR_VENDOR, WAITING_FOR_APPROVAL, CLOSED, RESOLVED, NOT_APPLICABLE.
  - Allowed values: `NEW`, `WIP`, `WAITING_FOR_USER`, `WAITING_FOR_VENDOR`, `WAITING_FOR_APPROVAL`, `CLOSED`, `RESOLVED`, `NOT_APPLICABLE`
- `from_external_states` (TicketTypeFromExternalStatesSettings, optional) — Ticketing system states that map to this Moveworks state.
- `to_external_state` (TicketTypeToExternalStatesSettings, optional) — Value written to the ticketing system when a ticket moves to this Moveworks state.
- `item_ref` (string, optional) — Server-assigned identity of this list entry. Leave empty on create; send back the value from your last read on update so the entry is matched correctly.

### TicketFieldsMapperSettings

- `use_same_as` (string, optional) — Ticket destination whose field mapping to reuse. Set this or mapper_bender. ID of an existing ticket_integration_destination (GET /configurations/v1alpha1/tool/ticket/integration/destinations).
- `mapper_bender` (TicketFieldsMapperSettingsMapperBender, optional) — Field mapping, in Moveworks data mapper JSON. Set this or use_same_as.

### TicketFieldsMapperWithInputFieldsSettings

- `use_same_as` (string, optional) — Ticket destination whose query mapping to reuse. Set this or mapper_with_input_fields. ID of an existing ticket_integration_destination (GET /configurations/v1alpha1/tool/ticket/integration/destinations).
- `mapper_with_input_fields` (TicketMapperWithInputFieldsSettings, optional) — Custom query mapping and the input fields it reads. Set this or use_same_as.

### TicketTypeJiraTransitionSettings

- `target_state` (enum, optional) — Moveworks ticket state this transition moves the ticket to. Allowed values: NEW, WIP, WAITING_FOR_USER, WAITING_FOR_VENDOR, WAITING_FOR_APPROVAL, CLOSED, RESOLVED, NOT_APPLICABLE.
  - Allowed values: `NEW`, `WIP`, `WAITING_FOR_USER`, `WAITING_FOR_VENDOR`, `WAITING_FOR_APPROVAL`, `CLOSED`, `RESOLVED`, `NOT_APPLICABLE`
- `source_states` (list of string, optional) — Jira states this transition can be applied from.
- `transition_id` (string, optional) — ID of the Jira workflow transition.
- `item_ref` (string, optional) — Server-assigned identity of this list entry. Leave empty on create; send back the value from your last read on update so the entry is matched correctly.

### TicketTypeFromExternalStatesSettings

- `proto_state_field_to_use` (string, optional) — Ticket field to read the state from. ServiceNow only.
- `values` (list of string, optional) — Ticketing system state values that map to this Moveworks state.
- `wolken_sub_state_value` (string, optional) — Wolken sub-state value that maps to this Moveworks state.
- `wolken_sub_state_values` (list of string, optional) — Wolken sub-state values that map to this Moveworks state.

### TicketTypeToExternalStatesSettings

- `column` (string, optional) — Field to set in the ticketing system. ServiceNow only.
- `value` (string, optional) — Value set in the ticketing system when moving a ticket to this state.
- `wolken_sub_state_value` (string, optional) — Wolken sub-state value set when moving a ticket to this state.

### TicketFieldsMapperSettingsMapperBender

Field mapping, in Moveworks data mapper JSON. Set this or use_same_as.

### TicketMapperWithInputFieldsSettings

- `mapper_bender` (TicketMapperWithInputFieldsSettingsMapperBender, optional) — Mapping of ticket attributes, in Moveworks data mapper JSON.
- `mapper_input_fields` (list of string, optional) — Fields queried from the ticketing system and passed to the mapping.
- `ticket_id_field` (string, optional) — Raw ticket field that holds the ticket ID, used to look up a single ticket in the ticketing system.
- `additional_query_param_filter` (string, optional) — Extra filter added to API calls when polling tickets. ServiceNow only.

### TicketMapperWithInputFieldsSettingsMapperBender

Mapping of ticket attributes, in Moveworks data mapper JSON.

## Examples

**Response**

```json
{
  "id": "3f6c1e2a-8b4d-4c7e-9a1f-2d5b6c7e8f90",
  "connector_id": "<connector-uuid>",
  "ticket_types": [
    {
      "type": "INCIDENT",
      "prefix": "<string>",
      "table_name": "incident",
      "domain": "IT_DOMAIN",
      "requestor_column_name": "example-name",
      "ticket_external_url_template": "https://example.com/path",
      "ticket_agent_url_template": "https://example.com/path",
      "states": {
        "internal_states": {}
      },
      "ticket_destination_id": "<destination-uuid>",
      "ticket_fields_mapper": {
        "create_ticket": {},
        "query_ticket": {},
        "update_ticket": {},
        "resolve_ticket": {},
        "reopen_ticket": {}
      },
      "jira_service_desk_id": "<id>",
      "jira_transitions": {
        "jira_transitions": {}
      },
      "retain_state_on_user_comment_enabled": true,
      "additional_query_parameter_filter": "<string>",
      "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 Ticket Integration Mappers (Ticket Types) endpoints_getTicketTypeMapper_example
import requests

url = "https://api.moveworks.ai/configurations/v1alpha1/tool/ticket/integration/field-mappers/id"

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

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

print(response.json())
```

```javascript Ticket Integration Mappers (Ticket Types) endpoints_getTicketTypeMapper_example
const url = 'https://api.moveworks.ai/configurations/v1alpha1/tool/ticket/integration/field-mappers/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 Ticket Integration Mappers (Ticket Types) endpoints_getTicketTypeMapper_example
package main

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

func main() {

	url := "https://api.moveworks.ai/configurations/v1alpha1/tool/ticket/integration/field-mappers/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 Ticket Integration Mappers (Ticket Types) endpoints_getTicketTypeMapper_example
require 'uri'
require 'net/http'

url = URI("https://api.moveworks.ai/configurations/v1alpha1/tool/ticket/integration/field-mappers/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 Ticket Integration Mappers (Ticket Types) endpoints_getTicketTypeMapper_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/integration/field-mappers/id")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php Ticket Integration Mappers (Ticket Types) endpoints_getTicketTypeMapper_example
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

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

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

```csharp Ticket Integration Mappers (Ticket Types) endpoints_getTicketTypeMapper_example
using RestSharp;

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

```swift Ticket Integration Mappers (Ticket Types) endpoints_getTicketTypeMapper_example
import Foundation

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

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