---
title: "GET Pending Reason"
slug: "get-pending-reason-1"
updated: 2026-08-06T12:59:15Z
published: 2026-08-06T12:59:15Z
canonical: "help.symphonysummitai.com/get-pending-reason-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 Pending Reason

The GET Pending Reason Incident Master API retrieves Pending Reason master data from the Incident Management (IM) module. The API response matches the Pending Reason records displayed in the UI.

The API supports the following operations:

- [Retrieve all Pending Reason master records](/apex/docs/get-pending-reason-1#retrieve-list-of-pending-reason-master-records)
- [Retrieve a specific Pending Reason master record by record ID](/apex/docs/get-pending-reason-1#retrieve-pending-reason-master-record-details)

### Retrieve List of Pending Reason Master Records

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

#### Endpoint

`GET /API/v1/Master/IM/PendingReason`

| Component | Value | Description |
| --- | --- | --- |
| **HTTP Method** | GET | Retrieves data from the server. This operation reads data only 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 Pending Reasons, Categories, Priorities, Statuses, and Locations. |
| **Module** | IM | Stands for **Incident Management**. It identifies that the requested master data belongs to the Incident Management module. |
| **Resource** | PendingReason | Specifies the Pending Reason master data resource to retrieve. Pending Reasons show why an Incident is temporarily placed in a pending state. |

#### 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 | `&lt;API_KEY&gt;` | Yes | API key for authentication and authorization. |

#### Sample Request

The following cURL request sends an HTTP GET request to retrieve all Pending Reason master records. The request includes the Accept header to specify JSON as the expected response format and the X-Api-Key header to authenticate the caller.

Replace `&lt;API_KEY&gt;` with a valid API key before sending the request. Replace `{host}` with the appropriate server address when calling the API from another environment.

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

#### Sample Response

The following sample response returns an array of Pending Reason master records. Each object represents one Pending Reason configured in the Incident Management module. `Value` uniquely identifies the record, `Text` provides its display name, and `Active` indicates whether the Pending Reason is available for use. `Instance` and `Instance_Text` identify the application instance associated with the record.

```json
[
  {
    "Value": 1001,
    "Text": "Awaiting User Response",
    "Active": true,
    "Instance": 1,
    "Instance_Text": "Production"
  },
  {
    "Value": 1002,
    "Text": "Awaiting Vendor Response",
    "Active": true,
    "Instance": 1,
    "Instance_Text": "Production"
  }
]
```

#### Response Fields

The Pending Reason master list exposes the following fields:

| Field | Type | Example Value | Description |
| --- | --- | --- | --- |
| Value | Integer | 1001 | Unique value or identifier of the Pending Reason record. |
| Text | String | `"Awaiting User Response"` | Display name of the Pending Reason. |
| Active | Boolean | `true` | Indicates whether the Pending Reason record is active and available for use. |
| Instance | Integer or String | 1 | Identifier of the instance associated with the Pending Reason. |
| Instance_Text | String | `"Production"` | Display name of the instance associated with the Pending Reason. |

#### Business Use Cases

| Scenario | Resolution |
| --- | --- |
| An integration needs valid Pending Reason values before placing an Incident in a pending state. | Call the GET Pending Reason Incident Master API to retrieve the configured Pending Reason records. Use the returned Pending Reason identifier in the Incident update request. |
| An external system stores Pending Reason mappings for Incident synchronization. | Call the API to retrieve the latest Pending Reason master records and synchronize them with the external system's mapping table. |
| An automated process receives a Pending Reason name but requires its unique identifier. | Retrieve the Pending Reason master list, locate the record with the matching name, and use its `Value` in the next Incident API request. |
| A scheduled integration must keep Pending Reason reference data up to date. | Call the API at scheduled intervals and compare the response with the Pending Reason records stored in the consuming system. Add, update, or deactivate mappings as required. |
| An integration must verify a Pending Reason before submitting an Incident request. | Call the API and confirm that the Pending Reason exists and that its `Active` value is `true`. This prevents the integration from submitting an invalid or inactive Pending Reason. |
| An integrated application must populate a Pending Reason selection field. | Retrieve the active Pending Reason records and use their `Text` values as labels and their `Value` values as identifiers. |
| You are migrating Incident data from another system. | Retrieve all valid Pending Reason records and map the source-system pending reasons to the corresponding Pending Reason identifiers before migrating the Incident records. |
| An integration supports many application instances. | Use the `Instance` and `Instance_Text` values to associate each Pending Reason with the correct instance during synchronization or Incident processing. |

### Expected Result

- Returns HTTP 200 OK.
- Returns all available Pending Reason master records configured for Incident Management.
- Returns details for each Pending Reason, including its identifier, display name, active status, and instance information.

#### Sample Expected Result

The API successfully retrieves the list of Pending Reason master records configured for Incident Management.

```json
[
  {
    "Value": 1001,
    "Text": "Awaiting User Response",
    "Active": true,
    "Instance": 1,
    "Instance_Text": "Production"
  },
  {
    "Value": 1002,
    "Text": "Awaiting Vendor Response",
    "Active": true,
    "Instance": 1,
    "Instance_Text": "Production"
  }
]
```

### Retrieve Pending Reason Master Record Details

This endpoint retrieves the details of a specific Pending Reason master record by using its unique record ID.

#### Endpoint

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

| Component | Value | Description |
| --- | --- | --- |
| **HTTP Method** | GET | Retrieves data from the server. This operation reads data only 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 as new API versions arrive. |
| **Resource Group** | Master | Refers to the Master Data module, which contains reusable reference data. |
| **Module** | IM | Stands for **Incident Management**. It identifies that the requested master data belongs to the Incident Management module. |
| **Resource** | PendingReason | Specifies the Pending Reason master data resource to retrieve. |
| **Record Identifier** | `{recordId}` | The unique identifier of the Pending Reason record to retrieve. Replace this placeholder with an actual record ID, such as `1001`. |

#### Path Parameter

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| recordId | Integer | Yes | Unique identifier of the Pending Reason master record. |

#### 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 | `&lt;API_KEY&gt;` | Yes | Provides the API key to authenticate the caller and grant access to the endpoint. |

#### Sample Request

The following request retrieves the Pending Reason master record with the record ID `1001`. Supply `recordId` as a path parameter in the endpoint URL to identify the specific Pending Reason record.

Use this request when an integration or automated process needs the configuration details of a known Pending Reason. Replace `1001` with the record ID that you want to retrieve. Replace `&lt;API_KEY&gt;` with a valid API key. Replace `{host}` with the appropriate server address when calling the API from another environment.

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

#### Sample Response

The response returns the Pending Reason master record whose `Value` matches the record ID specified in the request URL.

```json
{
  "Value": 1001,
  "Text": "Awaiting User Response",
  "Active": true,
  "Instance": 1,
  "Instance_Text": "Production"
}
```

In this example, the API returns the Pending Reason named **Awaiting User Response** with the following configuration:

| Field | Value | Description |
| --- | --- | --- |
| Value | 1001 | Uniquely identifies the Pending Reason record. |
| Text | Awaiting User Response | Specifies the display name of the Pending Reason. |
| Active | `true` | Indicates that the Pending Reason is active and available for use. |
| Instance | 1 | Identifies the application instance associated with the Pending Reason. |
| Instance_Text | Production | Provides the display name of the associated application instance. |

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

> [!NOTE]
> Note
> 
> The `Active` field shows whether the Pending Reason is available for use. The `Instance` and `Instance_Text` fields identify the associated application instance. Retrieving a Pending Reason does not place an Incident in a pending state. The endpoint only returns master configuration data.

Use this response when you need the details of a specific Pending Reason, such as verifying its active status or instance association for a known record ID.

#### Business Use Cases

| Scenario | Resolution |
| --- | --- |
| An external system receives an Incident that contains a Pending Reason record ID. | Retrieve the specific Pending Reason record to get its name and configuration before processing or synchronizing the Incident. |
| An integration must check a Pending Reason before updating an Incident. | Retrieve the Pending Reason by `recordId` and verify that the returned record is the intended Pending Reason and is active before including the identifier in the Incident request. |
| A synchronization process detects that one Pending Reason record has changed. | Retrieve only the affected Pending Reason record and update its mapping in the target system without retrieving the complete Pending Reason master list. |
| An Incident imported from another system contains an existing Pending Reason mapping. | Retrieve the mapped Pending Reason record to confirm that the stored record ID still corresponds to the expected Pending Reason. |
| An automated workflow must apply rules based on a Pending Reason's configuration. | Retrieve the Pending Reason record and check its active status and instance information before continuing the workflow. |
| A reporting system contains a Pending Reason ID but not its descriptive name. | Retrieve the Pending Reason record and use its `Text` value to associate the Pending Reason name with the ID in reports or exported data. |
| An integration must verify the instance associated with a known Pending Reason. | Retrieve the Pending Reason record and check `Instance` and `Instance_Text` before using it in instance-specific processing. |
| A Pending Reason mapping fails during Incident processing. | Retrieve the Pending Reason using the mapped `recordId` and compare the returned values with the mapping stored in the external system to identify the mismatch. |

### Expected Result

- Returns HTTP 200 OK.
- Returns the Pending Reason master record that matches the specified `recordId`.
- Returns the Pending Reason identifier, display name, active status, and instance information.

#### Sample Expected Result

The API successfully retrieves the Pending Reason record with the record ID `1001`.

```json
{
  "Value": 1001,
  "Text": "Awaiting User Response",
  "Active": true,
  "Instance": 1,
  "Instance_Text": "Production"
}
```

### 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/PendingReason' \
--request GET \
--header 'Accept: application/json'
```

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

#### 404 Not Found

Returned when the requested Pending Reason record ID does not exist or the endpoint path is incorrect.

The following request attempts to retrieve a Pending Reason record with the record ID `9999`:

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

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