Contents

お知らせ数の取得

GET /api/v2/notifications/count

自分が受け取ったお知らせの数を取得します。
お知らせの既読状態には、お知らせ一覧で確認したか(alreadyRead)と、お知らせの対象を開いて確認したか(resourceAlreadyRead)の2種類があります。

実行可能な権限

すべての権限

クエリパラメーター

パラメーター名内容
alreadyReadbooleanお知らせ一覧で確認したかどうかの条件。お知らせ数のリセットを実行すると既読になります。
  • true: 既読のお知らせ
  • false: 未読のお知らせ
resourceAlreadyReadbooleanお知らせの対象を開いて確認したかどうかの条件。お知らせの既読化を実行すると確認済みになります。このパラメーターを指定した場合は、参加しているプロジェクトのお知らせのみが対象になります。
  • true: 対象を確認済みのお知らせ
  • false: 対象を未確認のお知らせ

リクエストの例

curl --request GET \
--url "https://{{YOUR-DOMAIN}}/api/v2/notifications/count?apiKey=$API_KEY" \
--data alreadyRead=false

{{YOUR-DOMAIN}}には、対象のスペースのドメインを記入してください。ドメインは、以下のいずれかです。スペースIDが不明の場合は、スペースIDとは?を参照してください。

  • https://[スペースID].backlog.com
  • https://[スペースID].backlog.jp
  • https://[スペースID].backlogtool.com

レスポンス例

ステータスライン / レスポンスヘッダ

HTTP/1.1 200 OK
Content-Type:application/json;charset=utf-8

レスポンスボディ

{
    "count": 138
}

エラーレスポンス

エラーレスポンスを参照してください。

制限事項

レート制限を参照してください

bラボ(Backlog Community Lab)のロゴ

bラボ(Backlog Community Lab)は、Backlogのユーザー向けオンラインコミュニティです。
Backlogの活用ノウハウ、他社事例をご用意。ほかのユーザーとBacklogの情報交換もできます。