# Notification

알림 관련 API

## 알림 목록 조회

> UUID로 사용자의 알림 목록을 조회합니다

```json
{"openapi":"3.0.0","info":{"title":"Tikkly B2C API","version":"0.0.1"},"tags":[{"name":"Notification","description":"알림 관련 API"}],"servers":[{"url":"https://api-b2c.tikkly.io","description":"Development Server (Active)"},{"url":"https://api.tikkly.com","description":"Production Server"},{"url":"http://localhost:8081","description":"Local Development Server"}],"paths":{"/tikkly-b2c/notifications":{"post":{"tags":["Notification"],"summary":"알림 목록 조회","description":"UUID로 사용자의 알림 목록을 조회합니다","parameters":[{"in":"header","name":"x-api-key","required":true,"schema":{"type":"string","default":"TEST_API_KEY"},"description":"API Key"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["uuid"],"properties":{"uuid":{"type":"string","description":"사용자 UUID"},"onlyUnread":{"type":"boolean","default":false,"description":"읽지 않은 알림만 조회"},"page":{"type":"integer","minimum":1,"default":1,"description":"페이지 번호"},"pageSize":{"type":"integer","minimum":1,"maximum":100,"default":20,"description":"페이지당 항목 수"}}}}}},"responses":{"200":{"description":"알림 목록 조회 성공","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"data":{"type":"object","properties":{"notifications":{"type":"array","items":{"$ref":"#/components/schemas/Notification"}},"totalCount":{"type":"number"},"page":{"type":"number"},"pageSize":{"type":"number"}}}}}}}},"401":{"description":"인증 실패"},"404":{"description":"사용자를 찾을 수 없음"}}}}},"components":{"schemas":{"Notification":{"type":"object","properties":{"id":{"type":"number"},"kind":{"type":"string","enum":["TRADE_COMPLETED","DEPOSIT_CONFIRMED","WITHDRAWAL_COMPLETED","SYSTEM_NOTICE"]},"refType":{"type":"string"},"refId":{"type":"number"},"createdAt":{"type":"string","format":"date-time"},"readAt":{"type":"string","format":"date-time","nullable":true}}}}}}
```

## 읽지 않은 알림 개수

> UUID로 읽지 않은 알림의 개수를 조회합니다

```json
{"openapi":"3.0.0","info":{"title":"Tikkly B2C API","version":"0.0.1"},"tags":[{"name":"Notification","description":"알림 관련 API"}],"servers":[{"url":"https://api-b2c.tikkly.io","description":"Development Server (Active)"},{"url":"https://api.tikkly.com","description":"Production Server"},{"url":"http://localhost:8081","description":"Local Development Server"}],"paths":{"/tikkly-b2c/notifications/unread-count":{"post":{"tags":["Notification"],"summary":"읽지 않은 알림 개수","description":"UUID로 읽지 않은 알림의 개수를 조회합니다","parameters":[{"in":"header","name":"x-api-key","required":true,"schema":{"type":"string","default":"TEST_API_KEY"},"description":"API Key"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["uuid"],"properties":{"uuid":{"type":"string","description":"사용자 UUID","default":"40115395-195e-4c14-b5f4-261f13da353e"}}}}}},"responses":{"200":{"description":"조회 성공","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"data":{"type":"object","properties":{"unreadCount":{"type":"number"}}}}}}}},"401":{"description":"인증 실패"},"404":{"description":"사용자를 찾을 수 없음"}}}}}}
```

## 알림 읽음 처리

> UUID로 특정 알림을 읽음으로 표시합니다

```json
{"openapi":"3.0.0","info":{"title":"Tikkly B2C API","version":"0.0.1"},"tags":[{"name":"Notification","description":"알림 관련 API"}],"servers":[{"url":"https://api-b2c.tikkly.io","description":"Development Server (Active)"},{"url":"https://api.tikkly.com","description":"Production Server"},{"url":"http://localhost:8081","description":"Local Development Server"}],"paths":{"/tikkly-b2c/notifications/{id}/read":{"post":{"tags":["Notification"],"summary":"알림 읽음 처리","description":"UUID로 특정 알림을 읽음으로 표시합니다","parameters":[{"in":"header","name":"x-api-key","required":true,"schema":{"type":"string","default":"TEST_API_KEY"},"description":"API Key"},{"in":"path","name":"id","required":true,"schema":{"type":"integer"},"description":"알림 ID"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["uuid"],"properties":{"uuid":{"type":"string","description":"사용자 UUID","default":"40115395-195e-4c14-b5f4-261f13da353e"}}}}}},"responses":{"200":{"description":"읽음 처리 성공","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}}}}}},"401":{"description":"인증 실패"},"404":{"description":"알림을 찾을 수 없음"}}}}}}
```

## 모든 알림 읽음 처리

> UUID로 사용자의 모든 알림을 읽음으로 표시합니다

```json
{"openapi":"3.0.0","info":{"title":"Tikkly B2C API","version":"0.0.1"},"tags":[{"name":"Notification","description":"알림 관련 API"}],"servers":[{"url":"https://api-b2c.tikkly.io","description":"Development Server (Active)"},{"url":"https://api.tikkly.com","description":"Production Server"},{"url":"http://localhost:8081","description":"Local Development Server"}],"paths":{"/tikkly-b2c/notifications/read-all":{"post":{"tags":["Notification"],"summary":"모든 알림 읽음 처리","description":"UUID로 사용자의 모든 알림을 읽음으로 표시합니다","parameters":[{"in":"header","name":"x-api-key","required":true,"schema":{"type":"string","default":"TEST_API_KEY"},"description":"API Key"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["uuid"],"properties":{"uuid":{"type":"string","description":"사용자 UUID","default":"40115395-195e-4c14-b5f4-261f13da353e"}}}}}},"responses":{"200":{"description":"모두 읽음 처리 성공","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"data":{"type":"object","properties":{"updatedCount":{"type":"number"}}}}}}}},"401":{"description":"인증 실패"},"404":{"description":"사용자를 찾을 수 없음"}}}}}}
```


---

# 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://guide.tikkly.io/notification.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.