# Unread Count

## <mark style="color:blue;">GET</mark> api/v1/message/unreadCount

* Note: to query the count of unread messages
* Header

| Field         | Type   | Remarks                                                                                |
| ------------- | ------ | -------------------------------------------------------------------------------------- |
| ApiKey        | String | [ApiKey](/relation-one-api/guide/glossary.md#apikey) acquired from the admin           |
| Authorization | String | Bearer ${unifiedAuthToken} , in which the unifiedAuthToken is returned by /api/v1/auth |

* Request Example

```shell
curl POST 'https://api.relationlabs.ai/api/v1/message/unreadCount' \
--header 'ApiKey: 581c6c4fa0b54912b00088aa563342a4' \
--header 'Authorization: bearer eyJhbGciOiJFUzI1NiJ9.eyJqdGkiOiI0MzdiN2EzZDEwMGY0ODVkOWVhMWUzZmZlOWE1NmEyZSIsImlzcyI6InJlbGF0aW9ubGFicy5haSIsImlhdCI6MTY2NTIxNTUzNSwic3ViIjoiZGhreXEtc3FhYWEtYWFhYWotc2d6M3EtY2FpIiwiZXhwIjoxNjY1ODIwMzM1fQ.rj7KKuIcgmvaIwZ63YHnXQ4jvvI-eR2Wo7k3YEyzMuxo8j5ezCowKDpcW0u9zIuHPFqwD0-1XPWdPLR1d1HLFw'
```

* Response Parameters

| Field | Type       | Remarks            |
| ----- | ---------- | ------------------ |
| code  | String     | the Return Code    |
| desc  | String     | the Return Message |
| data  | UnReadInfo | the Data           |

The UnReadInfo field consists of the following subfields:

| Field         | Type | Remarks                   |
| ------------- | ---- | ------------------------- |
| unreadCount   | int  | number of unread messages |
| mentionsCount | int  | number of mentions        |

* Response Body

```json
{
    "code": "0",
    "desc": "success",
    "data": {
        "unreadCount": 0,
        "mentionsCount": 0
    }
}
```

* Return Code

| code | desc    | Remarks                           |
| ---- | ------- | --------------------------------- |
| 0    | success | the flag for a successful request |


---

# 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://relationlabs.gitbook.io/relation-one-api/api/message/unread-count.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.