> For the complete documentation index, see [llms.txt](https://sitasys-ag.gitbook.io/evalink-talos/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://sitasys-ag.gitbook.io/evalink-talos/alarm-api/query-alarms.md).

# Query alarms

Receiving a list of the currently active alarms within your company in evalink talos is one of the most important API Requests you might need to use in your interactions with the service.

## get a list of alarms for your company

<mark style="color:blue;">`GET`</mark> `https:://talos-app.io/api/alarm-service/alarms/search/findByCompanyId:companyId`

Use this endpoint to receive a list of active alarms in evalink talos for a specific company.

#### Query Parameters

| Name      | Type   | Description                                                            |
| --------- | ------ | ---------------------------------------------------------------------- |
| companyId | string | The Company ID, as it is displayed on the evalink talos Web Interface. |

#### Headers

| Name          | Type   | Description                              |
| ------------- | ------ | ---------------------------------------- |
| Authorization | string | Use 'Bearer' followed by your API token. |

{% tabs %}
{% tab title="200 " %}

```
{
  "_embedded": {
    "alarms": [
      {
        "alarmCode": "string",
        "alarmMsg": "string",
        "alarmStatus": "CLOSED",
        "alarmStoredTimestamp": 0,
        "alarmType": "string",
        "alarmValue": true,
        "alarmZone": "string",
        "alarmZoneName": "string",
        "channelId": "string",
        "companyId": "string",
        "definition": "string",
        "deviceGroupId": "string",
        "deviceId": "string",
        "headers": [
          {
            "name": "string",
            "value": "string"
          }
        ],
        "id": "string",
        "messageId": "string",
        "partition": "string",
        "partitionName": "string",
        "payload": "string",
        "protocol": "CONTACT_ID",
        "severity": 0,
        "shortId": "string",
        "source": "string",
        "technical": true,
        "testMessage": true,
        "timestamp": 0
      }
    ]
  },
  "_links": {}
}
```

{% endtab %}
{% endtabs %}

## get a list of alarms for a particular site (device)

<mark style="color:blue;">`GET`</mark> `https://talos-app.io/api/alarm-service/alarms/search/findByDeviceId:deviceId`

Use this endpoint to receive a list of active alarms in evalink talos for a specific site (device) and company.

#### Query Parameters

| Name     | Type   | Description                                                            |
| -------- | ------ | ---------------------------------------------------------------------- |
| deviceId | string | The Device ID, as it is displayed in your evalink talos Web Interface. |

#### Headers

| Name          | Type   | Description                              |
| ------------- | ------ | ---------------------------------------- |
| Authorization | string | Use 'Bearer' followed by your API token. |

{% tabs %}
{% tab title="200 " %}

```

  "_embedded": {
    "alarms": [
      {
        "alarmCode": "string",
        "alarmMsg": "string",
        "alarmStatus": "CLOSED",
        "alarmStoredTimestamp": 0,
        "alarmType": "string",
        "alarmValue": true,
        "alarmZone": "string",
        "alarmZoneName": "string",
        "channelId": "string",
        "companyId": "string",
        "definition": "string",
        "deviceGroupId": "string",
        "deviceId": "string",
        "headers": [
          {
            "name": "string",
            "value": "string"
          }
        ],
        "id": "string",
        "messageId": "string",
        "partition": "string",
        "partitionName": "string",
        "payload": "string",
        "protocol": "CONTACT_ID",
        "severity": 0,
        "shortId": "string",
        "source": "string",
        "technical": true,
        "testMessage": true,
        "timestamp": 0
      }
    ]
  },
  "_links": {}
}
```

{% endtab %}
{% endtabs %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## 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, and the optional `goal` query parameter:

```
GET https://sitasys-ag.gitbook.io/evalink-talos/alarm-api/query-alarms.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.