---
title: "GET Resolution Code"
slug: "get-resolution-code-1"
updated: 2026-08-06T12:54:57Z
published: 2026-08-06T12:54:57Z
canonical: "help.symphonysummitai.com/get-resolution-code-1"
stale: true
---

> ## Documentation Index
> Fetch the complete documentation index at: https://help.symphonysummitai.com/llms.txt
> Use this file to discover all available pages before exploring further.

# GET Resolution Code

The GET Resolution Code Incident Master API retrieves Resolution Code master data from the Incident Management (IM) module. The API response represents the Resolution Code records configured in the system.

The API supports the following operations:

- [Retrieve all Resolution Code master records](/apex/docs/get-resolution-code-1#retrieve-list-of-resolution-code-master-records)
- [Retrieve a specific Resolution Code master record by record ID](/apex/docs/get-resolution-code-1#retrieve-resolution-code-master-record-details)

## Retrieve List of Resolution Code Master Records

This endpoint retrieves all Resolution Code master records configured in the Incident Management module. Administrators, integrations, and automation tools can use the endpoint for configuration review, validation, reporting, synchronization, and downstream processing.

### Endpoint

`GET /API/v1/Master/IM/ResolutionCode`

| Component | Value | Description |
| --- | --- | --- |
| **HTTP Method** | GET | Retrieves data from the server. This is a read-only operation and does not create, update, or delete records. |
| **API** | API | Stands for **Application Programming Interface**. It provides a standard way for applications to communicate with the system and exchange data. |
| **Version** | v1 | Indicates Version 1 of the API. Versioning helps maintain compatibility when developers introduce new API versions. |
| **Resource Group** | Master | Refers to the Master Data module, which contains reusable reference data such as Categories, Priorities, Statuses, and Resolution Codes. |
| **Module** | IM | Stands for **Incident Management**. It identifies that the requested master data belongs to the Incident Management module. |
| **Resource** | ResolutionCode | Specifies the Resolution Code master data resource. Resolution Codes classify the methods used to resolve Incidents. |

### Request Headers

```json
{
  "Accept": "application/json",
  "X-Api-Key": "{API_KEY}"
}
```

| Header | Value | Required | Description |
| --- | --- | --- | --- |
| Accept | `application/json` | Yes | Requests the API to return the response in JSON format. |
| X-Api-Key | `{API_KEY}` | Yes | API key used to authenticate and approve the caller. |

### Sample Request

The following cURL request retrieves all Resolution Code master records. Replace `{host}` with the appropriate server address and `{API_KEY}` with a valid API key.

```bash
curl --location 'https://{host}/API/v1/Master/IM/ResolutionCode' \
  --request GET \
  --header 'Accept: application/json' \
  --header 'X-Api-Key: {API_KEY}'
```

### Sample Response

The response returns an array of Resolution Code master records. Each object represents one Resolution Code configured in the Incident Management module.

```json
[
  {
    "Value": 1001,
    "Active": true,
    "Instance": "Info",
    "Instance_Text": "Info",
    "Text": "Resolved Successfully"
  },
  {
    "Value": 1002,
    "Active": true,
    "Instance": "Info",
    "Instance_Text": "Info",
    "Text": "Workaround Provided"
  }
]
```

### Response Fields

| Field | Type | Example Value | Description |
| --- | --- | --- | --- |
| Value | Integer | `1001` | Unique value or identifier of the Resolution Code record. |
| Active | Boolean | `true` | Indicates whether the Resolution Code record is active and available for use. |
| Instance | String or Integer | `"Info"` | Identifier of the instance associated with the Resolution Code. The returned data type depends on system configuration. |
| Instance_Text | String | `"Info"` | Display name of the instance associated with the Resolution Code. |
| Text | String | `"Resolved Successfully"` | Display name or text value of the Resolution Code. |

### Business Use Cases

| Scenario | Resolution |
| --- | --- |
| An integration needs valid Resolution Code values before resolving an Incident. | Retrieve the configured Resolution Code records and use an active returned identifier in the relevant Incident request. |
| An external system stores Resolution Code mappings for Incident synchronization. | Retrieve the latest records and synchronize them with the external system's mapping table. |
| An automated process receives a Resolution Code name but requires its identifier. | Retrieve the master list, locate the record whose `Text` matches the supplied name, and use its `Value` in the next API request. |
| A scheduled integration must keep Resolution Code reference data current. | Call the API at scheduled intervals and compare the response with stored records. Add, update, or deactivate mappings as required. |
| An integration must check a Resolution Code before using it. | Confirm that the Resolution Code exists and that `Active` is `true` before submitting the dependent Incident request. |
| An integration migrates incident data from another system. | Retrieve valid Resolution Codes and map source-system values to the corresponding identifiers before migrating Incident records. |
| An integration supports many application instances. | Use `Instance` and `Instance_Text` to associate each Resolution Code with the correct instance. |
| A reporting or automation process requires Resolution Code details. | Use the returned values for validation, mapping, reporting, and downstream processing. |

### Expected Result

- Returns HTTP `200 OK`.
- Returns all available Resolution Code master records configured for Incident Management.
- Returns the identifier, active status, instance information, and display text for each Resolution Code.

### Sample Expected Result

```json
[
  {
    "Value": 1001,
    "Active": true,
    "Instance": "Info",
    "Instance_Text": "Info",
    "Text": "Resolved Successfully"
  },
  {
    "Value": 1002,
    "Active": true,
    "Instance": "Info",
    "Instance_Text": "Info",
    "Text": "Workaround Provided"
  }
]
```

## Retrieve Resolution Code Master Record Details

This endpoint retrieves a specific Resolution Code master record by using its unique record ID.

### Endpoint

`GET /API/v1/Master/IM/ResolutionCode/{recordId}`

| Component | Value | Description |
| --- | --- | --- |
| **HTTP Method** | GET | Retrieves data from the server. This is a read-only operation and does not create, update, or delete records. |
| **API** | API | Stands for **Application Programming Interface**. |
| **Version** | v1 | Indicates Version 1 of the API. |
| **Resource Group** | Master | Refers to the Master Data module. |
| **Module** | IM | Identifies the Incident Management module. |
| **Resource** | ResolutionCode | Specifies the Resolution Code master data resource. |
| **Record Identifier** | `{recordId}` | Unique identifier of the Resolution Code record. Replace the placeholder with an actual record ID, such as `1001`. |

### Path Parameter

| Parameter | Type | Required | Description | Example |
| --- | --- | --- | --- | --- |
| recordId | Integer or string | Yes | Unique identifier of the Resolution Code master record. | `1001` |

### Request Headers

```json
{
  "Accept": "application/json",
  "X-Api-Key": "{API_KEY}"
}
```

| Header | Value | Required | Description |
| --- | --- | --- | --- |
| Accept | `application/json` | Yes | Requests the API to return the response in JSON format. |
| X-Api-Key | `{API_KEY}` | Yes | Provides the API key used to authenticate and approve the caller. |

### Sample Request

Replace `1001` with the required record ID, `{host}` with the appropriate server address, and `{API_KEY}` with a valid API key.

```bash
curl --location 'https://{host}/API/v1/Master/IM/ResolutionCode/1001' \
  --request GET \
  --header 'Accept: application/json' \
  --header 'X-Api-Key: {API_KEY}'
```

### Sample Response

The response returns the Resolution Code master record whose identifier matches the value specified in the request URL.

```json
{
  "Value": 1001,
  "Active": true,
  "Instance": "Info",
  "Instance_Text": "Info",
  "Text": "Resolved Successfully"
}
```

### Response Field Details

| Field | Value | Description |
| --- | --- | --- |
| Value | `1001` | Uniquely identifies the Resolution Code record. |
| Active | `true` | Indicates that the Resolution Code is active and available for use. |
| Instance | `Info` | Identifies the instance associated with the Resolution Code. |
| Instance_Text | `Info` | Provides the display name of the associated instance. |
| Text | `Resolved Successfully` | Specifies the display name of the Resolution Code. |

An integration can use these values to verify the Resolution Code configuration before using its identifier in another Incident Management API request.

### Business Use Cases

| Scenario | Resolution |
| --- | --- |
| An external system receives an Incident containing a Resolution Code identifier. | Retrieve the specific Resolution Code to get its name and configuration before processing or synchronizing the Incident. |
| An integration must check a Resolution Code before resolving an Incident. | Retrieve the record by `recordId` and confirm that it returns the intended Resolution Code and that `Active` is `true`. |
| A synchronization process detects that one Resolution Code has changed. | Retrieve only the affected record and update its mapping without retrieving the complete master list. |
| An imported Incident contains an existing Resolution Code mapping. | Retrieve the mapped record to confirm that the stored identifier still corresponds to the expected Resolution Code. |
| A reporting system contains a Resolution Code identifier but not its descriptive name. | Retrieve the record and use `Text` to associate the display name with the identifier in reports or exports. |
| A Resolution Code mapping fails during Incident processing. | Retrieve the record by `recordId` and compare the returned values with the external system's stored mapping. |
| An automated workflow must apply instance-specific rules. | Use `Instance` and `Instance_Text` to verify that the Resolution Code belongs to the expected application instance. |

### Expected Result

- Returns HTTP `200 OK`.
- Returns the Resolution Code master record that matches the specified `recordId`.
- Returns the record identifier, active status, instance information, and display text.

### Sample Expected Result

```json
{
  "Value": 1001,
  "Active": true,
  "Instance": "Info",
  "Instance_Text": "Info",
  "Text": "Resolved Successfully"
}
```

### Error Responses

#### 401 Unauthorized

Returned when the request does not include a valid API key or the caller does not have authenticated access.

The following request does not include the required `X-Api-Key` header:

```bash
curl --location '{host}/API/v1/Master/IM/ResolutionCode' \
--request GET \
--header 'Accept: application/json'
```

```json
{
  "message": "Unauthorized",
  "errorCode": 401,
  "details": "Valid API credentials are required."
}
```

#### 404 Not Found

Returned when the requested Resolution Code record ID does not exist or the endpoint path is incorrect.

The following request attempts to retrieve a Resolution Code record with the record ID `9999`:

```bash
curl --location '{host}/API/v1/Master/IM/ResolutionCode/9999' \
--request GET \
--header 'Accept: application/json' \
--header 'X-Api-Key: {API_KEY}'
```

```json
{
  "message": "Record not found",
  "errorCode": 404,
  "details": "The requested Resolution Code record was not found."
}
```