GET/users/{userId}/mail/unread-count

すべてのメールフォルダにある未読メールの数を取得する。

  • サービス画面の [環境設定 > 通知 > メール > メールフォルダ設定 > メールフォルダ別] を選択すると、通知設定を ON にしたメールフォルダの未読メール数を取得する。

Authorization

oauth2

Access Token を指定します。
指定の方法や Access Token の取得方法は 共通仕様 を参照してください。

Scope

mail
mail.read

HTTP Request

GEThttps://www.worksapis.com/v1.0/users/{userId}/mail/unread-count

Path Parameters

ParameterTypeDescription
userId string 

ユーザーを特定する ID (URL エンコードする)

  • ユーザー ID (userId)
  • ログイン ID (email)
  • 自身 ("me")

required
example : me 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Response

HTTP 200

OK

PropertyTypeDescription
count integer 

未読メール数


required
minimum : 0
format : int32 

Response Example

example

1{2  "count": 13763}