# Get Alert By Plan Id

### Endpoint Information

* **URL**: \<your-gateway-url>/alert/plan/{planId}
* **Method**: `GET`
* **Authentication**: Required (`Bearer Token`)

### Response Body

```
{
    "data": [
        {
            "id": 173,
            "planId": 766,
            "alertType": "EMAIL",
            "target": "demo@testinium.com",
            "targetId": null,
            "targetType": null,
            "alertSendingStatus": "Beginning of the Each Execution",
            "alertSendingStatusResult": null,
            "language": null,
            "targetTimeZone": null,
            "enabled": true,
            "unsubscribeLinkEliminated": false
        },
        {
            "id": null,
            "planId": 766,
            "alertType": "EMAIL",
            "target": "demo@testinium.com",
            "targetId": null,
            "targetType": null,
            "alertSendingStatus": "End of the Each Execution",
            "alertSendingStatusResult": [
                {
                    "id": 171,
                    "name": "Test Successful"
                }
            ],
            "language": null,
            "targetTimeZone": null,
            "enabled": true,
            "unsubscribeLinkEliminated": false
        }
    ],
    "result": {
        "code": 0,
        "message": "success"
    }
}
```

| Parameter                 | Type     | Description                                                                  |
| ------------------------- | -------- | ---------------------------------------------------------------------------- |
| alertType                 | `String` | Type of alert to send                                                        |
| alertSendingStatus        | `String` | Defines when the alert will be triggered                                     |
| target                    | `String` | Recipient of the alert.                                                      |
| alertSendingStatusResults | `Array`  | List of test result statuses for which alerts should be sent                 |
| targetId                  | `Long`   | Optional ID referencing a predefined alert target in the system.             |
| targetType                | String   | Optional target type                                                         |
| language                  | String   | Language code for the alert message content (e.g., "en", "tr").              |
| targetTimeZone            | String   | Time zone for scheduling or timestamp adjustments (e.g., "Europe/Istanbul"). |

| Parameter      | Type    | Description                                                                       |
| -------------- | ------- | --------------------------------------------------------------------------------- |
| data           | Object  | The payload of the response. In this case `null` since no extra data is returned. |
| result         | Object  | Contains details about the outcome of the operation.                              |
| result.code    | Integer | The result code (e.g., `0` indicates success).                                    |
| result.message | String  | A message describing the outcome (e.g., `"success"`).                             |

### Error Codes

| HTTP Code | Error Message           | Description                                                                  |
| --------- | ----------------------- | ---------------------------------------------------------------------------- |
| 401       | `UNAUTHORIZED`          | The request lacks valid authentication credentials. Check your Bearer token. |
| `400`     | `INVALID_REQUEST`       | The request was malformed or contained errors.                               |
| `500`     | `INTERNAL_SERVER_ERROR` | An unexpected error occurred on the server side.                             |

### Example Request

```
curl --location --request GET '<your-gateway-url>/alert/plan/{planId}' \
--header 'accept: application/json, text/plain, */*' \
--header 'authorization: Bearer <your_access_token>' \
--header 'content-type: application/json' \
--data-raw '{
  "alertType": "EMAIL",
  "alertSendingStatus": "Beginning of the Each Execution",
  "target": "furkan.kartal@testinium.com",
  "alertSendingStatusResults": [],
  "targetId": null,
  "targetType": null,
  "language": null,
  "targetTimeZone": null
}'
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://testinium.gitbook.io/testinium-enterprise/apis/enterprise-2.0/plan/get-alert-by-plan-id.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.