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

Gets the number of unread messages.

This API operation is used to get the number of unread messages in the mailboxes selected in Settings > Notification > Mail > Mailbox settings.
The default value is the number of unread messages in All mailbox.

Authorization

oauth2

OAuth 2.0 authentication.
For more information, see Authentication and Authorization.

Scope

mail
mail.read

HTTP Request

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

Path Parameters

ParameterTypeDescription
userId string 

Member ID (must be URL-encoded)

  • User ID
  • Login ID (email)
  • Me

required
example : me 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Response

HTTP 200

OK

PropertyTypeDescription
count integer 

Number of unread messages


required
minimum : 0
format : int32 

Response Example

example

1{2  "count": 13763}